Document Models - Compose Model

服务:

Azure AI Services

API 版本:

2022-08-31

从现有文档模型的文档类型创建新的文档模型。

POST {endpoint}/formrecognizer/documentModels:compose?api-version=2022-08-31

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string	支持的认知服务终结点（协议和主机名，例如：https://westus2.api.cognitive.microsoft.com）。
api-version	query	True	ApiVersion	请求的 API 版本。

请求头

名称	必需	类型	说明
Ocp-Apim-Subscription-Key	True	string

请求正文

名称	必需	类型	说明
componentModels	True	ComponentDocumentModelDetails[]	要撰写的组件文档模型列表。
modelId	True	string pattern: [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}	唯一的文档模型名称。
description		string maxLength: 4096	文档模型说明。
tags		object	与文档模型关联的键值标记属性的列表。

响应

名称	类型	说明
202 Accepted		请求已成功排队。 标头 Operation-Location: string
Other Status Codes	ErrorResponse	遇到错误。

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

示例

ComposeDocumentModel

示例请求

HTTP

POST {endpoint}/formrecognizer/documentModels:compose?api-version=2022-08-31

{
  "modelId": "{composedModelId}",
  "description": "{composedModelDescription}",
  "componentModels": [
    {
      "modelId": "{modelId1}"
    },
    {
      "modelId": "{modelId2}"
    }
  ]
}

示例响应

状态代码:

202

Operation-Location: {endpoint}/formrecognizer/operations/{operationId}?api-version=2022-08-31

定义

名称	说明
ApiVersion	API 版本。
ComponentDocumentModelDetails	组合文档模型的组件。
ComposeDocumentModelRequest	请求正文以从组件文档模型创建组合文档模型。
Error	错误信息。
ErrorResponse	错误响应对象。
InnerError	详细错误。

ApiVersion

枚举

API 版本。

值	说明
2022-08-31

ComponentDocumentModelDetails

Object

组合文档模型的组件。

名称	类型	说明
modelId	string pattern: [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}	唯一的文档模型名称。

ComposeDocumentModelRequest

Object

请求正文以从组件文档模型创建组合文档模型。

名称	类型	说明
componentModels	ComponentDocumentModelDetails[]	要撰写的组件文档模型列表。
description	string maxLength: 4096	文档模型说明。
modelId	string pattern: [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}	唯一的文档模型名称。
tags	object	与文档模型关联的键值标记属性的列表。

Error

Object

错误信息。

名称	类型	说明
code	string	错误代码。
details	Error[]	详细错误列表。
innererror	InnerError	详细错误。
message	string	错误信息。
target	string	错误的目标。

ErrorResponse

Object

错误响应对象。

名称	类型	说明
error	Error	错误信息。

InnerError

Object

详细错误。

名称	类型	说明
code	string	错误代码。
innererror	InnerError	详细错误。
message	string	错误信息。