FormTrainingClient クラス

public SyncPoller beginCopyModel(String modelId, CopyAuthorization target)

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

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

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

Code sample

String resourceId = "target-resource-Id";
 String resourceRegion = "target-resource-region";
 String copyModelId = "copy-model-Id";
 formTrainingAsyncClient.getCopyAuthorization(resourceId, resourceRegion)
     .flatMapMany(copyAuthorization -> formTrainingAsyncClient.beginCopyModel(copyModelId, copyAuthorization))
     .flatMap(AsyncPollResponse::getFinalResult)
     .subscribe(customFormModelInfo ->
         System.out.printf("Copied model has model Id: %s, model status: %s, training started on: %s,"
             + " training completed on: %s.%n",
         customFormModelInfo.getModelId(),
         customFormModelInfo.getStatus(),
         customFormModelInfo.getTrainingStartedOn(),
         customFormModelInfo.getTrainingCompletedOn()));

Parameters:

Returns:

public SyncPoller beginCopyModel(String modelId, CopyAuthorization target, Duration pollInterval, Context context)

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

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

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

Code sample

// The resource to copy model to
 String resourceId = "target-resource-Id";
 String resourceRegion = "target-resource-region";
 // The Id of the model to be copied
 String copyModelId = "copy-model-Id";

 CopyAuthorization copyAuthorization = targetFormTrainingClient.getCopyAuthorization(resourceId,
     resourceRegion);
 formTrainingClient.beginCopyModel(copyModelId, copyAuthorization, Duration.ofSeconds(5), Context.NONE)
     .waitForCompletion();
 CustomFormModel modelCopy = targetFormTrainingClient.getCustomModel(copyAuthorization.getModelId());
 System.out.printf("Copied model has model Id: %s, model status: %s, was requested on: %s,"
         + " transfer completed on: %s.%n",
     modelCopy.getModelId(),
     modelCopy.getModelStatus(),
     modelCopy.getTrainingStartedOn(),
     modelCopy.getTrainingCompletedOn());

Parameters:

Returns:

public SyncPoller beginCreateComposedModel(List modelIds)

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

この操作は、リストが無効な、既存ではないモデル ID、または重複する ID で構成されている場合に失敗します。 この操作は現在、ラベルを使用してトレーニングされたカスタム モデルでのみサポートされています。

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

Code sample

String labeledModelId1 = "5f21ab8d-71a6-42d8-9856-ef5985c486a8";
 String labeledModelId2 = "d7b0904c-841f-46f9-a9f4-3f2273eef7c9";
 final CustomFormModel customFormModel
     = formTrainingClient.beginCreateComposedModel(Arrays.asList(labeledModelId1, labeledModelId2))
     .getFinalResult();
 System.out.printf("Model Id: %s%n", customFormModel.getModelId());
 System.out.printf("Model Status: %s%n", customFormModel.getModelStatus());
 System.out.printf("Is this a composed model: %s%n",
     customFormModel.getCustomModelProperties().isComposed());
 customFormModel.getSubmodels()
     .forEach(customFormSubmodel -> customFormSubmodel.getFields()
         .forEach((key, customFormModelField) ->
             System.out.printf("Form type: %s Field Text: %s Field Accuracy: %f%n",
                 key, customFormModelField.getName(), customFormModelField.getAccuracy())));

Parameters:

Returns:

public SyncPoller beginCreateComposedModel(List modelIds, CreateComposedModelOptions createComposedModelOptions, Context context)

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

この操作は、リストが無効な、既存ではないモデル ID、または重複する ID で構成されている場合に失敗します。 この操作は現在、ラベルを使用してトレーニングされたカスタム モデルでのみサポートされています。

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

Code sample

String labeledModelId1 = "5f21ab8d-71a6-42d8-9856-ef5985c486a8";
 String labeledModelId2 = "d7b0904c-841f-46f9-a9f4-3f2273eef7c9";
 final CustomFormModel customFormModel =
     formTrainingClient.beginCreateComposedModel(Arrays.asList(labeledModelId1, labeledModelId2),
         new CreateComposedModelOptions()
             .setModelName("my composed model name"),
         Context.NONE)
         .setPollInterval(Duration.ofSeconds(5))
         .getFinalResult();
 System.out.printf("Model Id: %s%n", customFormModel.getModelId());
 System.out.printf("Model Status: %s%n", customFormModel.getModelStatus());
 System.out.printf("Model display name: %s%n", customFormModel.getModelName());
 System.out.printf("Is this a composed model: %s%n",
     customFormModel.getCustomModelProperties().isComposed());
 customFormModel.getSubmodels()
     .forEach(customFormSubmodel -> customFormSubmodel.getFields()
         .forEach((key, customFormModelField) ->
             System.out.printf("Form type: %s Field Text: %s Field Accuracy: %f%n",
                 key, customFormModelField.getName(), customFormModelField.getAccuracy())));

Parameters:

Returns:

public SyncPoller beginTraining(String trainingFilesUrl, boolean useTrainingLabels)

カスタム モデルを作成してトレーニングします。

モデルは、次のコンテンツの種類であるドキュメントを使用してトレーニングされます - "application/pdf"、"image/jpeg"、"image/png"、"image/tiff"。 他のコンテンツの種類は無視されます。

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

Code sample

String trainingFilesUrl = "{SAS-URL-of-your-container-in-blob-storage}";
 boolean useTrainingLabels = true;
 CustomFormModel customFormModel =
     formTrainingClient.beginTraining(trainingFilesUrl, useTrainingLabels).getFinalResult();
 System.out.printf("Model Id: %s%n", customFormModel.getModelId());
 System.out.printf("Model Status: %s%n", customFormModel.getModelStatus());
 customFormModel.getSubmodels()
     .forEach(customFormSubmodel -> customFormSubmodel.getFields()
         .forEach((key, customFormModelField) ->
             System.out.printf("Form Type: %s Field Text: %s Field Accuracy: %f%n",
                 key, customFormModelField.getName(), customFormModelField.getAccuracy())));

Parameters:

Returns:

public SyncPoller beginTraining(String trainingFilesUrl, boolean useTrainingLabels, TrainingOptions trainingOptions, Context context)

カスタム モデルを作成してトレーニングします。 モデルは、次のコンテンツの種類であるドキュメントを使用してトレーニングされます - "application/pdf"、"image/jpeg"、"image/png"、"image/tiff"。 他のコンテンツの種類は無視されます。

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

Code sample

String trainingFilesUrl = "{SAS-URL-of-your-container-in-blob-storage}";
 TrainingFileFilter trainingFileFilter = new TrainingFileFilter().setSubfoldersIncluded(false).setPrefix("Invoice");
 boolean useTrainingLabels = true;

 CustomFormModel customFormModel = formTrainingClient.beginTraining(trainingFilesUrl, useTrainingLabels,
     new TrainingOptions()
         .setTrainingFileFilter(trainingFileFilter)
         .setPollInterval(Duration.ofSeconds(5)), Context.NONE)
     .getFinalResult();

 System.out.printf("Model Id: %s%n", customFormModel.getModelId());
 System.out.printf("Model Status: %s%n", customFormModel.getModelStatus());
 customFormModel.getSubmodels()
     .forEach(customFormSubmodel -> customFormSubmodel.getFields()
         .forEach((key, customFormModelField) ->
             System.out.printf("Form Type: %s Field Text: %s Field Accuracy: %f%n",
                 key, customFormModelField.getName(), customFormModelField.getAccuracy())));

Parameters:

Returns:

public void deleteModel(String modelId)

指定したカスタム モデルを削除します。

Code sample

String modelId = "{model_id}";
 formTrainingClient.deleteModel(modelId);
 System.out.printf("Model Id: %s is deleted.%n", modelId);

Parameters:

public Response deleteModelWithResponse(String modelId, Context context)

指定したカスタム モデルを削除します。

Code sample

String modelId = "{model_id}";
 Response<Void> response = formTrainingClient.deleteModelWithResponse(modelId, Context.NONE);
 System.out.printf("Response Status Code: %d.", response.getStatusCode());
 System.out.printf("Model Id: %s is deleted.%n", modelId);

Parameters:

Returns:

public AccountProperties getAccountProperties()

フォーム認識エンジン アカウントのアカウント情報を取得します。

Code sample

AccountProperties accountProperties = formTrainingClient.getAccountProperties();
 System.out.printf("Max number of models that can be trained for this account: %d%n",
     accountProperties.getCustomModelLimit());
 System.out.printf("Current count of trained custom models: %d%n", accountProperties.getCustomModelCount());

Returns:

public Response getAccountPropertiesWithResponse(Context context)

Http 応答と指定した を使用して、フォーム認識エンジン アカウントのアカウント情報を取得します Context。

Code sample

Response<AccountProperties> response = formTrainingClient.getAccountPropertiesWithResponse(Context.NONE);
 System.out.printf("Response Status Code: %d.", response.getStatusCode());
 AccountProperties accountProperties = response.getValue();
 System.out.printf("Max number of models that can be trained for this account: %s%n",
     accountProperties.getCustomModelLimit());
 System.out.printf("Current count of trained custom models: %d%n", accountProperties.getCustomModelCount());

Parameters:

Returns:

public CopyAuthorization getCopyAuthorization(String resourceId, String resourceRegion)

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

Parameters:

 String resourceId = "target-resource-Id";
 String resourceRegion = "target-resource-region";
 CopyAuthorization copyAuthorization = formTrainingClient.getCopyAuthorization(resourceId, resourceRegion);
 System.out.printf("Copy Authorization for model id: %s, access token: %s, expiration time: %s, "
         + "target resource Id; %s, target resource region: %s%n",
     copyAuthorization.getModelId(),
     copyAuthorization.getAccessToken(),
     copyAuthorization.getExpiresOn(),
     copyAuthorization.getResourceId(),
     copyAuthorization.getResourceRegion()
 );
 

Returns:

public Response getCopyAuthorizationWithResponse(String resourceId, String resourceRegion, Context context)

ターゲット Form Recognizer リソースにカスタム モデルをコピーするための承認を生成します。 これはターゲット リソース (モデルのコピー先) によって呼び出され、出力はターゲット パラメーターとして に beginCopyModel(String modelId, CopyAuthorization target)渡すことができます。

Parameters:

 String resourceId = "target-resource-Id";
 String resourceRegion = "target-resource-region";
 Response<CopyAuthorization> copyAuthorizationResponse =
     formTrainingClient.getCopyAuthorizationWithResponse(resourceId, resourceRegion, Context.NONE);
 System.out.printf("Copy Authorization operation returned with status: %s",
     copyAuthorizationResponse.getStatusCode());
 CopyAuthorization copyAuthorization = copyAuthorizationResponse.getValue();
 System.out.printf("Copy model id: %s, access token: %s, expiration time: %s, "
         + "target resource Id; %s, target resource region: %s%n",
     copyAuthorization.getModelId(),
     copyAuthorization.getAccessToken(),
     copyAuthorization.getExpiresOn(),
     copyAuthorization.getResourceId(),
     copyAuthorization.getResourceRegion()
 );
 

Returns:

public CustomFormModel getCustomModel(String modelId)

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

Code sample

String modelId = "{model_id}";
 CustomFormModel customFormModel = formTrainingClient.getCustomModel(modelId);
 System.out.printf("Model Id: %s%n", customFormModel.getModelId());
 System.out.printf("Model Status: %s%n", customFormModel.getModelStatus());
 customFormModel.getSubmodels()
     .forEach(customFormSubmodel -> customFormSubmodel.getFields()
         .forEach((key, customFormModelField) ->
             System.out.printf("Form Type: %s Field Text: %s Field Accuracy: %f%n",
                 key, customFormModelField.getName(), customFormModelField.getAccuracy())));

Parameters:

Returns:

public Response getCustomModelWithResponse(String modelId, Context context)

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

Code sample

String modelId = "{model_id}";
 Response<CustomFormModel> response = formTrainingClient.getCustomModelWithResponse(modelId, Context.NONE);
 System.out.printf("Response Status Code: %d.", response.getStatusCode());
 CustomFormModel customFormModel = response.getValue();
 System.out.printf("Model Id: %s%n", customFormModel.getModelId());
 System.out.printf("Model Status: %s%n", customFormModel.getModelStatus());
 customFormModel.getSubmodels()
     .forEach(customFormSubmodel -> customFormSubmodel.getFields()
         .forEach((key, customFormModelField) ->
             System.out.printf("Field: %s Field Text: %s Field Accuracy: %f%n",
                 key, customFormModelField.getName(), customFormModelField.getAccuracy())));

Parameters:

Returns:

public FormRecognizerClient getFormRecognizerClient()

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

Returns:

public PagedIterable listCustomModels()

Form Recognizer アカウントの各モデルの情報を一覧表示します。

Code sample

formTrainingClient.listCustomModels()
     .forEach(customModel ->
         System.out.printf("Model Id: %s, Model status: %s, Training started on: %s, Training completed on: %s.%n",
             customModel.getModelId(),
             customModel.getStatus(),
             customModel.getTrainingStartedOn(),
             customModel.getTrainingCompletedOn())
     );

Returns:

public PagedIterable listCustomModels(Context context)

Http 応答と指定した を使用して、フォーム認識エンジン アカウントの各モデルの情報を一覧表示します Context。

Code sample

formTrainingClient.listCustomModels(Context.NONE)
     .forEach(customModel ->
         System.out.printf("Model Id: %s, Model status: %s, Training started on: %s, Training completed on: %s.%n",
             customModel.getModelId(),
             customModel.getStatus(),
             customModel.getTrainingStartedOn(),
             customModel.getTrainingCompletedOn())
     );

Parameters:

Returns: