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

Read - Read

使用此接口可以获取读取操作的结果,并采用最先进的光学字符识别 (OCR) 算法,这些算法针对文本密集型文档进行优化。 使用读取接口时,响应包含一个名为“Operation-Location”的字段。 “Operation-Location”字段包含必须用于“GetReadResult”操作才能访问 OCR 结果的 URL。

POST {Endpoint}/vision/v3.2-preview/read/analyze
POST {Endpoint}/vision/v3.2-preview/read/analyze?language={language}&Pages={Pages}

URI 参数

Name In Required Type Description
Endpoint
path True
  • string

支持的认知服务终结点。

language
query

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

Pages
query
  • array

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

请求头

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

请求正文

Name Required Type Description
url True
  • string

图像的可公开访问 URL。

响应

Name Type Description
202 Accepted

该服务已接受请求,稍后将开始处理。

Headers

  • Operation-Location: string
Other Status Codes

错误响应。

安全性

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

示例

Successful Analyze request

Sample Request

POST {Endpoint}/vision/v3.2-preview/read/analyze?language=en&Pages=2,3


{
  "url": "{url}"
}

Sample Response

定义

ComputerVisionError

有关 API 请求错误的详细信息。

ComputerVisionErrorCodes

错误代码。

ImageUrl
OcrDetectionLanguage

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

ComputerVisionError

有关 API 请求错误的详细信息。

Name Type Description
code

错误代码。

message
  • string

说明服务报告的错误的消息。

requestId
  • string

唯一请求标识符。

ComputerVisionErrorCodes

错误代码。

Name Type Description
BadArgument
  • string
CancelledRequest
  • string
DetectFaceError
  • string
FailedToProcess
  • string
InternalServerError
  • string
InvalidDetails
  • string
InvalidImageFormat
  • string
InvalidImageSize
  • string
InvalidImageUrl
  • string
InvalidModel
  • string
InvalidPageRange
  • string
InvalidThumbnailSize
  • string
NotSupportedFeature
  • string
NotSupportedImage
  • string
NotSupportedLanguage
  • string
NotSupportedVisualFeature
  • string
StorageException
  • string
Timeout
  • string
Unspecified
  • string
UnsupportedMediaType
  • string

ImageUrl

Name Type Description
url
  • string

图像的可公开访问 URL。

OcrDetectionLanguage

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

Name Type Description
de
  • string
en
  • string
es
  • string
fr
  • string
it
  • string
nl
  • string
pt
  • string