Document Models - Build Model

サービス:

Azure AI Services

API バージョン:

2024-07-31-preview

カスタム ドキュメント分析モデルを構築します。

POST {endpoint}/documentintelligence/documentModels:build?api-version=2024-07-31-preview

URI パラメーター

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

要求本文

名前	必須	型	説明
buildMode	True	DocumentBuildMode	カスタム ドキュメント モデルのビルド モード。
modelId	True	string	一意のドキュメント モデル名。
allowOverwrite		boolean	同じ名前で既存のモデルを上書きできるようにします。
azureBlobFileListSource		AzureBlobFileListContentSource	トレーニング データを指定する Azure Blob Storage ファイルの一覧。 azureBlobSource または azureBlobFileListSource を指定する必要があります。
azureBlobSource		AzureBlobContentSource	トレーニング データを含む Azure Blob Storage の場所。 azureBlobSource または azureBlobFileListSource を指定する必要があります。
description		string	ドキュメント モデルの説明。
maxTrainingHours		number	モデル トレーニングに使用する V100 相当の GPU 時間の最大数。 Default=0.5。
tags		object	ドキュメント モデルに関連付けられているキーと値のタグ属性の一覧。

応答

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

セキュリティ

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

例

Build Document Model

要求のサンプル

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:build?api-version=2024-07-31-preview

{
  "modelId": "myCustomModel",
  "description": "Custom model description",
  "buildMode": "template",
  "azureBlobSource": {
    "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
    "prefix": "trainingDocs/"
  },
  "tags": {
    "createdBy": "myUserId"
  }
}

応答のサンプル

状態コード:

202

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

定義

名前	説明
AzureBlobContentSource	Azure Blob Storage のコンテンツ。
AzureBlobFileListContentSource	Azure Blob Storage のファイルの一覧。
BuildDocumentModelRequest	新しいカスタム ドキュメント モデルを構築するための要求本文。
DocumentBuildMode	カスタム ドキュメント モデルのビルド モード。
Error	エラー オブジェクト。
ErrorResponse	エラー応答オブジェクト。
InnerError	エラーに関するより具体的な情報を含むオブジェクト。

AzureBlobContentSource

Azure Blob Storage のコンテンツ。

名前	型	説明
containerUrl	string	Azure Blob Storage コンテナーの URL。
prefix	string	BLOB 名プレフィックス。

AzureBlobFileListContentSource

Azure Blob Storage のファイルの一覧。

名前	型	説明
containerUrl	string	Azure Blob Storage コンテナーの URL。
fileList	string	ドキュメントのサブセットを指定するコンテナー内の JSONL ファイルへのパス。

BuildDocumentModelRequest

新しいカスタム ドキュメント モデルを構築するための要求本文。

名前	型	規定値	説明
allowOverwrite	boolean	False	同じ名前で既存のモデルを上書きできるようにします。
azureBlobFileListSource	AzureBlobFileListContentSource		トレーニング データを指定する Azure Blob Storage ファイルの一覧。 azureBlobSource または azureBlobFileListSource を指定する必要があります。
azureBlobSource	AzureBlobContentSource		トレーニング データを含む Azure Blob Storage の場所。 azureBlobSource または azureBlobFileListSource を指定する必要があります。
buildMode	DocumentBuildMode		カスタム ドキュメント モデルのビルド モード。
description	string		ドキュメント モデルの説明。
maxTrainingHours	number	0.5	モデル トレーニングに使用する V100 相当の GPU 時間の最大数。 Default=0.5。
modelId	string		一意のドキュメント モデル名。
tags	object		ドキュメント モデルに関連付けられているキーと値のタグ属性の一覧。

DocumentBuildMode

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

名前	型	説明
generative	string	生成 AI 手法を使用して、すべての種類のドキュメントを有効にします。
neural	string	多様なビジュアル テンプレートを使用してドキュメントをサポートします。
template	string	類似のビジュアル テンプレートを使用してドキュメントをターゲットに設定します。

Error

エラー オブジェクト。

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

ErrorResponse

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

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

InnerError

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

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