DocumentModelAdministrationClient Class

public SyncPoller beginBuildDocumentClassifier(Map documentTypes)

Builds a custom classifier document model.

Classifier models can identify multiple documents or multiple instances of a single document. For that, you need at least five documents for each class and two classes of documents.

The service does not support cancellation of the long running operation and returns with an error message indicating absence of cancellation support.

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> documentTypes = new HashMap<>();
 documentTypes.put("1040-D", new ClassifierDocumentTypeDetails(new BlobContentSource(blobContainerUrl1040D)
 ));
 documentTypes.put("1040-A", new ClassifierDocumentTypeDetails(new BlobContentSource(blobContainerUrl1040A)
 ));

 DocumentClassifierDetails classifierDetails
     = documentModelAdministrationClient.beginBuildDocumentClassifier(documentTypes)
     .getFinalResult();

 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:

Returns:

public SyncPoller beginBuildDocumentClassifier(Map documentTypes, BuildDocumentClassifierOptions buildDocumentClassifierOptions, Context context)

Builds a custom classifier document model.

Classifier models can identify multiple documents or multiple instances of a single document. For that, you need at least five documents for each class and two classes of documents.

The service does not support cancellation of the long running operation and returns with an error message indicating absence of cancellation support.

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)
 ));

 DocumentClassifierDetails classifierDetails
     = documentModelAdministrationClient.beginBuildDocumentClassifier(documentTypesDetailsMap,
         new BuildDocumentClassifierOptions()
             .setClassifierId("classifierId")
             .setDescription("classifier desc"),
         Context.NONE)
     .getFinalResult();

 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:

Returns:

public SyncPoller beginBuildDocumentModel(ContentSource contentSource, DocumentModelBuildMode buildMode)

Builds a custom document analysis model.

Models are built using documents that are of the following content type - 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff', image/bmp. Other type of content is ignored.

The service does not support cancellation of the long running operation and returns with an error message indicating absence of cancellation support.

Code sample

String blobContainerUrl = "{SAS-URL-of-your-container-in-blob-storage}";
 String fileList = "";

 DocumentModelDetails documentModelDetails
     = documentModelAdministrationClient.beginBuildDocumentModel(
         new BlobFileListContentSource(blobContainerUrl, fileList),
         DocumentModelBuildMode.TEMPLATE)
     .getFinalResult();

 System.out.printf("Model ID: %s%n", documentModelDetails.getModelId());
 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:

Returns:

public SyncPoller beginBuildDocumentModel(ContentSource contentSource, DocumentModelBuildMode buildMode, BuildDocumentModelOptions buildDocumentModelOptions, Context context)

Builds a custom document analysis model.

Models are built using documents that are of the following content type - 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff', image/bmp. Other type of content is ignored.

The service does not support cancellation of the long running operation and returns with an error message indicating absence of cancellation support.

Code sample

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

 DocumentModelDetails documentModelDetails
     = documentModelAdministrationClient.beginBuildDocumentModel(
         new BlobFileListContentSource(blobContainerUrl, fileList),
         DocumentModelBuildMode.TEMPLATE,
         new BuildDocumentModelOptions()
             .setModelId(modelId)
             .setDescription("model desc")
             .setTags(attrs),
         Context.NONE)
     .getFinalResult();

 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());
 System.out.printf("Model assigned tags: %s%n", documentModelDetails.getTags());
 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:

Returns:

public SyncPoller beginBuildDocumentModel(String blobContainerUrl, DocumentModelBuildMode buildMode)

Builds a custom document analysis model.

Models are built using documents that are of the following content type - 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff', image/bmp. Other type of content is ignored.

The service does not support cancellation of the long running operation and returns with an error message indicating absence of cancellation support.

Code sample

String blobContainerUrl = "{SAS-URL-of-your-container-in-blob-storage}";
 DocumentModelDetails documentModelDetails
     = documentModelAdministrationClient.beginBuildDocumentModel(blobContainerUrl,
         DocumentModelBuildMode.TEMPLATE)
     .getFinalResult();

 System.out.printf("Model ID: %s%n", documentModelDetails.getModelId());
 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:

Returns:

public SyncPoller beginBuildDocumentModel(String blobContainerUrl, DocumentModelBuildMode buildMode, String prefix, BuildDocumentModelOptions buildDocumentModelOptions, Context context)

Builds a custom document analysis model.

Models are built using documents that are of the following content type - 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff', image/bmp. Other type of content is ignored.

The service does not support cancellation of the long running operation and returns with an error message indicating absence of cancellation support.

Code sample

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

 DocumentModelDetails documentModelDetails
     = documentModelAdministrationClient.beginBuildDocumentModel(blobContainerUrl,
         DocumentModelBuildMode.TEMPLATE,
         prefix,
         new BuildDocumentModelOptions()
             .setModelId(modelId)
             .setDescription("model desc")
             .setTags(attrs),
         Context.NONE)
     .getFinalResult();

 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());
 System.out.printf("Model assigned tags: %s%n", documentModelDetails.getTags());
 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:

Returns:

public SyncPoller beginComposeDocumentModel(List componentModelIds)

Create a composed model from the provided list of existing models in the account.

This operations fails if the list consists of an invalid, non-existing model Id or duplicate IDs.

The service does not support cancellation of the long running operation and returns with an error message indicating absence of cancellation support.

Code sample

String modelId1 = "{custom-model-id_1}";
 String modelId2 = "{custom-model-id_2}";
 final DocumentModelDetails documentModelDetails
     = documentModelAdministrationClient.beginComposeDocumentModel(Arrays.asList(modelId1, modelId2))
     .getFinalResult();

 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:

Returns:

public SyncPoller beginComposeDocumentModel(List componentModelIds, ComposeDocumentModelOptions composeDocumentModelOptions, Context context)

Create a composed model from the provided list of existing models in the account.

This operations fails if the list consists of an invalid, non-existing model Id or duplicate IDs.

The service does not support cancellation of the long running operation and returns with an error message indicating absence of cancellation support.

Code sample

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

 final DocumentModelDetails documentModelDetails =
     documentModelAdministrationClient.beginComposeDocumentModel(Arrays.asList(modelId1, modelId2),
             new ComposeDocumentModelOptions()
                 .setModelId(modelId)
                 .setDescription("my composed model desc")
                 .setTags(attrs),
             Context.NONE)
         .setPollInterval(Duration.ofSeconds(5))
         .getFinalResult();

 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());
 System.out.printf("Model assigned tags: %s%n", documentModelDetails.getTags());
 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:

Returns:

public SyncPoller beginCopyDocumentModelTo(String sourceModelId, DocumentModelCopyAuthorization target)

Copy a custom model stored in this resource (the source) to the user specified target Form Recognizer resource.

This should be called with the source Form Recognizer resource (with the model that is intended to be copied). The target parameter should be supplied from the target resource's output from getCopyAuthorization() method.

The service does not support cancellation of the long running operation and returns with an error message indicating absence of cancellation support.

Code sample

String copyModelId = "copy-model";
 // Get authorization to copy the model to target resource
 DocumentModelCopyAuthorization documentModelCopyAuthorization
     = documentModelAdministrationClient.getCopyAuthorization();
 // Start copy operation from the source client
 DocumentModelDetails documentModelDetails
     = documentModelAdministrationClient.beginCopyDocumentModelTo(copyModelId, documentModelCopyAuthorization)
         .getFinalResult();
 System.out.printf("Copied model has model ID: %s, was created on: %s.%n,",
     documentModelDetails.getModelId(),
     documentModelDetails.getCreatedOn());

Parameters:

Returns:

public SyncPoller beginCopyDocumentModelTo(String sourceModelId, DocumentModelCopyAuthorization target, Context context)

Copy a custom model stored in this resource (the source) to the user specified target Form Recognizer resource.

This should be called with the source Form Recognizer resource (with the model that is intended to be copied). The target parameter should be supplied from the target resource's output from getCopyAuthorization() method.

The service does not support cancellation of the long running operation and returns with an error message indicating absence of cancellation support.

Code sample

String copyModelId = "copy-model";
 // Get authorization to copy the model to target resource
 DocumentModelCopyAuthorization documentModelCopyAuthorization
     = documentModelAdministrationClient.getCopyAuthorization();
 // Start copy operation from the source client
 DocumentModelDetails documentModelDetails =
     documentModelAdministrationClient.beginCopyDocumentModelTo(copyModelId,
             documentModelCopyAuthorization,
             Context.NONE)
         .getFinalResult();
 System.out.printf("Copied model has model ID: %s, was created on: %s.%n,",
     documentModelDetails.getModelId(),
     documentModelDetails.getCreatedOn());

Parameters:

Returns:

public void deleteDocumentClassifier(String classifierId)

Deletes the specified document classifier.

Code sample

String classifierId = "{classifierId}";
 documentModelAdministrationClient.deleteDocumentClassifier(classifierId);
 System.out.printf("Classifier ID: %s is deleted.%n", classifierId);

Parameters:

public Response deleteDocumentClassifierWithResponse(String classifierId, Context context)

Deletes the specified document classifier.

Code sample

String classifierId = "{classifierId}";
 Response<Void> response
     = documentModelAdministrationClient.deleteDocumentClassifierWithResponse(classifierId, Context.NONE);
 System.out.printf("Response Status Code: %d.", response.getStatusCode());
 System.out.printf("Classifier ID: %s is deleted.%n", classifierId);

Parameters:

Returns:

public void deleteDocumentModel(String modelId)

Deletes the specified custom document analysis model.

Code sample

String modelId = "{custom-model-id}";
 documentModelAdministrationClient.deleteDocumentModel(modelId);
 System.out.printf("Model ID: %s is deleted.%n", modelId);

Parameters:

public Response deleteDocumentModelWithResponse(String modelId, Context context)

Deletes the specified custom document analysis model.

Code sample

String modelId = "{custom-model-id}";
 Response<Void> response
     = documentModelAdministrationClient.deleteDocumentModelWithResponse(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 DocumentModelCopyAuthorization getCopyAuthorization()

Generate authorization for copying a custom model into the target Form Recognizer resource.

This should be called by the target resource (where the model will be copied to) and the output can be passed as the target parameter into beginCopyDocumentModelTo(String sourceModelId, DocumentModelCopyAuthorization target).

Code sample

DocumentModelCopyAuthorization documentModelCopyAuthorization
     = documentModelAdministrationClient.getCopyAuthorization();
 System.out.printf("Copy Authorization for model id: %s, access token: %s, expiration time: %s, "
         + "target resource ID; %s, target resource region: %s%n",
     documentModelCopyAuthorization.getTargetModelId(),
     documentModelCopyAuthorization.getAccessToken(),
     documentModelCopyAuthorization.getExpiresOn(),
     documentModelCopyAuthorization.getTargetResourceId(),
     documentModelCopyAuthorization.getTargetResourceRegion()
 );

Returns:

public Response getCopyAuthorizationWithResponse(CopyAuthorizationOptions copyAuthorizationOptions, Context context)

Generate authorization for copying a custom model into the target Form Recognizer resource.

This should be called by the target resource (where the model will be copied to) and the output can be passed as the target parameter into beginCopyDocumentModelTo(String sourceModelId, DocumentModelCopyAuthorization target).

Parameters:

Returns:

public DocumentAnalysisClient getDocumentAnalysisClient()

Creates a new DocumentAnalysisClient object. The new DocumentAnalysisClient uses the same request policy pipeline as the DocumentAnalysisClient.

Returns:

public DocumentClassifierDetails getDocumentClassifier(String classifierId)

Get detailed information for a document classifier by its ID.

Code sample

String classifierId = "{classifierId}";
 DocumentClassifierDetails documentClassifierDetails
     = documentModelAdministrationClient.getDocumentClassifier(classifierId);
 System.out.printf("Classifier ID: %s%n", documentClassifierDetails.getClassifierId());
 System.out.printf("Classifier Description: %s%n", documentClassifierDetails.getDescription());
 System.out.printf("Classifier Created on: %s%n", documentClassifierDetails.getCreatedOn());
 documentClassifierDetails.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:

Returns:

public Response getDocumentClassifierWithResponse(String classifierId, Context context)

Get detailed information for a document classifier by its ID.

Code sample

String modelId = "{custom-model-id}";
 Response<DocumentClassifierDetails> response
     = documentModelAdministrationClient.getDocumentClassifierWithResponse(modelId, Context.NONE);
 System.out.printf("Response Status Code: %d.", response.getStatusCode());
 DocumentClassifierDetails documentClassifierDetails = response.getValue();
 System.out.printf("Classifier ID: %s%n", documentClassifierDetails.getClassifierId());
 System.out.printf("Classifier Description: %s%n", documentClassifierDetails.getDescription());
 System.out.printf("Classifier Created on: %s%n", documentClassifierDetails.getCreatedOn());
 documentClassifierDetails.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:

Returns:

public DocumentModelDetails getDocumentModel(String modelId)

Get detailed information for a specified model ID.

Code sample

String modelId = "{custom-model-id}";
 DocumentModelDetails documentModelDetails = documentModelAdministrationClient.getDocumentModel(modelId);
 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:

Returns:

public Response getDocumentModelWithResponse(String modelId, Context context)

Get detailed information for a specified model ID.

Code sample

String modelId = "{custom-model-id}";
 Response<DocumentModelDetails> response
     = documentModelAdministrationClient.getDocumentModelWithResponse(modelId, Context.NONE);
 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:

Returns:

public OperationDetails getOperation(String operationId)

Get detailed operation information for the specified ID with Http response.

This operations fails if the operation ID used is past 24 hours.

Code sample

String operationId = "{operation-id}";
 OperationDetails operationDetails
     = documentModelAdministrationClient.getOperation(operationId);
 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:

Returns:

public Response getOperationWithResponse(String operationId, Context context)

Get detailed operation information for the specified ID with Http response.

This operations fails if the operation ID used is past 24 hours.

Code sample

String operationId = "{operation-id}";
 Response<OperationDetails> response =
     documentModelAdministrationClient.getOperationWithResponse(operationId, Context.NONE);
 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:

Returns:

public ResourceDetails getResourceDetails()

Get information about the current Form Recognizer resource.

Code sample

ResourceDetails resourceDetails = documentModelAdministrationClient.getResourceDetails();
 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:

public Response getResourceDetailsWithResponse(Context context)

Get information about the current Form recognizer resource with a Http response and a specified Context.

Code sample

Response<ResourceDetails> response =
     documentModelAdministrationClient.getResourceDetailsWithResponse(Context.NONE);
 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());

Parameters:

Returns:

public PagedIterable listDocumentClassifiers()

List information for each document classifier on the Form Recognizer account that were built successfully.

Code sample

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

Returns:

public PagedIterable listDocumentClassifiers(Context context)

List information for each document classifier on the Form Recognizer account that were built successfully with a Http response and a specified Context.

Code sample

documentModelAdministrationClient.listDocumentClassifiers(Context.NONE)
     .forEach(documentModel ->
         System.out.printf("Classifier ID: %s, Classifier description: %s, Created on: %s.%n",
             documentModel.getClassifierId(),
             documentModel.getDescription(),
             documentModel.getCreatedOn())
     );

Parameters:

Returns:

public PagedIterable listDocumentModels()

List information for each model on the Form Recognizer account that were built successfully.

Code sample

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

Returns:

public PagedIterable listDocumentModels(Context context)

List information for each model on the Form Recognizer account that were built successfully with a Http response and a specified Context.

Code sample

documentModelAdministrationClient.listDocumentModels(Context.NONE)
     .forEach(documentModel ->
         System.out.printf("Model ID: %s, Model description: %s, Created on: %s.%n",
             documentModel.getModelId(),
             documentModel.getDescription(),
             documentModel.getCreatedOn())
     );

Parameters:

Returns:

public PagedIterable listOperations()

List information for each model operation on the Form Recognizer account in the past 24 hours.

Code sample

PagedIterable<OperationSummary>
     modelOperationInfo = documentModelAdministrationClient.listOperations();
 modelOperationInfo.forEach(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:

public PagedIterable listOperations(Context context)

List information for each operation on the Form Recognizer account in the past 24 hours with an HTTP response and a specified Context.

Code sample

PagedIterable<OperationSummary>
     modelOperationInfo = documentModelAdministrationClient.listOperations(Context.NONE);
 modelOperationInfo.forEach(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());
 });

Parameters:

Returns: