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

Document Models - Compose Model

Service:

Azure AI Services

API Version:

2024-02-29-preview

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

POST {endpoint}/documentintelligence/documentModels:compose?api-version=2024-02-29-preview

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string	文档智能服务终结点。
api-version	query	True	string	要用于此操作的 API 版本。

请求正文

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

响应

名称	类型	说明
202 Accepted		已接受请求进行处理，但尚未完成处理。 Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	意外的错误响应。

安全性

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

名称	说明
https://cognitiveservices.azure.com/.default

示例

Compose Document Model

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:compose?api-version=2024-02-29-preview

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

Sample Response

Status code:

202

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

定义

名称	说明
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	错误的用户可读表示形式。