Document Classifiers - Build Classifier

Service:

Azure AI Services

API Version:

2024-02-29-preview

カスタム ドキュメント分類子を作成します。

POST {endpoint}/documentintelligence/documentClassifiers:build?api-version=2024-02-29-preview

URI パラメーター

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

要求本文

名前	必須	型	説明
classifierId	True	string	一意のドキュメント分類子名。
docTypes	True	<string,  ClassifierDocumentTypeDetails>	分類対象のドキュメントの種類の一覧。
baseClassifierId		string	分類子をトレーニングする上の基本 classifierId。
description		string	分類子の説明を文書化します。

応答

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

セキュリティ

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

例

Build Document Classifier

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers:build?api-version=2024-02-29-preview

{
  "classifierId": "myClassifier",
  "description": "Classifier description",
  "docTypes": {
    "formA": {
      "azureBlobSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
        "prefix": "formADocs/"
      }
    },
    "formB": {
      "azureBlobFileListSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
        "fileList": "formB.jsonl"
      }
    }
  }
}

Sample Response

Status code:

202

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

定義

名前	説明
AzureBlobContentSource	コンテンツをAzure Blob Storageします。
AzureBlobFileListContentSource	Azure Blob Storageのファイル一覧。
BuildDocumentClassifierRequest	新しいカスタム ドキュメント分類子を構築するための要求本文。
ClassifierDocumentTypeDetails	分類子ドキュメントの種類の情報。
ContentSourceKind	コンテンツ ソースの種類。
Error	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 ファイルへのパス。

BuildDocumentClassifierRequest

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

名前	型	説明
baseClassifierId	string	分類子をトレーニングする上の基本 classifierId。
classifierId	string	一意のドキュメント分類子名。
description	string	分類子の説明を文書化します。
docTypes	<string,  ClassifierDocumentTypeDetails>	分類対象のドキュメントの種類の一覧。

ClassifierDocumentTypeDetails

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

名前	型	説明
azureBlobFileListSource	AzureBlobFileListContentSource	分類子ドキュメントの種類のトレーニング データを指定するファイル一覧をAzure Blob Storageします。 azureBlobSource または azureBlobFileListSource を指定する必要があります。
azureBlobSource	AzureBlobContentSource	分類子ドキュメントの種類のトレーニング データを含む場所をAzure Blob Storageします。 azureBlobSource または azureBlobFileListSource を指定する必要があります。
sourceKind	ContentSourceKind	トレーニング データ ソースの種類。

ContentSourceKind

コンテンツ ソースの種類。

名前	型	説明
azureBlob	string	Azure Blob Storage コンテナー内のパス内のファイル。
azureBlobFileList	string	Azure Blob Storage コンテナー内の個々のファイルを指定するファイルリスト。
base64	string	Base64 エンコードを介して表されるコンテンツ。
url	string	特定の URL のコンテンツ。

Error

error オブジェクト。

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

ErrorResponse

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

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

InnerError

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

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