Document Models - Compose Model

リファレンス

サービス:: Azure AI Services

API バージョン:: 2024-11-30

既存のドキュメントモデルのドキュメントの種類から新しいドキュメントモデルを作成します。

POST {endpoint}/documentintelligence/documentModels:compose?api-version=2024-11-30

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)	ドキュメントインテリジェンスサービスエンドポイント。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
classifierId	True	string	入力ファイルを分割して分類するカスタム分類子。
docTypes	True	<string, DocumentTypeDetails>	サポートされている docTypes を対応するドキュメントモデルにディクショナリマッピングします。
modelId	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	一意のドキュメントモデル名。
description		string maxLength: 4096	ドキュメントモデルの説明。
split		SplitMode	ファイル分割の動作。
tags		object	ドキュメントモデルに関連付けられているキーと値のタグ属性の一覧。

応答

名前	型	説明
202 Accepted		要求は処理のために受け入れ済みですが、処理はまだ完了していません。ヘッダー Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	予期しないエラー応答。

名前

型

説明

202 Accepted

要求は処理のために受け入れ済みですが、処理はまだ完了していません。

ヘッダー

Operation-Location: string
Retry-After: integer

Other Status Codes

DocumentIntelligenceErrorResponse

予期しないエラー応答。

セキュリティ

Ocp-Apim-Subscription-Key

型: apiKey
/: header

OAuth2Auth

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize
Token URL (トークン URL): https://login.microsoftonline.com/common/oauth2/token

スコープ

名前	説明
https://cognitiveservices.azure.com/.default

例

Compose Document Model

要求のサンプル

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:compose?api-version=2024-11-30

{
  "modelId": "composedModel",
  "description": "Composed model description",
  "classifierId": "customClassifier",
  "docTypes": {
    "formA": {
      "modelId": "model1"
    },
    "formB": {
      "modelId": "model2"
    }
  }
}

応答のサンプル

状態コード:: 202

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

定義

名前	説明
ComposeDocumentModelRequest	コンポーネントドキュメントモデルから構成済みドキュメントモデルを作成するための要求本文。
DocumentAnalysisFeature	有効にするドキュメント分析機能。
DocumentBuildMode	カスタムドキュメントモデルのビルドモード。
DocumentFieldSchema	JSON スキーマスタイル構文を使用したフィールドセマンティックスキーマの説明。
DocumentFieldType	フィールド値のセマンティックデータ型。
DocumentIntelligenceError	エラーオブジェクト。
DocumentIntelligenceErrorResponse	エラー応答オブジェクト。
DocumentIntelligenceInnerError	エラーに関するより具体的な情報を含むオブジェクト。
DocumentTypeDetails	ドキュメントの種類の情報。
SplitMode	ファイル分割の動作。

ComposeDocumentModelRequest

Object

コンポーネントドキュメントモデルから構成済みドキュメントモデルを作成するための要求本文。

名前	型	規定値	説明
classifierId	string		入力ファイルを分割して分類するカスタム分類子。
description	string maxLength: 4096		ドキュメントモデルの説明。
docTypes	<string, DocumentTypeDetails>		サポートされている docTypes を対応するドキュメントモデルにディクショナリマッピングします。
modelId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		一意のドキュメントモデル名。
split	SplitMode	none	ファイル分割の動作。
tags	object		ドキュメントモデルに関連付けられているキーと値のタグ属性の一覧。

DocumentAnalysisFeature

列挙

有効にするドキュメント分析機能。

値	説明
barcodes	ドキュメント内のバーコードの検出を有効にします。
formulas	ドキュメント内の数式の検出を有効にします。
keyValuePairs	ドキュメント内の一般的なキー値ペア (フォームフィールド) の検出を有効にします。
languages	テキストコンテンツ言語の検出を有効にします。
ocrHighResolution	より高い解像度で OCR を実行して、細かい印刷でドキュメントを処理します。
queryFields	queryFields クエリパラメーターを使用して、追加のフィールドの抽出を有効にします。
styleFont	さまざまなフォントスタイルの認識を有効にします。

DocumentBuildMode

列挙

カスタムドキュメントモデルのビルドモード。

値	説明
neural	多様なビジュアルテンプレートを使用してドキュメントをサポートします。
template	類似のビジュアルテンプレートを使用してドキュメントをターゲットに設定します。

DocumentFieldSchema

Object

JSON スキーマスタイル構文を使用したフィールドセマンティックスキーマの説明。

名前	型	説明
description	string maxLength: 4096	フィールドの説明。
example	string	フィールドの内容の例。
items	DocumentFieldSchema	各配列要素のフィールド型スキーマ。
properties	<string, DocumentFieldSchema>	オブジェクトフィールドの名前付きサブフィールド。
type	DocumentFieldType	フィールド値のセマンティックデータ型。

DocumentFieldType

列挙

フィールド値のセマンティックデータ型。

値	説明
address	解析されたアドレス。
array	同じ型のサブフィールドの一覧。
boolean	true または false に正規化されたブール値。
countryRegion	ISO 3166-1 alpha-3 形式 (米国など) に正規化された国/地域。
currency	オプションの通貨記号と単位を含む通貨金額。
date	ISO 8601 (YYYY-MM-DD) 形式に正規化された日付。
integer	64 ビット符号付き整数に正規化された整数。
number	倍精度浮動小数点に正規化された浮動小数点数。
object	潜在的に異なる型のサブフィールドの名前付きリスト。
phoneNumber	E.164 (+{CountryCode}{SubscriberNumber}) 形式に正規化された電話番号。
selectionGroup	選択した文字列値の配列。
selectionMark	フィールドは選択されていますか?
signature	署名は存在しますか?
string	プレーンテキスト。
time	ISO 8601 (hh:mm:ss) 形式に正規化された時間。

DocumentIntelligenceError

Object

エラーオブジェクト。

名前	型	説明
code	string	サーバー定義の一連のエラーコードの 1 つ。
details	DocumentIntelligenceError[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	DocumentIntelligenceInnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	エラーのターゲット。

DocumentIntelligenceErrorResponse

Object

エラー応答オブジェクト。

名前	型	説明
error	DocumentIntelligenceError	エラー情報。

DocumentIntelligenceInnerError

Object

エラーに関するより具体的な情報を含むオブジェクト。

名前	型	説明
code	string	サーバー定義の一連のエラーコードの 1 つ。
innererror	DocumentIntelligenceInnerError	内部エラー。
message	string	エラーの人間が判読できる表現。

DocumentTypeDetails

Object

ドキュメントの種類の情報。

名前	型	説明
buildMode	DocumentBuildMode	カスタムドキュメントモデルのビルドモード。
confidenceThreshold	number (float)	docType の信頼度がしきい値を超えている場合にのみ、分析を実行します。
description	string maxLength: 4096	ドキュメントモデルの説明。
features	DocumentAnalysisFeature[]	オプションの分析機能の一覧。
fieldConfidence	object	各フィールドの推定信頼度。
fieldSchema	<string, DocumentFieldSchema>	JSON スキーマスタイル構文を使用したドキュメントセマンティックスキーマの説明。
maxDocumentsToAnalyze	integer (int32)	分析する指定した種類のドキュメントの最大数。 Default=all。
modelId	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	指定した型のドキュメントの分析に使用するドキュメントモデル。
queryFields	string[]	抽出する追加フィールドの一覧。旧。 "NumberOfGuests,StoreNumber"

SplitMode

列挙

ファイル分割の動作。

値	説明
auto	ファイルをドキュメントに自動的に分割します。
none	ファイル全体を 1 つのドキュメントとして扱います。
perPage	ファイル内の各ページを個別のドキュメントとして扱います。

次の方法で共有

Document Models - Compose Model

URI パラメーター

要求本文

応答

セキュリティ

Ocp-Apim-Subscription-Key

OAuth2Auth

スコープ

例

Compose Document Model

要求のサンプル

応答のサンプル

定義

ComposeDocumentModelRequest

DocumentAnalysisFeature

DocumentBuildMode

DocumentFieldSchema

DocumentFieldType

DocumentIntelligenceError

DocumentIntelligenceErrorResponse

DocumentIntelligenceInnerError

DocumentTypeDetails

SplitMode

その他のリソース