Content Analyzers - Get Operation Status
获取分析器创建操作的状态。
GET {endpoint}/contentunderstanding/analyzers/{analyzerId}/operations/{operationId}?api-version=2025-05-01-preview
URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
analyzer
|
path | True |
string pattern: ^[a-zA-Z0-9._-]{1,64}$ |
分析器的唯一标识符。 |
|
endpoint
|
path | True |
string (uri) |
内容理解服务终结点。 |
|
operation
|
path | True |
string |
操作的唯一 ID。 |
|
api-version
|
query | True |
string minLength: 1 |
要用于此操作的 API 版本。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
请求已成功。 |
|
| Other Status Codes |
意外的错误响应。 标头 x-ms-error-code: string |
安全性
Ocp-Apim-Subscription-Key
类型:
apiKey
在:
header
OAuth2Auth
类型:
oauth2
流向:
accessCode
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
令牌 URL:
https://login.microsoftonline.com/common/oauth2/token
作用域
| 名称 | 说明 |
|---|---|
| https://cognitiveservices.azure.com/.default |
示例
Get Analyzer Operation Status
示例请求
GET {endpoint}/contentunderstanding/analyzers/myAnalyzer/operations/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2025-05-01-preview
示例响应
{
"id": "3b31320d-8bab-4f88-b19c-2322a7f11034",
"status": "Succeeded",
"result": {
"analyzerId": "myAnalyzer",
"description": "My analyzer",
"tags": {
"createdBy": "John"
},
"status": "ready",
"createdAt": "2025-05-01T18:46:36.051Z",
"lastModifiedAt": "2025-05-01T18:46:36.051Z",
"baseAnalyzerId": "prebuilt-documentAnalyzer",
"config": {
"locales": null,
"enableFace": false,
"enableOcr": true,
"enableLayout": true,
"enableFormula": false,
"returnDetails": true
},
"fieldSchema": {
"name": "MyForm",
"description": "My form",
"fields": {
"Company": {
"type": "string",
"description": "Name of company."
}
},
"definitions": {}
},
"trainingData": {
"kind": "blob",
"containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
"prefix": "trainingData",
"fileListPath": "trainingData/fileList.jsonl"
}
}
}
定义
| 名称 | 说明 |
|---|---|
|
Azure. |
错误对象。 |
|
Azure. |
包含错误详细信息的响应。 |
|
Azure. |
包含有关错误的更具体信息的对象。 根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。 |
Azure.Core.Foundations.Error
错误对象。
| 名称 | 类型 | 说明 |
|---|---|---|
| code |
string |
服务器定义的错误代码集之一。 |
| details |
导致此报告错误的特定错误的详细信息数组。 |
|
| innererror |
包含与当前对象有关错误的更具体信息的对象。 |
|
| message |
string |
有关错误的可读的表示形式。 |
| target |
string |
错误的目标。 |
Azure.Core.Foundations.ErrorResponse
包含错误详细信息的响应。
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
错误对象。 |
Azure.Core.Foundations.InnerError
包含有关错误的更具体信息的对象。 根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。
| 名称 | 类型 | 说明 |
|---|---|---|
| code |
string |
服务器定义的错误代码集之一。 |
| innererror |
内部错误。 |