Image Moderation - OCR File Input
返回图像中为指定语言找到的任何文本。 如果未在输入中指定任何语言，则检测默认为英语。
POST {Endpoint}/contentmoderator/moderate/v1.0/ProcessImage/OCR?overload=stream&language={language}POST {Endpoint}/contentmoderator/moderate/v1.0/ProcessImage/OCR?overload=stream&language={language}&CacheImage={CacheImage}&enhanced={enhanced}URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Endpoint
|
path | True |
string |
支持的 Azure 认知服务终结点（协议和主机名，如 https://westus.api.cognitive.microsoft.com）。 |
|
language
|
query | True |
string |
术语的语言。 |
|
Cache
|
query |
boolean |
是否保留提交的映像以供将来使用。 如果省略，则默认值为 false。 |
|
|
enhanced
|
query |
boolean |
如果设置为 true，则图像将经历其他处理，以附带其他候选项。 当增强设置为 true 时，不支持映像或 TIFF 文件。 注意：这会影响响应时间。 |
请求头
Media Types: "image/gif", "image/jpeg", "image/png", "image/bmp", "image/tiff"
| 名称 | 必需 | 类型 | 说明 |
|---|---|---|---|
| Ocp-Apim-Subscription-Key | True |
string |
请求正文
Media Types: "image/gif", "image/jpeg", "image/png", "image/bmp", "image/tiff"
| 名称 | 类型 | 说明 |
|---|---|---|
| ImageStream |
object (file) |
图像文件。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
找到候选文本的文本和列表。 |
|
| Other Status Codes |
错误响应。 |
安全性
Ocp-Apim-Subscription-Key
类型:
apiKey
在:
header
定义
| 名称 | 说明 |
|---|---|
| APIError |
API 返回的错误信息。 |
| Candidate |
光学字符识别（OCR）候选文本。 |
| Error |
错误正文。 |
|
Key |
键/值对对象属性。 |
| OCR |
包含指定语言的图像中找到的文本。 |
| Status |
状态属性。 |
APIError
API 返回的错误信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| Error |
错误正文。 |
Candidate
光学字符识别（OCR）候选文本。
| 名称 | 类型 | 说明 |
|---|---|---|
| Confidence |
number |
置信水平。 |
| Text |
string |
找到的文本。 |
Error
错误正文。
| 名称 | 类型 | 说明 |
|---|---|---|
| Code |
string |
|
| Message |
string |
KeyValuePair
键/值对对象属性。
| 名称 | 类型 | 说明 |
|---|---|---|
| Key |
string |
键参数。 |
| Value |
string |
值参数。 |
OCR
包含指定语言的图像中找到的文本。
| 名称 | 类型 | 说明 |
|---|---|---|
| CacheId |
string |
缓存 ID。 |
| Candidates |
候选文本列表。 |
|
| Language |
string |
ISO 639-3 代码。 |
| Metadata |
键/值对的数组。 |
|
| Status |
评估状态。 |
|
| Text |
string |
找到文本。 |
| TrackingId |
string |
跟踪 ID。 |
Status
状态属性。
| 名称 | 类型 | 说明 |
|---|---|---|
| Code |
integer |
状态代码。 |
| Description |
string |
状态说明。 |
| Exception |
string |
异常状态。 |