Document Models - Build Model

Service:

Azure AI Services

API Version:

2023-07-31

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

POST {endpoint}/formrecognizer/documentModels:build?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 サブスクリプションのシークレット キー。

要求本文

名前	必須	型	説明
buildMode	True	DocumentBuildMode	カスタム ドキュメント モデルのビルド モード。
modelId	True	string	一意のドキュメント モデル名。
azureBlobFileListSource		AzureBlobFileListContentSource	Azure Blob Storageトレーニング データを指定するファイル一覧です。 azureBlobSource または azureBlobFileListSource を指定する必要があります。
azureBlobSource		AzureBlobContentSource	トレーニング データAzure Blob Storage含む場所。 azureBlobSource または azureBlobFileListSource を指定する必要があります。
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

例

Build Document Model

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels:build?api-version=2023-07-31

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

Sample Response

Status code:

202

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

定義

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

AzureBlobContentSource

コンテンツをAzure Blob Storageします。

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

AzureBlobFileListContentSource

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

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

BuildDocumentModelRequest

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

名前	型	説明
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storageトレーニング データを指定するファイル一覧です。 azureBlobSource または azureBlobFileListSource を指定する必要があります。
azureBlobSource	AzureBlobContentSource	トレーニング データAzure Blob Storage含む場所。 azureBlobSource または azureBlobFileListSource を指定する必要があります。
buildMode	DocumentBuildMode	カスタム ドキュメント モデルのビルド モード。
description	string	ドキュメント モデルの説明。
modelId	string	一意のドキュメント モデル名。
tags	object	ドキュメント モデルに関連付けられているキーと値のタグ属性の一覧。

DocumentBuildMode

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

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

Error

エラー情報。

名前	型	説明
code	string	エラー コード。
details	Error[]	詳細なエラーの一覧。
innererror	InnerError	詳細なエラー。
message	string	エラー メッセージ。
target	string	エラーのターゲット。

ErrorResponse

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

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

InnerError

詳細なエラー。

名前	型	説明
code	string	エラー コード。
innererror	InnerError	詳細なエラー。
message	string	エラー メッセージ。