DocumentModelAdministrationAsyncClient クラス

  • リファレンス
パッケージ:
com.azure.ai.formrecognizer.documentanalysis.administration
Maven 成果物:
com.azure:azure-ai-formrecognizer:4.1.8
  • java.lang.Object
    • com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationAsyncClient

public final class DocumentModelAdministrationAsyncClient

このクラスは、Form Recognizer Azure Cognitive Service に接続するための非同期クライアントを提供します。

このクライアントは、以下を実行する非同期メソッドを提供します。

  1. カスタム モデルを構築する: メソッドを使用して beginBuidlDocumentModel カスタム モデルを構築し、Azure Storage Blob コンテナーにコンテナー SAS URL を提供することで、特定のドキュメントからデータを抽出します。
  2. 構成済みカスタム モデル: メソッドを使用して、既存のモデルのコレクションのドキュメントの種類から新しいモデルを beginComposeDocumentModel 作成します。
  3. カスタム モデルのコピー: メソッドを使用して、カスタム Form Recognizer モデルをターゲット Form Recognizer リソースにbeginCopyDocumentModelToコピーします。
  4. カスタム モデル管理: 詳細な情報を取得し、メソッド getDocumentModel(String modelId)listDocumentModels() を使用してカスタム モデルを削除および一覧表示しますdeleteDocumentModel(String modelId)。
  5. 操作管理: メソッドとそれぞれを使用して、Form Recognizer アカウントに対する詳細情報とlistOperations()一覧表示操作をgetOperation(String operationId)取得します。
  6. ポーリングとコールバック: 分析操作の状態をチェックするためのサービスのポーリング、または分析が完了したときに通知を受信するためのコールバックの登録を行うメカニズムが含まれています。

メモ： このクライアントは 以降のみをサポートします V2022_08_31 。 以前のサービス バージョンと FormTrainingClientを使用するには。 FormRecognizerClient

サービス クライアントは、開発者が Azure Form Recognizerを使用するための対話のポイントです。 DocumentModelAdministrationClient は同期サービス クライアントであり、 DocumentModelAdministrationAsyncClient 非同期サービス クライアントです。 このドキュメントに示す例では、認証に DefaultAzureCredential という名前の資格情報オブジェクトを使用します。これは、ローカルの開発環境や運用環境を含むほとんどのシナリオに適しています。 さらに、運用環境での認証に マネージド ID を 使用することをお勧めします。 認証のさまざまな方法とそれに対応する資格情報の種類の詳細については、 Azure ID のドキュメントを参照してください。

サンプル: DefaultAzureCredential を使用して を DocumentModelAdministrationAsyncClient 構築する

次のコード サンプルは、'DefaultAzureCredentialBuilder' を使用して を構成する の作成 DocumentModelAdministrationAsyncClientを示しています。

DocumentModelAdministrationAsyncClient client = new DocumentModelAdministrationClientBuilder()
     .endpoint("{endpoint}")
     .credential(new DefaultAzureCredentialBuilder().build())
     .buildAsyncClient();

さらに、クライアントの作成に使用する次のコード サンプルを参照 AzureKeyCredential してください。

DocumentModelAdministrationAsyncClient documentModelAdministrationAsyncClient =
     new DocumentModelAdministrationClientBuilder()
         .credential(new AzureKeyCredential("{key}"))
         .endpoint("{endpoint}")
         .buildAsyncClient();

メソッドの概要

修飾子と型 メソッドと説明
PollerFlux<OperationResult,DocumentClassifierDetails> beginBuildDocumentClassifier(Map<String,ClassifierDocumentTypeDetails> documentTypes)

カスタム分類子ドキュメント モデルを構築します。
PollerFlux<OperationResult,DocumentClassifierDetails> beginBuildDocumentClassifier(Map<String,ClassifierDocumentTypeDetails> documentTypes, BuildDocumentClassifierOptions buildDocumentClassifierOptions)

カスタム ドキュメント分析モデルを構築します。
PollerFlux<OperationResult,DocumentModelDetails> beginBuildDocumentModel(ContentSource contentSource, DocumentModelBuildMode buildMode)

カスタム ドキュメント分析モデルを構築します。
PollerFlux<OperationResult,DocumentModelDetails> beginBuildDocumentModel(ContentSource contentSource, DocumentModelBuildMode buildMode, BuildDocumentModelOptions buildDocumentModelOptions)

カスタム ドキュメント分析モデルを構築します。
PollerFlux<OperationResult,DocumentModelDetails> beginBuildDocumentModel(String blobContainerUrl, DocumentModelBuildMode buildMode)

カスタム ドキュメント分析モデルを構築します。
PollerFlux<OperationResult,DocumentModelDetails> beginBuildDocumentModel(String blobContainerUrl, DocumentModelBuildMode buildMode, String prefix, BuildDocumentModelOptions buildDocumentModelOptions)

カスタム ドキュメント分析モデルを構築します。
PollerFlux<OperationResult,DocumentModelDetails> beginComposeDocumentModel(List<String> componentModelIds)

アカウント内の既存のモデルの指定された一覧から構成済みモデルを作成します。
PollerFlux<OperationResult,DocumentModelDetails> beginComposeDocumentModel(List<String> componentModelIds, ComposeDocumentModelOptions composeDocumentModelOptions)

アカウント内の既存のモデルの指定された一覧から構成済みモデルを作成します。
PollerFlux<OperationResult,DocumentModelDetails> beginCopyDocumentModelTo(String sourceModelId, DocumentModelCopyAuthorization target)

このリソース (ソース) に格納されているカスタム モデルを、ユーザー指定のターゲット Form Recognizer リソースにコピーします。
Mono<Void> deleteDocumentClassifier(String classifierId)

指定したドキュメント分類子を削除します。
Mono<Response<Void>> deleteDocumentClassifierWithResponse(String classifierId)

指定したドキュメント分類子を削除します。
Mono<Void> deleteDocumentModel(String modelId)

指定したカスタム ドキュメント分析モデルを削除します。
Mono<Response<Void>> deleteDocumentModelWithResponse(String modelId)

指定したカスタム ドキュメント分析モデルを削除します。
Mono<DocumentModelCopyAuthorization> getCopyAuthorization()

カスタム ドキュメント分析モデルをターゲット Form Recognizer リソースにコピーするための承認を生成します。
Mono<Response<DocumentModelCopyAuthorization>> getCopyAuthorizationWithResponse(CopyAuthorizationOptions copyAuthorizationOptions)

カスタム ドキュメント分析モデルをターゲット Form Recognizer リソースにコピーするための承認を生成します。
DocumentAnalysisAsyncClient getDocumentAnalysisAsyncClient()

新しい DocumentAnalysisAsyncClient オブジェクトを作成します。
Mono<DocumentClassifierDetails> getDocumentClassifier(String classifierId)

ドキュメント分類子の詳細情報を ID で取得します。
Mono<Response<DocumentClassifierDetails>> getDocumentClassifierWithResponse(String classifierId)

Http 応答を使用して、指定したモデル ID の詳細情報を取得します。
Mono<DocumentModelDetails> getDocumentModel(String modelId)

指定したモデル ID の詳細情報を取得します。
Mono<Response<DocumentModelDetails>> getDocumentModelWithResponse(String modelId)

Http 応答を使用して、指定したモデル ID の詳細情報を取得します。
Mono<OperationDetails> getOperation(String operationId)

指定した ID の詳細な操作情報を取得します。
Mono<Response<OperationDetails>> getOperationWithResponse(String operationId)

Http 応答を使用して、指定された ID の詳細な操作情報を取得します。
Mono<ResourceDetails> getResourceDetails()

現在のForm Recognizer リソースに関する情報を取得します。
Mono<Response<ResourceDetails>> getResourceDetailsWithResponse()

Http 応答を使用して、現在のForm Recognizer リソースに関する情報を取得します。
PagedFlux<DocumentClassifierDetails> listDocumentClassifiers()

正常に構築されたForm Recognizer アカウントの各ドキュメント分類子の情報を一覧表示します。
PagedFlux<DocumentModelSummary> listDocumentModels()

正常に構築されたForm Recognizer アカウントの各モデルの情報を一覧表示します。
PagedFlux<OperationSummary> listOperations()

過去 24 時間のForm Recognizer アカウントでの各モデル操作の情報を一覧表示します。

メソッドの継承元: java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

メソッドの詳細

beginBuildDocumentClassifier

public PollerFlux beginBuildDocumentClassifier(Map documentTypes)

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

分類子モデルは、複数のドキュメントまたは 1 つのドキュメントの複数のインスタンスを識別できます。 このため、クラスごとに少なくとも 5 つのドキュメントと 2 つのクラスのドキュメントが必要です。

このサービスは、実行時間の長い操作の取り消しをサポートせず、取り消しサポートがないことを示すエラー メッセージを返します。

Code sample

String blobContainerUrl1040D = "{SAS_URL_of_your_container_in_blob_storage}";
 String blobContainerUrl1040A = "{SAS_URL_of_your_container_in_blob_storage}";
 HashMap<String, ClassifierDocumentTypeDetails> documentTypesDetailsMap = new HashMap<>();
 documentTypesDetailsMap.put("1040-D", new ClassifierDocumentTypeDetails(new BlobContentSource(blobContainerUrl1040D)
 ));
 documentTypesDetailsMap.put("1040-A", new ClassifierDocumentTypeDetails(new BlobContentSource(blobContainerUrl1040A)
 ));

 documentModelAdministrationAsyncClient.beginBuildDocumentClassifier(documentTypesDetailsMap)
     // if polling operation completed, retrieve the final result.
     .flatMap(AsyncPollResponse::getFinalResult)
     .subscribe(classifierDetails -> {
         System.out.printf("Classifier ID: %s%n", classifierDetails.getClassifierId());
         System.out.printf("Classifier description: %s%n", classifierDetails.getDescription());
         System.out.printf("Classifier created on: %s%n", classifierDetails.getCreatedOn());
         System.out.printf("Classifier expires on: %s%n", classifierDetails.getExpiresOn());
         classifierDetails.getDocumentTypes().forEach((key, documentTypeDetails) -> {
             if (documentTypeDetails.getContentSource() instanceof BlobContentSource) {
                 System.out.printf("Blob Source container Url: %s", ((BlobContentSource) documentTypeDetails
                     .getContentSource()).getContainerUrl());
             }
         });
     });

Parameters:

documentTypes - 分類対象のドキュメントの種類の一覧。

Returns:

PollerFlux<T,U>完了、失敗、または取り消されるまで、建物モデル操作をポーリングする 。 完了した操作は、トレーニング済 DocumentClassifierDetailsみの を返します。

beginBuildDocumentClassifier

public PollerFlux beginBuildDocumentClassifier(Map documentTypes, BuildDocumentClassifierOptions buildDocumentClassifierOptions)

カスタム ドキュメント分析モデルを構築します。 モデルは、'application/pdf'、'image/jpeg'、'image/png'、'image/tiff'、image/bmp のコンテンツ タイプのドキュメントを使用して構築されます。 他のコンテンツの種類は無視されます。

このサービスは、実行時間の長い操作の取り消しをサポートせず、取り消しサポートがないことを示すエラー メッセージを返します。

独自の管理データ・セットの作成については、 こちらを 参照してください。

Code sample

String blobContainerUrl1040D = "{SAS_URL_of_your_container_in_blob_storage}";
 String blobContainerUrl1040A = "{SAS_URL_of_your_container_in_blob_storage}";
 HashMap<String, ClassifierDocumentTypeDetails> documentTypesDetailsMap = new HashMap<>();
 documentTypesDetailsMap.put("1040-D", new ClassifierDocumentTypeDetails(new BlobContentSource(blobContainerUrl1040D)
 ));
 documentTypesDetailsMap.put("1040-A", new ClassifierDocumentTypeDetails(new BlobContentSource(blobContainerUrl1040A)
 ));

 documentModelAdministrationAsyncClient.beginBuildDocumentClassifier(documentTypesDetailsMap,
         new BuildDocumentClassifierOptions()
             .setClassifierId("classifierId")
             .setDescription("classifier desc"))
     // if polling operation completed, retrieve the final result.
     .flatMap(AsyncPollResponse::getFinalResult)
     .subscribe(classifierDetails -> {
         System.out.printf("Classifier ID: %s%n", classifierDetails.getClassifierId());
         System.out.printf("Classifier description: %s%n", classifierDetails.getDescription());
         System.out.printf("Classifier created on: %s%n", classifierDetails.getCreatedOn());
         System.out.printf("Classifier expires on: %s%n", classifierDetails.getExpiresOn());
         classifierDetails.getDocumentTypes().forEach((key, documentTypeDetails) -> {
             if (documentTypeDetails.getContentSource() instanceof BlobContentSource) {
                 System.out.printf("Blob Source container Url: %s", ((BlobContentSource) documentTypeDetails
                     .getContentSource()).getContainerUrl());
             }
         });
     });

Parameters:

documentTypes - 分類対象のドキュメントの種類の一覧。
buildDocumentClassifierOptions - カスタム分類子ドキュメント モデルを構築するときに渡す構成可能 BuildDocumentClassifierOptions な 。

Returns:

SyncPoller<T,U>完了、失敗、または取り消されるまで、建物モデル操作をポーリングする 。 完了した操作は、ビルド DocumentClassifierDetailsされた を返します。

beginBuildDocumentModel

public PollerFlux beginBuildDocumentModel(ContentSource contentSource, DocumentModelBuildMode buildMode)

カスタム ドキュメント分析モデルを構築します。 モデルは、'application/pdf'、'image/jpeg'、'image/png'、'image/tiff'、image/bmp のコンテンツ タイプのドキュメントを使用して構築されます。 他のコンテンツの種類は無視されます。

このサービスは、実行時間の長い操作の取り消しをサポートせず、取り消しサポートがないことを示すエラー メッセージを返します。

独自の管理データ・セットの作成については、 こちらを 参照してください。

Code sample

String blobContainerUrl = "{SAS-URL-of-your-container-in-blob-storage}";
 String fileList = "";
 documentModelAdministrationAsyncClient.beginBuildDocumentModel(
     new BlobFileListContentSource(blobContainerUrl, fileList),
         DocumentModelBuildMode.TEMPLATE)
     // if polling operation completed, retrieve the final result.
     .flatMap(AsyncPollResponse::getFinalResult)
     .subscribe(documentModel -> {
         System.out.printf("Model ID: %s%n", documentModel.getModelId());
         System.out.printf("Model Created on: %s%n", documentModel.getCreatedOn());
         documentModel.getDocumentTypes().forEach((key, documentTypeDetails) -> {
             documentTypeDetails.getFieldSchema().forEach((field, documentFieldSchema) -> {
                 System.out.printf("Field: %s", field);
                 System.out.printf("Field type: %s", documentFieldSchema.getType());
                 System.out.printf("Field confidence: %.2f", documentTypeDetails.getFieldConfidence().get(field));
             });
         });
     });

Parameters:

contentSource - モデルの構築に使用するトレーニング データ ソース。 Azure Storage BLOB コンテナーに、それぞれのプレフィックスと共に指定することも、トレーニング用のドキュメントのセットを指定するコンテナー内の JSONL ファイルへのパスを指定することもできます。 トレーニング データ セットの設定の詳細については、 こちらを参照してください。
buildMode - モデルを作成するための推奨される手法。 モデルのトレーニングを高速化するために、 を使用します TEMPLATE。 カスタム ドキュメントのビルド モードの詳細については、 こちらを 参照してください。

Returns:

PollerFlux<T,U>完了、失敗、または取り消されるまで、建物モデル操作をポーリングする 。 完了した操作は、トレーニング済 DocumentModelDetailsみの を返します。

beginBuildDocumentModel

public PollerFlux beginBuildDocumentModel(ContentSource contentSource, DocumentModelBuildMode buildMode, BuildDocumentModelOptions buildDocumentModelOptions)

カスタム ドキュメント分析モデルを構築します。 モデルは、'application/pdf'、'image/jpeg'、'image/png'、'image/tiff'、image/bmp のコンテンツ タイプのドキュメントを使用して構築されます。 他のコンテンツの種類は無視されます。

このサービスは、実行時間の長い操作の取り消しをサポートせず、取り消しサポートがないことを示すエラー メッセージを返します。

独自の管理データ・セットの作成については、 こちらを 参照してください。

Code sample

String blobContainerUrl = "{SAS-URL-of-your-container-in-blob-storage}";
 String fileList = "";
 String modelId = "model-id";
 Map<String, String> attrs = new HashMap<String, String>();
 attrs.put("createdBy", "sample");
 String prefix = "Invoice";

 documentModelAdministrationAsyncClient.beginBuildDocumentModel(
         new BlobFileListContentSource(blobContainerUrl, fileList),
         DocumentModelBuildMode.TEMPLATE,
     new BuildDocumentModelOptions()
         .setModelId(modelId)
         .setDescription("model desc")
         .setTags(attrs))
     // if polling operation completed, retrieve the final result.
     .flatMap(AsyncPollResponse::getFinalResult)
     .subscribe(documentModel -> {
         System.out.printf("Model ID: %s%n", documentModel.getModelId());
         System.out.printf("Model Description: %s%n", documentModel.getDescription());
         System.out.printf("Model Created on: %s%n", documentModel.getCreatedOn());
         System.out.printf("Model assigned tags: %s%n", documentModel.getTags());
         documentModel.getDocumentTypes().forEach((key, documentTypeDetails) -> {
             documentTypeDetails.getFieldSchema().forEach((field, documentFieldSchema) -> {
                 System.out.printf("Field: %s", field);
                 System.out.printf("Field type: %s", documentFieldSchema.getType());
                 System.out.printf("Field confidence: %.2f", documentTypeDetails.getFieldConfidence().get(field));
             });
         });
     });

Parameters:

contentSource - モデルの構築に使用するトレーニング データ ソース。 Azure Storage BLOB コンテナーに、それぞれのプレフィックスと共に指定することも、トレーニング用のドキュメントのセットを指定するコンテナー内の JSONL ファイルへのパスを指定することもできます。 トレーニング データ セットの設定の詳細については、 こちらを参照してください。
buildMode - モデルを作成するための推奨される手法。 モデルのトレーニングを高速化するために、 を使用します TEMPLATE。 カスタム ドキュメントのビルド モードの詳細については、 こちらを 参照してください。
buildDocumentModelOptions - カスタム ドキュメント分析モデルを構築するときに渡す構成可能 BuildDocumentModelOptions な 。

Returns:

PollerFlux<T,U>完了、失敗、または取り消されるまで、建物モデル操作をポーリングする 。 完了した操作は、トレーニング済 DocumentModelDetailsみの を返します。

beginBuildDocumentModel

public PollerFlux beginBuildDocumentModel(String blobContainerUrl, DocumentModelBuildMode buildMode)

カスタム ドキュメント分析モデルを構築します。 モデルは、'application/pdf'、'image/jpeg'、'image/png'、'image/tiff'、image/bmp のコンテンツ タイプのドキュメントを使用して構築されます。 他のコンテンツの種類は無視されます。

このサービスは、実行時間の長い操作の取り消しをサポートせず、取り消しサポートがないことを示すエラー メッセージを返します。

独自の管理データ・セットの作成については、 こちらを 参照してください。

Code sample

String blobContainerUrl = "{SAS-URL-of-your-container-in-blob-storage}";
 documentModelAdministrationAsyncClient.beginBuildDocumentModel(blobContainerUrl,
         DocumentModelBuildMode.TEMPLATE
     )
     // if polling operation completed, retrieve the final result.
     .flatMap(AsyncPollResponse::getFinalResult)
     .subscribe(documentModel -> {
         System.out.printf("Model ID: %s%n", documentModel.getModelId());
         System.out.printf("Model Created on: %s%n", documentModel.getCreatedOn());
         documentModel.getDocumentTypes().forEach((key, documentTypeDetails) -> {
             documentTypeDetails.getFieldSchema().forEach((field, documentFieldSchema) -> {
                 System.out.printf("Field: %s", field);
                 System.out.printf("Field type: %s", documentFieldSchema.getType());
                 System.out.printf("Field confidence: %.2f", documentTypeDetails.getFieldConfidence().get(field));
             });
         });
     });

Parameters:

blobContainerUrl - Azure Storage BLOB コンテナーの SAS URI。 コンテナーがパブリックであるか、マネージド ID が構成されている場合は、コンテナー URI (SAS なし) を使用できます。 トレーニング データ セットの設定の詳細については、 こちらを参照してください。
buildMode - モデルを作成するための推奨される手法。 モデルのトレーニングを高速化するために、 を使用します TEMPLATE。 カスタム ドキュメントのビルド モードの詳細については、 こちらを 参照してください。

Returns:

PollerFlux<T,U>完了、失敗、または取り消されるまで、建物モデル操作をポーリングする 。 完了した操作は、トレーニング済 DocumentModelDetailsみの を返します。

beginBuildDocumentModel

public PollerFlux beginBuildDocumentModel(String blobContainerUrl, DocumentModelBuildMode buildMode, String prefix, BuildDocumentModelOptions buildDocumentModelOptions)

カスタム ドキュメント分析モデルを構築します。 モデルは、'application/pdf'、'image/jpeg'、'image/png'、'image/tiff'、image/bmp のコンテンツ タイプのドキュメントを使用して構築されます。 他のコンテンツの種類は無視されます。

このサービスは、実行時間の長い操作の取り消しをサポートせず、取り消しサポートがないことを示すエラー メッセージを返します。

独自の管理データ・セットの作成については、 こちらを 参照してください。

Code sample

String blobContainerUrl = "{SAS-URL-of-your-container-in-blob-storage}";
 String modelId = "model-id";
 Map<String, String> attrs = new HashMap<String, String>();
 attrs.put("createdBy", "sample");
 String prefix = "Invoice";

 documentModelAdministrationAsyncClient.beginBuildDocumentModel(blobContainerUrl,
         DocumentModelBuildMode.TEMPLATE,
         prefix,
         new BuildDocumentModelOptions()
             .setModelId(modelId)
             .setDescription("model desc")
             .setTags(attrs))
     // if polling operation completed, retrieve the final result.
     .flatMap(AsyncPollResponse::getFinalResult)
     .subscribe(documentModel -> {
         System.out.printf("Model ID: %s%n", documentModel.getModelId());
         System.out.printf("Model Description: %s%n", documentModel.getDescription());
         System.out.printf("Model Created on: %s%n", documentModel.getCreatedOn());
         System.out.printf("Model assigned tags: %s%n", documentModel.getTags());
         documentModel.getDocumentTypes().forEach((key, documentTypeDetails) -> {
             documentTypeDetails.getFieldSchema().forEach((field, documentFieldSchema) -> {
                 System.out.printf("Field: %s", field);
                 System.out.printf("Field type: %s", documentFieldSchema.getType());
                 System.out.printf("Field confidence: %.2f", documentTypeDetails.getFieldConfidence().get(field));
             });
         });
     });

Parameters:

blobContainerUrl - Azure Storage BLOB コンテナーの SAS URI。 コンテナーがパブリックであるか、マネージド ID が構成されている場合は、コンテナー URI (SAS なし) を使用できます。 トレーニング データ セットの設定の詳細については、 こちらを参照してください。
buildMode - モデルを作成するための推奨される手法。 モデルのトレーニングを高速化するために、 を使用します TEMPLATE。 カスタム ドキュメントのビルド モードの詳細については、 こちらを 参照してください。
prefix - トレーニング用にドキュメントをフィルター処理するための大文字と小文字を区別するプレフィックス BLOB 名プレフィックス。
buildDocumentModelOptions - カスタム ドキュメント分析モデルを構築するときに渡す構成可能 BuildDocumentModelOptions な 。

Returns:

PollerFlux<T,U>完了、失敗、または取り消されるまで、建物モデル操作をポーリングする 。 完了した操作は、トレーニング済 DocumentModelDetailsみの を返します。

beginComposeDocumentModel

public PollerFlux beginComposeDocumentModel(List componentModelIds)

アカウント内の既存のモデルの指定された一覧から構成済みモデルを作成します。

この操作は、リストが無効な既存のモデル ID または重複する ID で構成されている場合に失敗します。

このサービスは、実行時間の長い操作の取り消しをサポートせず、取り消しサポートがないことを示すエラー メッセージを返します。

Code sample

String modelId1 = "{model_Id_1}";
 String modelId2 = "{model_Id_2}";
 documentModelAdministrationAsyncClient.beginComposeDocumentModel(Arrays.asList(modelId1, modelId2)
     )
     // if polling operation completed, retrieve the final result.
     .flatMap(AsyncPollResponse::getFinalResult)
     .subscribe(documentModel -> {
         System.out.printf("Model ID: %s%n", documentModel.getModelId());
         System.out.printf("Model Created on: %s%n", documentModel.getCreatedOn());
         documentModel.getDocumentTypes().forEach((key, documentTypeDetails) -> {
             documentTypeDetails.getFieldSchema().forEach((field, documentFieldSchema) -> {
                 System.out.printf("Field: %s", field);
                 System.out.printf("Field type: %s", documentFieldSchema.getType());
                 System.out.printf("Field confidence: %.2f", documentTypeDetails.getFieldConfidence().get(field));
             });
         });
     });

Parameters:

componentModelIds - 作成するコンポーネント モデルの一覧。

Returns:

PollerFlux<T,U>作成されたモデルの作成操作が完了、失敗、または取り消されるまでポーリングする 。 完了した操作は、作成 DocumentModelDetailsされた を返します。

beginComposeDocumentModel

public PollerFlux beginComposeDocumentModel(List componentModelIds, ComposeDocumentModelOptions composeDocumentModelOptions)

アカウント内の既存のモデルの指定された一覧から構成済みモデルを作成します。

この操作は、リストが無効な既存のモデル ID または重複する ID で構成されている場合に失敗します。

このサービスは、実行時間の長い操作の取り消しをサポートせず、取り消しサポートがないことを示すエラー メッセージを返します。

Code sample

String modelId1 = "{model_Id_1}";
 String modelId2 = "{model_Id_2}";
 String modelId = "my-composed-model";
 Map<String, String> attrs = new HashMap<String, String>();
 attrs.put("createdBy", "sample");

 documentModelAdministrationAsyncClient.beginComposeDocumentModel(Arrays.asList(modelId1, modelId2),
         new ComposeDocumentModelOptions()
             .setModelId(modelId)
             .setDescription("model-desc")
             .setTags(attrs))
     // if polling operation completed, retrieve the final result.
     .flatMap(AsyncPollResponse::getFinalResult)
     .subscribe(documentModel -> {
         System.out.printf("Model ID: %s%n", documentModel.getModelId());
         System.out.printf("Model Description: %s%n", documentModel.getDescription());
         System.out.printf("Model Created on: %s%n", documentModel.getCreatedOn());
         System.out.printf("Model assigned tags: %s%n", documentModel.getTags());
         documentModel.getDocumentTypes().forEach((key, documentTypeDetails) -> {
             documentTypeDetails.getFieldSchema().forEach((field, documentFieldSchema) -> {
                 System.out.printf("Field: %s", field);
                 System.out.printf("Field type: %s", documentFieldSchema.getType());
                 System.out.printf("Field confidence: %.2f", documentTypeDetails.getFieldConfidence().get(field));
             });
         });
     });

Parameters:

componentModelIds - 作成するコンポーネント モデルの一覧。
composeDocumentModelOptions - 構成済みモデルの作成時に渡す構成可能 ComposeDocumentModelOptions な 。

Returns:

PollerFlux<T,U>作成されたモデルの作成操作が完了、失敗、または取り消されるまでポーリングする 。 完了した操作は、コピーしたモデル DocumentModelDetailsを返します。

beginCopyDocumentModelTo

public PollerFlux beginCopyDocumentModelTo(String sourceModelId, DocumentModelCopyAuthorization target)

このリソース (ソース) に格納されているカスタム モデルを、ユーザー指定のターゲット Form Recognizer リソースにコピーします。

これは、ソース Form Recognizer リソース (コピー対象のモデル) で呼び出す必要があります。 ターゲット パラメーターは、ターゲット リソースの メソッドからの出力から getCopyAuthorization() 指定する必要があります。

このサービスは、実行時間の長い操作の取り消しをサポートせず、取り消しサポートがないことを示すエラー メッセージを返します。

Code sample

String copyModelId = "copy-model";
 // Get authorization to copy the model to target resource
 documentModelAdministrationAsyncClient.getCopyAuthorization()
     // Start copy operation from the source client
     // The ID of the model that needs to be copied to the target resource
     .subscribe(copyAuthorization -> documentModelAdministrationAsyncClient.beginCopyDocumentModelTo(copyModelId,
             copyAuthorization)
         .filter(pollResponse -> pollResponse.getStatus().isComplete())
         .flatMap(AsyncPollResponse::getFinalResult)
         .subscribe(documentModel ->
             System.out.printf("Copied model has model ID: %s, was created on: %s.%n,",
                 documentModel.getModelId(),
                 documentModel.getCreatedOn())));

Parameters:

sourceModelId - ターゲット リソースにコピーするソース モデルのモデル識別子。
target - ターゲット Form Recognizer リソースへのコピー承認。 コピー承認は、ターゲット リソースの の呼び出しから生成できます。 getCopyAuthorization()

Returns:

PollerFlux<T,U>モデルのコピー操作が完了、失敗、または取り消されるまでポーリングする 。 完了した操作は、コピーしたモデル DocumentModelDetailsを返します。

deleteDocumentClassifier

public Mono deleteDocumentClassifier(String classifierId)

指定したドキュメント分類子を削除します。

Code sample

String classifierId = "{classifierId}";
 documentModelAdministrationAsyncClient.deleteDocumentClassifier(classifierId)
     .subscribe(ignored -> System.out.printf("Classifier ID: %s is deleted%n", classifierId));

Parameters:

classifierId - 一意のドキュメント分類子識別子。

Returns:

空の Mono。

deleteDocumentClassifierWithResponse

public Mono> deleteDocumentClassifierWithResponse(String classifierId)

指定したドキュメント分類子を削除します。

Code sample

String classifierId = "{classifierId}";
 documentModelAdministrationAsyncClient.deleteDocumentClassifierWithResponse(classifierId)
     .subscribe(response -> {
         System.out.printf("Response Status Code: %d.", response.getStatusCode());
         System.out.printf("Classifier ID: %s is deleted.%n", classifierId);
     });

Parameters:

classifierId - 一意のドキュメント分類子識別子。

Returns:

Response<T>状態コードと HTTP ヘッダーを含む 。

deleteDocumentModel

public Mono deleteDocumentModel(String modelId)

指定したカスタム ドキュメント分析モデルを削除します。

Code sample

String modelId = "{model_id}";
 documentModelAdministrationAsyncClient.deleteDocumentModel(modelId)
     .subscribe(ignored -> System.out.printf("Model ID: %s is deleted%n", modelId));

Parameters:

modelId - 一意のモデル識別子。

Returns:

空の Mono。

deleteDocumentModelWithResponse

public Mono> deleteDocumentModelWithResponse(String modelId)

指定したカスタム ドキュメント分析モデルを削除します。

Code sample

String modelId = "{model_id}";
 documentModelAdministrationAsyncClient.deleteDocumentModelWithResponse(modelId)
     .subscribe(response -> {
         System.out.printf("Response Status Code: %d.", response.getStatusCode());
         System.out.printf("Model ID: %s is deleted.%n", modelId);
     });

Parameters:

modelId - 一意のモデル識別子。

Returns:

Response<T>状態コードと HTTP ヘッダーを含む 。

getCopyAuthorization

public Mono getCopyAuthorization()

カスタム ドキュメント分析モデルをターゲット Form Recognizer リソースにコピーするための承認を生成します。

これはターゲット リソース (モデルのコピー先) によって呼び出され、出力はターゲット パラメーターとして に beginCopyDocumentModelTo(String sourceModelId, DocumentModelCopyAuthorization target)渡すことができます。

Returns:

DocumentModelCopyAuthorizationリソース間でのモデルのコピーを承認するために使用できる 。

getCopyAuthorizationWithResponse

public Mono> getCopyAuthorizationWithResponse(CopyAuthorizationOptions copyAuthorizationOptions)

カスタム ドキュメント分析モデルをターゲット Form Recognizer リソースにコピーするための承認を生成します。

これはターゲット リソース (モデルのコピー先) によって呼び出され、出力はターゲット パラメーターとして に beginCopyDocumentModelTo(String sourceModelId, DocumentModelCopyAuthorization target)渡すことができます。

Parameters:

copyAuthorizationOptions - モデルのコピー時に渡す構成可能 CopyAuthorizationOptions 。 Code sample String modelId = "my-copied-model";Map<String, String> attrs = new HashMap<String, String>(); attrs.put("createdBy", "sample");

documentModelAdministrationAsyncClient.getCopyAuthorizationWithResponse( new CopyAuthorizationOptions() .setModelId(modelId) .setDescription("model desc") .setTags(attrs)) .subscribe(copyAuthorization -> System.out.printf("Copy Authorization response status: %s, for model id: %s, access token: %s, " + "expiration time: %s, target resource ID; %s, target resource region: %s%n", copyAuthorization.getStatusCode(), copyAuthorization.getValue().getTargetModelId(), copyAuthorization.getValue().getAccessToken(), copyAuthorization.getValue().getExpiresOn(), copyAuthorization.getValue().getTargetResourceId(), copyAuthorization.getValue().getTargetResourceRegion() ));

Returns:

DocumentModelCopyAuthorizationリソース間でのモデルのコピーを承認するために使用できる 。

getDocumentAnalysisAsyncClient

public DocumentAnalysisAsyncClient getDocumentAnalysisAsyncClient()

新しい DocumentAnalysisAsyncClient オブジェクトを作成します。 新しい DocumentTrainingAsyncClient では、 と同じ要求ポリシー パイプラインが使用されます DocumentTrainingAsyncClient。

Returns:

新しい DocumentAnalysisAsyncClient オブジェクト。

getDocumentClassifier

public Mono getDocumentClassifier(String classifierId)

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

Code sample

String modelId = "{model_id}";
 documentModelAdministrationAsyncClient.getDocumentClassifier(modelId).subscribe(documentClassifier -> {
     System.out.printf("Classifier ID: %s%n", documentClassifier.getClassifierId());
     System.out.printf("Classifier Description: %s%n", documentClassifier.getDescription());
     System.out.printf("Classifier Created on: %s%n", documentClassifier.getCreatedOn());
     documentClassifier.getDocumentTypes().forEach((key, documentTypeDetails) -> {
         if (documentTypeDetails.getContentSource() instanceof BlobContentSource) {
             System.out.printf("Blob Source container Url: %s", ((BlobContentSource) documentTypeDetails
                 .getContentSource()).getContainerUrl());
         }
         if (documentTypeDetails.getContentSource() instanceof BlobFileListContentSource) {
             System.out.printf("Blob File List Source container Url: %s",
                 ((BlobFileListContentSource) documentTypeDetails
                 .getContentSource()).getContainerUrl());
         }
     });
 });

Parameters:

classifierId - 一意のドキュメント分類子識別子。

Returns:

指定したドキュメント分類子 ID の詳細情報。

getDocumentClassifierWithResponse

public Mono> getDocumentClassifierWithResponse(String classifierId)

Http 応答を使用して、指定したモデル ID の詳細情報を取得します。

Code sample

String modelId = "{model_id}";
 documentModelAdministrationAsyncClient.getDocumentModelWithResponse(modelId).subscribe(response -> {
     System.out.printf("Response Status Code: %d.", response.getStatusCode());
     DocumentModelDetails documentModelDetails = response.getValue();
     System.out.printf("Model ID: %s%n", documentModelDetails.getModelId());
     System.out.printf("Model Description: %s%n", documentModelDetails.getDescription());
     System.out.printf("Model Created on: %s%n", documentModelDetails.getCreatedOn());
     documentModelDetails.getDocumentTypes().forEach((key, documentTypeDetails) -> {
         documentTypeDetails.getFieldSchema().forEach((field, documentFieldSchema) -> {
             System.out.printf("Field: %s", field);
             System.out.printf("Field type: %s", documentFieldSchema.getType());
             System.out.printf("Field confidence: %.2f", documentTypeDetails.getFieldConfidence().get(field));
         });
     });
 });

Parameters:

classifierId - 一意のドキュメント分類子識別子。

Returns:

Response<T>要求された DocumentClassifierDetailsを含む 。

getDocumentModel

public Mono getDocumentModel(String modelId)

指定したモデル ID の詳細情報を取得します。

Code sample

String modelId = "{model_id}";
 documentModelAdministrationAsyncClient.getDocumentModel(modelId).subscribe(documentModel -> {
     System.out.printf("Model ID: %s%n", documentModel.getModelId());
     System.out.printf("Model Description: %s%n", documentModel.getDescription());
     System.out.printf("Model Created on: %s%n", documentModel.getCreatedOn());
     documentModel.getDocumentTypes().forEach((key, documentTypeDetails) -> {
         documentTypeDetails.getFieldSchema().forEach((field, documentFieldSchema) -> {
             System.out.printf("Field: %s", field);
             System.out.printf("Field type: %s", documentFieldSchema.getType());
             System.out.printf("Field confidence: %.2f", documentTypeDetails.getFieldConfidence().get(field));
         });
     });
 });

Parameters:

modelId - 一意のモデル識別子。

Returns:

指定したモデルの詳細情報。

getDocumentModelWithResponse

public Mono> getDocumentModelWithResponse(String modelId)

Http 応答を使用して、指定したモデル ID の詳細情報を取得します。

Code sample

String modelId = "{model_id}";
 documentModelAdministrationAsyncClient.getDocumentModelWithResponse(modelId).subscribe(response -> {
     System.out.printf("Response Status Code: %d.", response.getStatusCode());
     DocumentModelDetails documentModelDetails = response.getValue();
     System.out.printf("Model ID: %s%n", documentModelDetails.getModelId());
     System.out.printf("Model Description: %s%n", documentModelDetails.getDescription());
     System.out.printf("Model Created on: %s%n", documentModelDetails.getCreatedOn());
     documentModelDetails.getDocumentTypes().forEach((key, documentTypeDetails) -> {
         documentTypeDetails.getFieldSchema().forEach((field, documentFieldSchema) -> {
             System.out.printf("Field: %s", field);
             System.out.printf("Field type: %s", documentFieldSchema.getType());
             System.out.printf("Field confidence: %.2f", documentTypeDetails.getFieldConfidence().get(field));
         });
     });
 });

Parameters:

modelId - 一意のモデル識別子。

Returns:

Response<T>要求された DocumentModelDetailsを含む 。

getOperation

public Mono getOperation(String operationId)

指定した ID の詳細な操作情報を取得します。

この操作は、使用される操作 ID が 24 時間を超えていれば失敗します。

Code sample

String operationId = "{operation_Id}";
 documentModelAdministrationAsyncClient.getOperation(operationId).subscribe(operationDetails -> {
     System.out.printf("Operation ID: %s%n", operationDetails.getOperationId());
     System.out.printf("Operation Kind: %s%n", operationDetails.getKind());
     System.out.printf("Operation Status: %s%n", operationDetails.getStatus());
     System.out.printf("Model ID created with this operation: %s%n",
         ((DocumentModelBuildOperationDetails) operationDetails).getResult().getModelId());
     if (OperationStatus.FAILED.equals(operationDetails.getStatus())) {
         System.out.printf("Operation fail error: %s%n", operationDetails.getError().getMessage());
     }
 });

Parameters:

operationId - 一意の操作 ID。

Returns:

指定した ID の詳細な操作情報。

getOperationWithResponse

public Mono> getOperationWithResponse(String operationId)

Http 応答を使用して、指定された ID の詳細な操作情報を取得します。

この操作は、使用される操作 ID が 24 時間を超えていれば失敗します。

Code sample

String operationId = "{operation_Id}";
 documentModelAdministrationAsyncClient.getOperationWithResponse(operationId).subscribe(response -> {
     System.out.printf("Response Status Code: %d.", response.getStatusCode());
     OperationDetails operationDetails = response.getValue();
     System.out.printf("Operation ID: %s%n", operationDetails.getOperationId());
     System.out.printf("Operation Kind: %s%n", operationDetails.getKind());
     System.out.printf("Operation Status: %s%n", operationDetails.getStatus());
     System.out.printf("Model ID created with this operation: %s%n",
         ((DocumentModelBuildOperationDetails) operationDetails).getResult().getModelId());
     if (OperationStatus.FAILED.equals(operationDetails.getStatus())) {
         System.out.printf("Operation fail error: %s%n", operationDetails.getError().getMessage());
     }
 });

Parameters:

operationId - 一意の操作 ID。

Returns:

Response<T>要求された OperationDetailsを含む 。

getResourceDetails

public Mono getResourceDetails()

現在のForm Recognizer リソースに関する情報を取得します。

Code sample

documentModelAdministrationAsyncClient.getResourceDetails()
     .subscribe(resourceInfo -> {
         System.out.printf("Max number of models that can be build for this account: %d%n",
             resourceInfo.getCustomDocumentModelLimit());
         System.out.printf("Current count of built document analysis models: %d%n",
             resourceInfo.getCustomDocumentModelCount());
     });

Returns:

要求されたリソース情報の詳細。

getResourceDetailsWithResponse

public Mono> getResourceDetailsWithResponse()

Http 応答を使用して、現在のForm Recognizer リソースに関する情報を取得します。

Code sample

documentModelAdministrationAsyncClient.getResourceDetailsWithResponse()
     .subscribe(response -> {
         System.out.printf("Response Status Code: %d.", response.getStatusCode());
         ResourceDetails resourceDetails = response.getValue();
         System.out.printf("Max number of models that can be build for this account: %d%n",
             resourceDetails.getCustomDocumentModelLimit());
         System.out.printf("Current count of built document analysis models: %d%n",
             resourceDetails.getCustomDocumentModelCount());
     });

Returns:

Response<T>要求されたリソース情報の詳細を格納している 。

listDocumentClassifiers

public PagedFlux listDocumentClassifiers()

正常に構築されたForm Recognizer アカウントの各ドキュメント分類子の情報を一覧表示します。

Code sample

documentModelAdministrationAsyncClient.listDocumentClassifiers()
     .subscribe(documentModelInfo ->
         System.out.printf("Classifier ID: %s, Classifier description: %s, Created on: %s.%n",
             documentModelInfo.getClassifierId(),
             documentModelInfo.getDescription(),
             documentModelInfo.getCreatedOn()));

Returns:

PagedFlux<T>Form Recognizer アカウントの が DocumentClassifierDetails です。

listDocumentModels

public PagedFlux listDocumentModels()

正常に構築されたForm Recognizer アカウントの各モデルの情報を一覧表示します。

Code sample

documentModelAdministrationAsyncClient.listDocumentModels()
     .subscribe(documentModelInfo ->
         System.out.printf("Model ID: %s, Model description: %s, Created on: %s.%n",
             documentModelInfo.getModelId(),
             documentModelInfo.getDescription(),
             documentModelInfo.getCreatedOn()));

Returns:

listOperations

public PagedFlux listOperations()

過去 24 時間のForm Recognizer アカウントでの各モデル操作の情報を一覧表示します。

Code sample

documentModelAdministrationAsyncClient.listOperations()
     .subscribe(modelOperationSummary -> {
         System.out.printf("Operation ID: %s%n", modelOperationSummary.getOperationId());
         System.out.printf("Operation Status: %s%n", modelOperationSummary.getStatus());
         System.out.printf("Operation Created on: %s%n", modelOperationSummary.getCreatedOn());
         System.out.printf("Operation Percent completed: %d%n", modelOperationSummary.getPercentCompleted());
         System.out.printf("Operation Kind: %s%n", modelOperationSummary.getKind());
         System.out.printf("Operation Last updated on: %s%n", modelOperationSummary.getLastUpdatedOn());
         System.out.printf("Operation resource location: %s%n", modelOperationSummary.getResourceLocation());
     });

Returns:

適用対象