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

Document Models - Compose Model

Service:

Azure AI Services

API Version:

2023-07-31

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

POST {endpoint}/formrecognizer/documentModels:compose?api-version=2023-07-31

URI 参数

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

请求头

名称	必需	类型	说明
Ocp-Apim-Subscription-Key	True	string	Azure 认知服务订阅的密钥。

请求正文

名称	必需	类型	说明
componentModels	True	ComponentDocumentModelDetails[]	要撰写的组件文档模型列表。
modelId	True	string	唯一的文档模型名称。
description		string	文档模型说明。
tags		object	与文档模型关联的键值标记属性的列表。

响应

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

安全性

Ocp-Apim-Subscription-Key

Azure 认知服务订阅的密钥。

Type: apiKey
In: header

示例

Compose Document Model

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels:compose?api-version=2023-07-31

{
  "modelId": "composedModel",
  "description": "Composed model description",
  "componentModels": [
    {
      "modelId": "model1"
    },
    {
      "modelId": "model2"
    }
  ]
}

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31

定义

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

ComponentDocumentModelDetails

组合文档模型的组件。

名称	类型	说明
modelId	string	唯一的文档模型名称。

ComposeDocumentModelRequest

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

名称	类型	说明
componentModels	ComponentDocumentModelDetails[]	要撰写的组件文档模型列表。
description	string	文档模型说明。
modelId	string	唯一的文档模型名称。
tags	object	与文档模型关联的键值标记属性的列表。

Error

错误信息。

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

ErrorResponse

错误响应对象。

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

InnerError

详细错误。

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