Package com.azure.ai.documentintelligence

Class DocumentIntelligenceAdministrationClient

java.lang.Object
com.azure.ai.documentintelligence.DocumentIntelligenceAdministrationClient
public final class DocumentIntelligenceAdministrationClient extends Object
Initializes a new instance of the synchronous DocumentIntelligenceAdministrationClient type.

  • Method Details

    • beginBuildDocumentModel

      public com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginBuildDocumentModel(com.azure.core.util.BinaryData buildRequest, com.azure.core.http.rest.RequestOptions requestOptions)
      Builds a custom document analysis model.

      Request Body Schema

      
 {
     modelId: String (Required)
     description: String (Optional)
     buildMode: String(template/neural/generative) (Required)
     azureBlobSource (Optional): {
         containerUrl: String (Required)
         prefix: String (Optional)
     }
     azureBlobFileListSource (Optional): {
         containerUrl: String (Required)
         fileList: String (Required)
     }
     tags (Optional): {
         String: String (Required)
     }
     maxTrainingHours: Double (Optional)
     allowOverwrite: Boolean (Optional)
 }
      Parameters:
      buildRequest - Build request parameters.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the SyncPoller for polling of long-running operation.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • beginComposeModel

      public com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginComposeModel(com.azure.core.util.BinaryData composeRequest, com.azure.core.http.rest.RequestOptions requestOptions)
      Creates a new document model from document types of existing document models.

      Request Body Schema

      
 {
     modelId: String (Required)
     description: String (Optional)
     classifierId: String (Required)
     split: String(auto/none/perPage) (Optional)
     docTypes (Required): {
         String (Required): {
             description: String (Optional)
             buildMode: String(template/neural/generative) (Optional)
             fieldSchema (Optional): {
                 String (Required): {
                     type: String(string/date/time/phoneNumber/number/integer/selectionMark/countryRegion/signature/array/object/currency/address/boolean/selectionGroup) (Required)
                     description: String (Optional)
                     example: String (Optional)
                     items (Optional): (recursive schema, see items above)
                     properties (Optional): {
                         String (Required): (recursive schema, see String above)
                     }
                 }
             }
             fieldConfidence (Optional): {
                 String: double (Required)
             }
             modelId: String (Optional)
             confidenceThreshold: Double (Optional)
             features (Optional): [
                 String(ocrHighResolution/languages/barcodes/formulas/keyValuePairs/styleFont/queryFields) (Optional)
             ]
             queryFields (Optional): [
                 String (Optional)
             ]
             maxDocumentsToAnalyze: Integer (Optional)
         }
     }
     tags (Optional): {
         String: String (Required)
     }
 }
      Parameters:
      composeRequest - Compose request parameters.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the SyncPoller for polling of long-running operation.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • authorizeModelCopyWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> authorizeModelCopyWithResponse(com.azure.core.util.BinaryData authorizeCopyRequest, com.azure.core.http.rest.RequestOptions requestOptions)
      Generates authorization to copy a document model to this location with specified modelId and optional description.

      Request Body Schema

      
 {
     modelId: String (Required)
     description: String (Optional)
     tags (Optional): {
         String: String (Required)
     }
 }

      Response Body Schema

      
 {
     targetResourceId: String (Required)
     targetResourceRegion: String (Required)
     targetModelId: String (Required)
     targetModelLocation: String (Required)
     accessToken: String (Required)
     expirationDateTime: OffsetDateTime (Required)
 }
      Parameters:
      authorizeCopyRequest - Authorize copy request parameters.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      authorization to copy a document model to the specified target resource and modelId along with Response.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • beginCopyModelTo

      public com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginCopyModelTo(String modelId, com.azure.core.util.BinaryData copyToRequest, com.azure.core.http.rest.RequestOptions requestOptions)
      Copies document model to the target resource, region, and modelId.

      Request Body Schema

      
 {
     targetResourceId: String (Required)
     targetResourceRegion: String (Required)
     targetModelId: String (Required)
     targetModelLocation: String (Required)
     accessToken: String (Required)
     expirationDateTime: OffsetDateTime (Required)
 }
      Parameters:
      modelId - Unique document model name.
      copyToRequest - Copy to request parameters.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the SyncPoller for polling of long-running operation.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • getModelWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getModelWithResponse(String modelId, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets detailed document model information.

      Response Body Schema

      
 {
     modelId: String (Required)
     description: String (Optional)
     createdDateTime: OffsetDateTime (Required)
     expirationDateTime: OffsetDateTime (Optional)
     apiVersion: String (Optional)
     tags (Optional): {
         String: String (Required)
     }
     buildMode: String(template/neural/generative) (Optional)
     azureBlobSource (Optional): {
         containerUrl: String (Required)
         prefix: String (Optional)
     }
     azureBlobFileListSource (Optional): {
         containerUrl: String (Required)
         fileList: String (Required)
     }
     classifierId: String (Optional)
     split: String(auto/none/perPage) (Optional)
     docTypes (Optional): {
         String (Required): {
             description: String (Optional)
             buildMode: String(template/neural/generative) (Optional)
             fieldSchema (Optional): {
                 String (Required): {
                     type: String(string/date/time/phoneNumber/number/integer/selectionMark/countryRegion/signature/array/object/currency/address/boolean/selectionGroup) (Required)
                     description: String (Optional)
                     example: String (Optional)
                     items (Optional): (recursive schema, see items above)
                     properties (Optional): {
                         String (Required): (recursive schema, see String above)
                     }
                 }
             }
             fieldConfidence (Optional): {
                 String: double (Required)
             }
             modelId: String (Optional)
             confidenceThreshold: Double (Optional)
             features (Optional): [
                 String(ocrHighResolution/languages/barcodes/formulas/keyValuePairs/styleFont/queryFields) (Optional)
             ]
             queryFields (Optional): [
                 String (Optional)
             ]
             maxDocumentsToAnalyze: Integer (Optional)
         }
     }
     warnings (Optional): [
          (Optional){
             code: String (Required)
             message: String (Required)
             target: String (Optional)
         }
     ]
     trainingHours: Double (Optional)
 }
      Parameters:
      modelId - Unique document model name.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      detailed document model information along with Response.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • listModels

      public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listModels(com.azure.core.http.rest.RequestOptions requestOptions)
      List all document models.

      Response Body Schema

      
 {
     modelId: String (Required)
     description: String (Optional)
     createdDateTime: OffsetDateTime (Required)
     expirationDateTime: OffsetDateTime (Optional)
     apiVersion: String (Optional)
     tags (Optional): {
         String: String (Required)
     }
     buildMode: String(template/neural/generative) (Optional)
     azureBlobSource (Optional): {
         containerUrl: String (Required)
         prefix: String (Optional)
     }
     azureBlobFileListSource (Optional): {
         containerUrl: String (Required)
         fileList: String (Required)
     }
     classifierId: String (Optional)
     split: String(auto/none/perPage) (Optional)
     docTypes (Optional): {
         String (Required): {
             description: String (Optional)
             buildMode: String(template/neural/generative) (Optional)
             fieldSchema (Optional): {
                 String (Required): {
                     type: String(string/date/time/phoneNumber/number/integer/selectionMark/countryRegion/signature/array/object/currency/address/boolean/selectionGroup) (Required)
                     description: String (Optional)
                     example: String (Optional)
                     items (Optional): (recursive schema, see items above)
                     properties (Optional): {
                         String (Required): (recursive schema, see String above)
                     }
                 }
             }
             fieldConfidence (Optional): {
                 String: double (Required)
             }
             modelId: String (Optional)
             confidenceThreshold: Double (Optional)
             features (Optional): [
                 String(ocrHighResolution/languages/barcodes/formulas/keyValuePairs/styleFont/queryFields) (Optional)
             ]
             queryFields (Optional): [
                 String (Optional)
             ]
             maxDocumentsToAnalyze: Integer (Optional)
         }
     }
     warnings (Optional): [
          (Optional){
             code: String (Required)
             message: String (Required)
             target: String (Optional)
         }
     ]
     trainingHours: Double (Optional)
 }
      Parameters:
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      paged collection of DocumentModelDetails items as paginated response with PagedIterable.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • deleteModelWithResponse

      public com.azure.core.http.rest.Response<Void> deleteModelWithResponse(String modelId, com.azure.core.http.rest.RequestOptions requestOptions)
      Deletes document model.
      Parameters:
      modelId - Unique document model name.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • getResourceInfoWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getResourceInfoWithResponse(com.azure.core.http.rest.RequestOptions requestOptions)
      Return information about the current resource.

      Response Body Schema

      
 {
     customDocumentModels (Required): {
         count: int (Required)
         limit: int (Required)
     }
 }
      Parameters:
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      general information regarding the current resource along with Response.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • getOperationWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getOperationWithResponse(String operationId, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets operation info.

      Response Body Schema

      
 {
     kind: String(documentModelBuild/documentModelCompose/documentModelCopyTo/documentClassifierCopyTo/documentClassifierBuild) (Required)
     operationId: String (Required)
     status: String(notStarted/running/failed/succeeded/completed/canceled) (Required)
     percentCompleted: Integer (Optional)
     createdDateTime: OffsetDateTime (Required)
     lastUpdatedDateTime: OffsetDateTime (Required)
     resourceLocation: String (Required)
     apiVersion: String (Optional)
     tags (Optional): {
         String: String (Required)
     }
     error (Optional): {
         code: String (Required)
         message: String (Required)
         target: String (Optional)
         details (Optional): [
             (recursive schema, see above)
         ]
         innererror (Optional): {
             code: String (Optional)
             message: String (Optional)
             innererror (Optional): (recursive schema, see innererror above)
         }
     }
 }
      Parameters:
      operationId - Operation ID.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      operation info along with Response.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • listOperations

      public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listOperations(com.azure.core.http.rest.RequestOptions requestOptions)
      Lists all operations.

      Response Body Schema

      
 {
     kind: String(documentModelBuild/documentModelCompose/documentModelCopyTo/documentClassifierCopyTo/documentClassifierBuild) (Required)
     operationId: String (Required)
     status: String(notStarted/running/failed/succeeded/completed/canceled) (Required)
     percentCompleted: Integer (Optional)
     createdDateTime: OffsetDateTime (Required)
     lastUpdatedDateTime: OffsetDateTime (Required)
     resourceLocation: String (Required)
     apiVersion: String (Optional)
     tags (Optional): {
         String: String (Required)
     }
     error (Optional): {
         code: String (Required)
         message: String (Required)
         target: String (Optional)
         details (Optional): [
             (recursive schema, see above)
         ]
         innererror (Optional): {
             code: String (Optional)
             message: String (Optional)
             innererror (Optional): (recursive schema, see innererror above)
         }
     }
 }
      Parameters:
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      paged collection of OperationDetails items as paginated response with PagedIterable.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • beginBuildClassifier

      public com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginBuildClassifier(com.azure.core.util.BinaryData buildRequest, com.azure.core.http.rest.RequestOptions requestOptions)
      Builds a custom document classifier.

      Request Body Schema

      
 {
     classifierId: String (Required)
     description: String (Optional)
     baseClassifierId: String (Optional)
     docTypes (Required): {
         String (Required): {
             sourceKind: String(url/base64/azureBlob/azureBlobFileList) (Optional)
             azureBlobSource (Optional): {
                 containerUrl: String (Required)
                 prefix: String (Optional)
             }
             azureBlobFileListSource (Optional): {
                 containerUrl: String (Required)
                 fileList: String (Required)
             }
         }
     }
     allowOverwrite: Boolean (Optional)
 }
      Parameters:
      buildRequest - Build request parameters.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the SyncPoller for polling of long-running operation.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • authorizeClassifierCopyWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> authorizeClassifierCopyWithResponse(com.azure.core.util.BinaryData authorizeCopyRequest, com.azure.core.http.rest.RequestOptions requestOptions)
      Generates authorization to copy a document classifier to this location with specified classifierId and optional description.

      Request Body Schema

      
 {
     classifierId: String (Required)
     description: String (Optional)
     tags (Optional): {
         String: String (Required)
     }
 }

      Response Body Schema

      
 {
     targetResourceId: String (Required)
     targetResourceRegion: String (Required)
     targetClassifierId: String (Required)
     targetClassifierLocation: String (Required)
     accessToken: String (Required)
     expirationDateTime: OffsetDateTime (Required)
 }
      Parameters:
      authorizeCopyRequest - Authorize copy request parameters.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      authorization to copy a document classifier to the specified target resource and classifierId along with Response.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • beginCopyClassifierTo

      public com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginCopyClassifierTo(String classifierId, com.azure.core.util.BinaryData copyToRequest, com.azure.core.http.rest.RequestOptions requestOptions)
      Copies document classifier to the target resource, region, and classifierId.

      Request Body Schema

      
 {
     targetResourceId: String (Required)
     targetResourceRegion: String (Required)
     targetClassifierId: String (Required)
     targetClassifierLocation: String (Required)
     accessToken: String (Required)
     expirationDateTime: OffsetDateTime (Required)
 }
      Parameters:
      classifierId - Unique document classifier name.
      copyToRequest - Copy to request parameters.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the SyncPoller for polling of long-running operation.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • getClassifierWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getClassifierWithResponse(String classifierId, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets detailed document classifier information.

      Response Body Schema

      
 {
     classifierId: String (Required)
     description: String (Optional)
     createdDateTime: OffsetDateTime (Required)
     expirationDateTime: OffsetDateTime (Optional)
     apiVersion: String (Required)
     baseClassifierId: String (Optional)
     docTypes (Required): {
         String (Required): {
             sourceKind: String(url/base64/azureBlob/azureBlobFileList) (Optional)
             azureBlobSource (Optional): {
                 containerUrl: String (Required)
                 prefix: String (Optional)
             }
             azureBlobFileListSource (Optional): {
                 containerUrl: String (Required)
                 fileList: String (Required)
             }
         }
     }
     warnings (Optional): [
          (Optional){
             code: String (Required)
             message: String (Required)
             target: String (Optional)
         }
     ]
 }
      Parameters:
      classifierId - Unique document classifier name.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      detailed document classifier information along with Response.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • listClassifiers

      public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listClassifiers(com.azure.core.http.rest.RequestOptions requestOptions)
      List all document classifiers.

      Response Body Schema

      
 {
     classifierId: String (Required)
     description: String (Optional)
     createdDateTime: OffsetDateTime (Required)
     expirationDateTime: OffsetDateTime (Optional)
     apiVersion: String (Required)
     baseClassifierId: String (Optional)
     docTypes (Required): {
         String (Required): {
             sourceKind: String(url/base64/azureBlob/azureBlobFileList) (Optional)
             azureBlobSource (Optional): {
                 containerUrl: String (Required)
                 prefix: String (Optional)
             }
             azureBlobFileListSource (Optional): {
                 containerUrl: String (Required)
                 fileList: String (Required)
             }
         }
     }
     warnings (Optional): [
          (Optional){
             code: String (Required)
             message: String (Required)
             target: String (Optional)
         }
     ]
 }
      Parameters:
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      paged collection of DocumentClassifierDetails items as paginated response with PagedIterable.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • deleteClassifierWithResponse

      public com.azure.core.http.rest.Response<Void> deleteClassifierWithResponse(String classifierId, com.azure.core.http.rest.RequestOptions requestOptions)
      Deletes document classifier.
      Parameters:
      classifierId - Unique document classifier name.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • beginBuildDocumentModel

      public com.azure.core.util.polling.SyncPoller<DocumentModelBuildOperationDetails,DocumentModelDetails> beginBuildDocumentModel(BuildDocumentModelRequest buildRequest)
      Builds a custom document analysis model.
      Parameters:
      buildRequest - Build request parameters.
      Returns:
      the SyncPoller for polling of long-running operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • beginComposeModel

      public com.azure.core.util.polling.SyncPoller<DocumentModelComposeOperationDetails,DocumentModelDetails> beginComposeModel(ComposeDocumentModelRequest composeRequest)
      Creates a new document model from document types of existing document models.
      Parameters:
      composeRequest - Compose request parameters.
      Returns:
      the SyncPoller for polling of long-running operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • authorizeModelCopy

      public CopyAuthorization authorizeModelCopy(AuthorizeCopyRequest authorizeCopyRequest)
      Generates authorization to copy a document model to this location with specified modelId and optional description.
      Parameters:
      authorizeCopyRequest - Authorize copy request parameters.
      Returns:
      authorization to copy a document model to the specified target resource and modelId.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • beginCopyModelTo

      public com.azure.core.util.polling.SyncPoller<DocumentModelCopyToOperationDetails,DocumentModelDetails> beginCopyModelTo(String modelId, CopyAuthorization copyToRequest)
      Copies document model to the target resource, region, and modelId.
      Parameters:
      modelId - Unique document model name.
      copyToRequest - Copy to request parameters.
      Returns:
      the SyncPoller for polling of long-running operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getModel

      public DocumentModelDetails getModel(String modelId)
      Gets detailed document model information.
      Parameters:
      modelId - Unique document model name.
      Returns:
      detailed document model information.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listModels

      public com.azure.core.http.rest.PagedIterable<DocumentModelDetails> listModels()
      List all document models.
      Returns:
      paged collection of DocumentModelDetails items as paginated response with PagedIterable.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteModel

      public void deleteModel(String modelId)
      Deletes document model.
      Parameters:
      modelId - Unique document model name.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getResourceInfo

      public ResourceDetails getResourceInfo()
      Return information about the current resource.
      Returns:
      general information regarding the current resource.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getOperation

      public OperationDetails getOperation(String operationId)
      Gets operation info.
      Parameters:
      operationId - Operation ID.
      Returns:
      operation info.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listOperations

      public com.azure.core.http.rest.PagedIterable<OperationDetails> listOperations()
      Lists all operations.
      Returns:
      paged collection of OperationDetails items as paginated response with PagedIterable.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • beginBuildClassifier

      public com.azure.core.util.polling.SyncPoller<DocumentClassifierBuildOperationDetails,DocumentClassifierDetails> beginBuildClassifier(BuildDocumentClassifierRequest buildRequest)
      Builds a custom document classifier.
      Parameters:
      buildRequest - Build request parameters.
      Returns:
      the SyncPoller for polling of long-running operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • authorizeClassifierCopy

      public ClassifierCopyAuthorization authorizeClassifierCopy(AuthorizeClassifierCopyRequest authorizeCopyRequest)
      Generates authorization to copy a document classifier to this location with specified classifierId and optional description.
      Parameters:
      authorizeCopyRequest - Authorize copy request parameters.
      Returns:
      authorization to copy a document classifier to the specified target resource and classifierId.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • beginCopyClassifierTo

      public com.azure.core.util.polling.SyncPoller<DocumentClassifierCopyToOperationDetails,DocumentClassifierDetails> beginCopyClassifierTo(String classifierId, ClassifierCopyAuthorization copyToRequest)
      Copies document classifier to the target resource, region, and classifierId.
      Parameters:
      classifierId - Unique document classifier name.
      copyToRequest - Copy to request parameters.
      Returns:
      the SyncPoller for polling of long-running operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getClassifier

      public DocumentClassifierDetails getClassifier(String classifierId)
      Gets detailed document classifier information.
      Parameters:
      classifierId - Unique document classifier name.
      Returns:
      detailed document classifier information.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listClassifiers

      public com.azure.core.http.rest.PagedIterable<DocumentClassifierDetails> listClassifiers()
      List all document classifiers.
      Returns:
      paged collection of DocumentClassifierDetails items as paginated response with PagedIterable.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteClassifier

      public void deleteClassifier(String classifierId)
      Deletes document classifier.
      Parameters:
      classifierId - Unique document classifier name.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.