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

Miscellaneous Operations - Get Document Model Compose Operation

获取操作信息。

GET {endpoint}/documentintelligence/operations/{operationId}?_overload=getDocumentModelComposeOperation&api-version=2024-02-29-preview

URI 参数

名称 必需 类型 说明
endpoint
path True

string

文档智能服务终结点。

operationId
path True

string

Operation ID

api-version
query True

string

要用于此操作的 API 版本。

请求头

名称 必需 类型 说明
x-ms-client-request-id

string

uuid

请求的不透明、全局唯一的客户端生成的字符串标识符。

响应

名称 类型 说明
200 OK

DocumentModelComposeOperationDetails

请求已成功。

标头

x-ms-client-request-id: string

Other Status Codes

ErrorResponse

意外的错误响应。

安全性

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 Operation - Document Model Compose

示例请求

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?_overload=getDocumentModelComposeOperation&api-version=2024-02-29-preview

示例响应

{
  "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4",
  "status": "succeeded",
  "percentCompleted": 100,
  "createdDateTime": "2021-09-23T09:12:57Z",
  "lastUpdatedDateTime": "2021-09-23T09:13:01Z",
  "kind": "documentModelCompose",
  "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel",
  "result": {
    "modelId": "myCustomModel",
    "description": "Custom model description",
    "createdDateTime": "2021-09-23T09:13:01Z",
    "apiVersion": "2024-02-29-preview"
  }
}

定义

名称 说明
AzureBlobContentSource

Azure Blob 存储内容。

AzureBlobFileListContentSource

Azure Blob 存储 中的文件列表。

DocumentBuildMode

自定义文档模型生成模式。

DocumentFieldSchema

使用 JSON 架构样式语法的字段语义架构的说明。

DocumentFieldType

字段值的语义数据类型。

DocumentModelComposeOperationDetails

获取操作响应对象。

DocumentModelDetails

文档模型信息。

DocumentTypeDetails

文档类型信息。

Error

错误对象。

ErrorResponse

错误响应对象。

InnerError

包含有关错误的更具体信息的对象。

OperationKind

操作类型。

OperationStatus

操作状态。

Warning

错误对象。

AzureBlobContentSource

Azure Blob 存储内容。

名称 类型 说明
containerUrl

string

Azure Blob 存储容器 URL。

prefix

string

Blob 名称前缀。

AzureBlobFileListContentSource

Azure Blob 存储 中的文件列表。

名称 类型 说明
containerUrl

string

Azure Blob 存储容器 URL。

fileList

string

容器中指定文档子集的 JSONL 文件的路径。

DocumentBuildMode

自定义文档模型生成模式。

名称 类型 说明
neural

string

支持具有各种视觉模板的文档。

template

string

使用类似视觉模板的目标文档。

DocumentFieldSchema

使用 JSON 架构样式语法的字段语义架构的说明。

名称 类型 说明
description

string

字段说明。

example

string

示例字段内容。

items

DocumentFieldSchema

每个数组元素的字段类型架构。

properties

<string,  DocumentFieldSchema>

对象字段的命名子字段。

type

DocumentFieldType

字段值的语义数据类型。

DocumentFieldType

字段值的语义数据类型。

名称 类型 说明
address

string

已分析地址。

array

string

相同类型的子字段列表。

boolean

string

布尔值,规范化为 true 或 false。

countryRegion

string

国家/地区,规范化为 ISO 3166-1 alpha-3 格式 (例如 USA) 。

currency

string

具有可选货币符号和单位的货币金额。

date

string

日期,规范化为 ISO 8601 (YYYY-MM-DD) 格式。

integer

string

整数,规范化为 64 位带符号整数。

number

string

浮点数,规范化为双精度浮点。

object

string

可能不同类型的子字段的命名列表。

phoneNumber

string

电话号码,规范化为 E.164 (+{CountryCode}{SubscriberNumber}) 格式。

selectionGroup

string

所选字符串值的数组。

selectionMark

string

是否选择了字段?

signature

string

签名是否存在?

string

string

纯文本。

time

string

时间,规范化为 ISO 8601 (hh:mm:ss) 格式。

DocumentModelComposeOperationDetails

获取操作响应对象。

名称 类型 说明
apiVersion

string

用于创建此操作的 API 版本。

createdDateTime

string

创建操作时 (UTC) 日期和时间。

error

Error

遇到错误。

kind string:

documentModelCompose

操作类型。

lastUpdatedDateTime

string

上次更新状态时 (UTC) 日期和时间。

operationId

string

Operation ID

percentCompleted

integer

操作进度 (0-100) 。

resourceLocation

string

此操作所面向的资源的 URL。

result

DocumentModelDetails

成功后的操作结果。

status

OperationStatus

操作状态。 notStarted、running、completed 或 failed

tags

object

与文档模型关联的键值标记属性的列表。

DocumentModelDetails

文档模型信息。

名称 类型 说明
apiVersion

string

用于创建此文档模型的 API 版本。

azureBlobFileListSource

AzureBlobFileListContentSource

Azure Blob 存储指定训练数据的文件列表。 必须指定 azureBlobSource 或 azureBlobFileListSource。

azureBlobSource

AzureBlobContentSource

Azure Blob 存储包含训练数据的位置。 必须指定 azureBlobSource 或 azureBlobFileListSource。

buildMode

DocumentBuildMode

自定义文档模型生成模式。

createdDateTime

string

创建文档模型时 (UTC) 日期和时间。

description

string

文档模型说明。

docTypes

<string,  DocumentTypeDetails>

支持的文档类型。

expirationDateTime

string

文档模型将过期 (UTC) 日期和时间。

modelId

string

唯一的文档模型名称。

tags

object

与文档模型关联的键值标记属性的列表。

warnings

Warning[]

生成模型时遇到的警告列表。

DocumentTypeDetails

文档类型信息。

名称 类型 说明
buildMode

DocumentBuildMode

自定义文档模型生成模式。

description

string

文档模型说明。

fieldConfidence

object

每个字段的估计置信度。

fieldSchema

<string,  DocumentFieldSchema>

使用 JSON 架构样式语法的文档语义架构的说明。

Error

错误对象。

名称 类型 说明
code

string

服务器定义的一组错误代码中的一个。

details

Error[]

有关导致此项报告错误的特定错误的详细信息数组。

innererror

InnerError

一个 对象,该对象包含比当前对象更具体的错误信息。

message

string

错误的用户可读表示形式。

target

string

错误的目标。

ErrorResponse

错误响应对象。

名称 类型 说明
error

Error

错误信息。

InnerError

包含有关错误的更具体信息的对象。

名称 类型 说明
code

string

服务器定义的一组错误代码中的一个。

innererror

InnerError

内部错误。

message

string

错误的用户可读表示形式。

OperationKind

操作类型。

名称 类型 说明
documentClassifierBuild

string

生成新的自定义分类器模型。

documentModelBuild

string

生成新的自定义文档模型。

documentModelCompose

string

从现有模型撰写新的自定义文档模型。

documentModelCopyTo

string

将现有文档模型复制到可能不同的资源、区域或订阅。

OperationStatus

操作状态。

名称 类型 说明
canceled

string

操作已取消。

completed

string

操作已完成。

failed

string

操作失败。

notStarted

string

操作尚未启动。

running

string

操作正在进行中。

succeeded

string

操作已成功执行。

Warning

错误对象。

名称 类型 说明
code

string

服务器定义的警告代码集之一。

message

string

警告的可读表示形式。

target

string

错误的目标。