Class VectorStoreFileCount

java.lang.Object
com.azure.ai.openai.assistants.models.VectorStoreFileCount
All Implemented Interfaces:
com.azure.json.JsonSerializable<VectorStoreFileCount>

public final class VectorStoreFileCount extends Object implements com.azure.json.JsonSerializable<VectorStoreFileCount>
Counts of files processed or being processed by this vector store grouped by status.
  • Method Summary

    Modifier and Type
    Method
    Description
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of VectorStoreFileCount from the JsonReader.
    int
    Get the cancelled property: The number of files that were cancelled.
    int
    Get the completed property: The number of files that have been successfully processed.
    int
    Get the failed property: The number of files that have failed to process.
    int
    Get the inProgress property: The number of files that are currently being processed.
    int
    Get the total property: The total number of files.
    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

    • getInProgress

      public int getInProgress()
      Get the inProgress property: The number of files that are currently being processed.
      Returns:
      the inProgress value.
    • getCompleted

      public int getCompleted()
      Get the completed property: The number of files that have been successfully processed.
      Returns:
      the completed value.
    • getFailed

      public int getFailed()
      Get the failed property: The number of files that have failed to process.
      Returns:
      the failed value.
    • getCancelled

      public int getCancelled()
      Get the cancelled property: The number of files that were cancelled.
      Returns:
      the cancelled value.
    • getTotal

      public int getTotal()
      Get the total property: The total number of files.
      Returns:
      the total value.
    • toJson

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

      public static VectorStoreFileCount fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of VectorStoreFileCount from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of VectorStoreFileCount 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 VectorStoreFileCount.