Document Models - Compose Model
既存のドキュメント モデルのドキュメントの種類から新しいドキュメント モデルを作成します。
POST {endpoint}/documentintelligence/documentModels:compose?api-version=2024-02-29-preview
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
endpoint
|
path | True |
string |
ドキュメント インテリジェンス サービス エンドポイント。 |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
要求本文
名前 | 必須 | 型 | 説明 |
---|---|---|---|
componentModels | True |
作成するコンポーネント ドキュメント モデルの一覧。 |
|
modelId | True |
string |
一意のドキュメント モデル名。 |
description |
string |
ドキュメント モデルの説明。 |
|
tags |
object |
ドキュメント モデルに関連付けられているキーと値のタグ属性の一覧。 |
応答
名前 | 型 | 説明 |
---|---|---|
202 Accepted |
要求は処理のために受け入れられますが、処理はまだ完了していません。 Headers
|
|
Other Status Codes |
予期しないエラー応答。 |
セキュリティ
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
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
Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-02-29-preview
定義
名前 | 説明 |
---|---|
Component |
構成済みドキュメント モデルのコンポーネント。 |
Compose |
コンポーネント ドキュメント モデルから構成済みドキュメント モデルを作成するための要求本文。 |
Error |
error オブジェクト。 |
Error |
エラー応答オブジェクト。 |
Inner |
エラーに関するより具体的な情報を含むオブジェクト。 |
ComponentDocumentModelDetails
構成済みドキュメント モデルのコンポーネント。
名前 | 型 | 説明 |
---|---|---|
modelId |
string |
一意のドキュメント モデル名。 |
ComposeDocumentModelRequest
コンポーネント ドキュメント モデルから構成済みドキュメント モデルを作成するための要求本文。
名前 | 型 | 説明 |
---|---|---|
componentModels |
作成するコンポーネント ドキュメント モデルの一覧。 |
|
description |
string |
ドキュメント モデルの説明。 |
modelId |
string |
一意のドキュメント モデル名。 |
tags |
object |
ドキュメント モデルに関連付けられているキーと値のタグ属性の一覧。 |
Error
error オブジェクト。
名前 | 型 | 説明 |
---|---|---|
code |
string |
サーバー定義のエラー コードのセットの 1 つ。 |
details |
Error[] |
この報告されたエラーの原因となった特定のエラーに関する詳細の配列。 |
innererror |
エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。 |
|
message |
string |
エラーの人間が判読できる表現。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答オブジェクト。
名前 | 型 | 説明 |
---|---|---|
error |
エラー情報。 |
InnerError
エラーに関するより具体的な情報を含むオブジェクト。
名前 | 型 | 説明 |
---|---|---|
code |
string |
サーバー定義のエラー コードのセットの 1 つ。 |
innererror |
内部エラー。 |
|
message |
string |
エラーの人間が判読できる表現。 |