你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Analyze Layout Async - Analyze Layout Async

分析布局
从给定文档中提取文本和布局信息。 输入文档必须是受支持的内容类型之一-“application/pdf”、“image/jpeg”、“image/png”、“image/tiff”或“image/bmp”。 或者,使用“application/json”类型指定要分析的文档 (URI 或本地路径) 的位置。

POST {endpoint}/formrecognizer/v2.1-preview.2/layout/analyze
POST {endpoint}/formrecognizer/v2.1-preview.2/layout/analyze?language={language}&Pages={Pages}

URI 参数

Name In Required Type Description
endpoint
path True
  • string

支持的认知服务终结点 (协议和主机名,例如: https://westus2.api.cognitive.microsoft.com) 。

language
query

文档中文本的 BCP-47 语言代码。 目前,只有英语 ('en') 、荷兰 ('nl') , 法语 ('fr') ,德语 ('de') ,意大利语 ('it') ,葡萄牙语 ('pt') ,简体中文 ('zh-Hans') 和西班牙语 ('es') 受支持 (打印 - 9种语言和手写 - 英语) 。 布局支持自动语言标识和多语言文档,因此,如果要强制将记录的文档作为该特定语言进行处理,则仅提供语言代码。

Pages
query
  • array

多页文档的自定义页码 (PDF/TIFF) ,输入要获取 OCR 结果的页面数。 对于页范围,请使用连字符。 用逗号或空格分隔每个页面或区域。

请求头

Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"

Name Required Type Description
Ocp-Apim-Subscription-Key True
  • string

请求正文

Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"

Name Type Description
source
  • string

文件源路径。

响应

Name Type Description
202 Accepted

请求已成功排队。

Headers

  • Operation-Location: string
Other Status Codes

包含有关错误的其他详细信息的非成功响应的响应实体。

安全性

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

示例

Analyze layout

Sample Request

POST {endpoint}/formrecognizer/v2.1-preview.2/layout/analyze?language=en

Sample Response

Operation-Location: {endpoint}/formrecognizer/v2.1-preview.2/layout/analyzeResults/{resultId}

定义

ErrorInformation
ErrorResponse
Language

语言代码

SourcePath

源数据的 URI 或本地路径。

ErrorInformation

Name Type Description
code
  • string
message
  • string

ErrorResponse

Name Type Description
error

Language

语言代码

Name Type Description
de
  • string
en
  • string
es
  • string
fr
  • string
it
  • string
ja
  • string
nl
  • string
pt
  • string
zh-Hans
  • string

SourcePath

源数据的 URI 或本地路径。

Name Type Description
source
  • string

文件源路径。