Document Classifiers - Get Classifier

Service:

Azure AI Services

API Version:

2024-02-29-preview

ドキュメント分類子の詳細な情報を取得します。

GET {endpoint}/documentintelligence/documentClassifiers/{classifierId}?api-version=2024-02-29-preview

URI パラメーター

名前	/	必須	型	説明
classifierId	path	True	string	一意のドキュメント分類子名。 Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
endpoint	path	True	string	ドキュメント インテリジェンス サービス エンドポイント。
api-version	query	True	string	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
x-ms-client-request-id		string uuid	要求の不透明でグローバルに一意のクライアント生成文字列識別子。

応答

名前	型	説明
200 OK	DocumentClassifierDetails	要求は成功しました。 Headers x-ms-client-request-id: string
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

例

Get Document Classifier

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "classifierId": "myClassifier",
  "description": "Classifier description",
  "createdDateTime": "2022-07-30T00:00:00Z",
  "expirationDateTime": "2023-01-01T00:00:00Z",
  "apiVersion": "2024-02-29-preview",
  "docTypes": {
    "formA": {
      "azureBlobSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
        "prefix": "formADocs/"
      }
    },
    "formB": {
      "azureBlobFileListSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
        "fileList": "formB.jsonl"
      }
    }
  }
}

定義

名前	説明
AzureBlobContentSource	コンテンツをAzure Blob Storageします。
AzureBlobFileListContentSource	Azure Blob Storageのファイル一覧。
ClassifierDocumentTypeDetails	分類子ドキュメントの種類の情報。
ContentSourceKind	コンテンツ ソースの種類。
DocumentClassifierDetails	ドキュメント分類子情報。
Error	error オブジェクト。
ErrorResponse	エラー応答オブジェクト。
InnerError	エラーに関するより具体的な情報を含むオブジェクト。
Warning	error オブジェクト。

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 ファイルへのパス。

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 のコンテンツ。

DocumentClassifierDetails

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

名前	型	説明
apiVersion	string	このドキュメント分類子の作成に使用される API バージョン。
baseClassifierId	string	分類子がトレーニングされた上の基本 classifierId。
classifierId	string	一意のドキュメント分類子名。
createdDateTime	string	ドキュメント分類子が作成された日時 (UTC)。
description	string	分類子の説明を文書化します。
docTypes	<string,  ClassifierDocumentTypeDetails>	分類対象のドキュメントの種類の一覧。
expirationDateTime	string	ドキュメント分類子の有効期限が切れる日時 (UTC)。
warnings	Warning[]	分類子の構築中に発生した警告の一覧。

Error

error オブジェクト。

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

ErrorResponse

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

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

InnerError

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

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

Warning

error オブジェクト。

名前	型	説明
code	string	サーバー定義の警告コードのセットの 1 つ。
message	string	警告の人間が判読できる表現。
target	string	エラーのターゲット。