Package com.azure.ai.documentintelligence.models

Class AnalyzeBatchResult

java.lang.Object
com.azure.ai.documentintelligence.models.AnalyzeBatchResult
All Implemented Interfaces:
com.azure.json.JsonSerializable<AnalyzeBatchResult>
public final class AnalyzeBatchResult extends Object implements com.azure.json.JsonSerializable<AnalyzeBatchResult>
Batch document analysis result.

  • Method Summary

    Modifier and Type
    Method
    Description
    static AnalyzeBatchResult
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of AnalyzeBatchResult from the JsonReader.
    List<AnalyzeBatchResultDetails>
    getDetails()
    Get the details property: Operation detail for each document in the batch.
    int
    getFailedCount()
    Get the failedCount property: Number of documents that completed with status failed.
    int
    getSkippedCount()
    Get the skippedCount property: Number of documents that completed with status skipped.
    int
    getSucceededCount()
    Get the succeededCount property: Number of documents that completed with status succeeded.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Method Details

    • getSucceededCount

      public int getSucceededCount()
      Get the succeededCount property: Number of documents that completed with status succeeded.
      Returns:
      the succeededCount value.

    • getFailedCount

      public int getFailedCount()
      Get the failedCount property: Number of documents that completed with status failed.
      Returns:
      the failedCount value.

    • getSkippedCount

      public int getSkippedCount()
      Get the skippedCount property: Number of documents that completed with status skipped.
      Returns:
      the skippedCount value.

    • getDetails

      public List<AnalyzeBatchResultDetails> getDetails()
      Get the details property: Operation detail for each document in the batch.
      Returns:
      the details value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<AnalyzeBatchResult>
      Throws:
      IOException

    • fromJson

      public static AnalyzeBatchResult fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of AnalyzeBatchResult from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of AnalyzeBatchResult if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the AnalyzeBatchResult.