Package com.azure.ai.documentintelligence

Class DocumentIntelligenceClient

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

  • Method Details

    • getAnalyzeResultPdfWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getAnalyzeResultPdfWithResponse(String modelId, String resultId, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets the generated searchable PDF output from document analysis.

      Response Body Schema

       
 BinaryData
      Parameters:
      modelId - Unique document model name.
      resultId - Analyze operation result ID.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the generated searchable PDF output from document analysis 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.

    • getAnalyzeResultFigureWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getAnalyzeResultFigureWithResponse(String modelId, String resultId, String figureId, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets the generated cropped image of specified figure from document analysis.

      Response Body Schema

       
 BinaryData
      Parameters:
      modelId - Unique document model name.
      resultId - Analyze operation result ID.
      figureId - Figure ID.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the generated cropped image of specified figure from document analysis 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.

    • deleteAnalyzeResultWithResponse

      public com.azure.core.http.rest.Response<Void> deleteAnalyzeResultWithResponse(String modelId, String resultId, com.azure.core.http.rest.RequestOptions requestOptions)
      Mark the result of document analysis for deletion.
      Parameters:
      modelId - Unique document model name.
      resultId - Analyze operation result ID.
      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.

    • listAnalyzeBatchResults

      public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listAnalyzeBatchResults(String modelId, com.azure.core.http.rest.RequestOptions requestOptions)
      List batch document analysis results.

      Response Body Schema

       
 {
     resultId: String (Optional)
     status: String(notStarted/running/failed/succeeded/canceled/skipped) (Required)
     createdDateTime: OffsetDateTime (Required)
     lastUpdatedDateTime: OffsetDateTime (Required)
     percentCompleted: Integer (Optional)
     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)
         }
     }
     result (Optional): {
         succeededCount: int (Required)
         failedCount: int (Required)
         skippedCount: int (Required)
         details (Optional): [
              (Optional){
                 status: String(notStarted/running/failed/succeeded/canceled/skipped) (Required)
                 sourceUrl: String (Required)
                 resultUrl: String (Optional)
                 error (Optional): (recursive schema, see error above)
             }
         ]
     }
 }
      Parameters:
      modelId - Unique document model name.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      paged collection of AnalyzeBatchOperation 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.

    • deleteAnalyzeBatchResultWithResponse

      public com.azure.core.http.rest.Response<Void> deleteAnalyzeBatchResultWithResponse(String modelId, String resultId, com.azure.core.http.rest.RequestOptions requestOptions)
      Mark the batch document analysis result for deletion.
      Parameters:
      modelId - Unique document model name.
      resultId - Analyze batch operation result ID.
      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.

    • getAnalyzeBatchResultWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getAnalyzeBatchResultWithResponse(String modelId, String resultId, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets the result of batch document analysis.

      Response Body Schema

       
 {
     resultId: String (Optional)
     status: String(notStarted/running/failed/succeeded/canceled/skipped) (Required)
     createdDateTime: OffsetDateTime (Required)
     lastUpdatedDateTime: OffsetDateTime (Required)
     percentCompleted: Integer (Optional)
     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)
         }
     }
     result (Optional): {
         succeededCount: int (Required)
         failedCount: int (Required)
         skippedCount: int (Required)
         details (Optional): [
              (Optional){
                 status: String(notStarted/running/failed/succeeded/canceled/skipped) (Required)
                 sourceUrl: String (Required)
                 resultUrl: String (Optional)
                 error (Optional): (recursive schema, see error above)
             }
         ]
     }
 }
      Parameters:
      modelId - Unique document model name.
      resultId - Analyze batch operation result ID.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the result of batch document analysis 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.

    • beginClassifyDocument

      public com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginClassifyDocument(String classifierId, com.azure.core.util.BinaryData classifyRequest, com.azure.core.http.rest.RequestOptions requestOptions)
      Classifies document with document classifier.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      stringIndexTypeStringNoMethod used to compute string offset and length. Allowed values: "textElements", "unicodeCodePoint", "utf16CodeUnit".
      splitStringNoDocument splitting mode. Allowed values: "auto", "none", "perPage".
      pagesStringNo1-based page numbers to analyze. Ex. "1-3,5,7-9"
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     urlSource: String (Optional)
     base64Source: byte[] (Optional)
 }
      Parameters:
      classifierId - Unique document classifier name.
      classifyRequest - Classify 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.

    • getAnalyzeResultPdf

      public com.azure.core.util.BinaryData getAnalyzeResultPdf(String modelId, String resultId)
      Gets the generated searchable PDF output from document analysis.
      Parameters:
      modelId - Unique document model name.
      resultId - Analyze operation result ID.
      Returns:
      the generated searchable PDF output from document analysis.
      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.

    • getAnalyzeResultFigure

      public com.azure.core.util.BinaryData getAnalyzeResultFigure(String modelId, String resultId, String figureId)
      Gets the generated cropped image of specified figure from document analysis.
      Parameters:
      modelId - Unique document model name.
      resultId - Analyze operation result ID.
      figureId - Figure ID.
      Returns:
      the generated cropped image of specified figure from document analysis.
      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.

    • deleteAnalyzeResult

      public void deleteAnalyzeResult(String modelId, String resultId)
      Mark the result of document analysis for deletion.
      Parameters:
      modelId - Unique document model name.
      resultId - Analyze operation result ID.
      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.

    • listAnalyzeBatchResults

      public com.azure.core.http.rest.PagedIterable<AnalyzeBatchOperationDetails> listAnalyzeBatchResults(String modelId)
      List batch document analysis results.
      Parameters:
      modelId - Unique document model name.
      Returns:
      paged collection of AnalyzeBatchOperation items as paginated response with PagedIterable.
      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.

    • deleteAnalyzeBatchResult

      public void deleteAnalyzeBatchResult(String modelId, String resultId)
      Mark the batch document analysis result for deletion.
      Parameters:
      modelId - Unique document model name.
      resultId - Analyze batch operation result ID.
      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.

    • getAnalyzeBatchResult

      public AnalyzeBatchOperationDetails getAnalyzeBatchResult(String modelId, String resultId)
      Gets the result of batch document analysis.
      Parameters:
      modelId - Unique document model name.
      resultId - Analyze batch operation result ID.
      Returns:
      the result of batch document analysis.
      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.

    • beginClassifyDocument

      public com.azure.core.util.polling.SyncPoller<AnalyzeOperationDetails,AnalyzeResult> beginClassifyDocument(String classifierId, ClassifyDocumentOptions classifyDocumentOptions)
      /** Classifies document with document classifier.
      Parameters:
      classifierId - Unique document classifier name.
      classifyDocumentOptions - Classify 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.

    • beginAnalyzeDocument

      public com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginAnalyzeDocument(String modelId, com.azure.core.util.BinaryData analyzeRequest, com.azure.core.http.rest.RequestOptions requestOptions)
      Analyzes document with document model.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      pagesStringNo1-based page numbers to analyze. Ex. "1-3,5,7-9"
      localeStringNoLocale hint for text recognition and document analysis. Value may contain only the language code (ex. "en", "fr") or BCP 47 language tag (ex. "en-US").
      stringIndexTypeStringNoMethod used to compute string offset and length. Allowed values: "textElements", "unicodeCodePoint", "utf16CodeUnit".
      featuresList<String>NoList of optional analysis features. In the form of "," separated string.
      queryFieldsList<String>NoList of additional fields to extract. Ex. "NumberOfGuests,StoreNumber". In the form of "," separated string.
      outputContentFormatStringNoFormat of the analyze result top-level content. Allowed values: "text", "markdown".
      outputList<String>NoAdditional outputs to generate during analysis. In the form of "," separated string.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     urlSource: String (Optional)
     base64Source: byte[] (Optional)
 }
      Parameters:
      modelId - Unique document model name.
      analyzeRequest - Analyze 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.

    • beginAnalyzeBatchDocuments

      public com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginAnalyzeBatchDocuments(String modelId, com.azure.core.util.BinaryData analyzeBatchRequest, com.azure.core.http.rest.RequestOptions requestOptions)
      Analyzes batch documents with document model.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      pagesStringNo1-based page numbers to analyze. Ex. "1-3,5,7-9"
      localeStringNoLocale hint for text recognition and document analysis. Value may contain only the language code (ex. "en", "fr") or BCP 47 language tag (ex. "en-US").
      stringIndexTypeStringNoMethod used to compute string offset and length. Allowed values: "textElements", "unicodeCodePoint", "utf16CodeUnit".
      featuresList<String>NoList of optional analysis features. In the form of "," separated string.
      queryFieldsList<String>NoList of additional fields to extract. Ex. "NumberOfGuests,StoreNumber". In the form of "," separated string.
      outputContentFormatStringNoFormat of the analyze result top-level content. Allowed values: "text", "markdown".
      outputList<String>NoAdditional outputs to generate during analysis. In the form of "," separated string.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     azureBlobSource (Optional): {
         containerUrl: String (Required)
         prefix: String (Optional)
     }
     azureBlobFileListSource (Optional): {
         containerUrl: String (Required)
         fileList: String (Required)
     }
     resultContainerUrl: String (Required)
     resultPrefix: String (Optional)
     overwriteExisting: Boolean (Optional)
 }
      Parameters:
      modelId - Unique document model name.
      analyzeBatchRequest - Analyze batch 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.

    • beginAnalyzeDocument

      public com.azure.core.util.polling.SyncPoller<AnalyzeOperationDetails,AnalyzeResult> beginAnalyzeDocument(String modelId, AnalyzeDocumentOptions analyzeDocumentOptions)
      /** Analyzes document with document model.
      Parameters:
      modelId - Unique document model name.
      analyzeDocumentOptions - Analyze 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.

    • beginAnalyzeBatchDocuments

      public com.azure.core.util.polling.SyncPoller<AnalyzeBatchOperationDetails,AnalyzeBatchResult> beginAnalyzeBatchDocuments(String modelId, AnalyzeBatchDocumentsOptions analyzeBatchDocumentOptions)
      /** Analyzes batch documents with document model.
      Parameters:
      modelId - Unique document model name.
      analyzeBatchDocumentOptions - Analyze batch 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.