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	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など)。 https://westus2.api.cognitive.microsoft.com
api-version	query	True	string	要求された API バージョン。

要求ヘッダー

名前	必須	型	説明
Ocp-Apim-Subscription-Key	True	string	Azure Cognitive Services サブスクリプションのシークレット キー。

要求本文

名前	必須	型	説明
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 Cognitive Services サブスクリプションのシークレット キー。

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	エラー メッセージ。