Package com.azure.ai.agents.persistent.models

Class VectorStoreFileBatch

java.lang.Object
com.azure.ai.agents.persistent.models.VectorStoreFileBatch
All Implemented Interfaces:
com.azure.json.JsonSerializable<VectorStoreFileBatch>
public final class VectorStoreFileBatch extends Object implements com.azure.json.JsonSerializable<VectorStoreFileBatch>
A batch of files attached to a vector store.

  • Method Summary

    Modifier and Type
    Method
    Description
    static VectorStoreFileBatch
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of VectorStoreFileBatch from the JsonReader.
    OffsetDateTime
    getCreatedAt()
    Get the createdAt property: The Unix timestamp (in seconds) for when the vector store files batch was created.
    VectorStoreFileCount
    getFileCounts()
    Get the fileCounts property: Files count grouped by status processed or being processed by this vector store.
    String
    getId()
    Get the id property: The identifier, which can be referenced in API endpoints.
    String
    getObject()
    Get the object property: The object type, which is always `vector_store.file_batch`.
    VectorStoreFileBatchStatus
    getStatus()
    Get the status property: The status of the vector store files batch, which can be either `in_progress`, `completed`, `cancelled` or `failed`.
    String
    getVectorStoreId()
    Get the vectorStoreId property: The ID of the vector store that the file is attached to.
    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

    • getId

      public String getId()
      Get the id property: The identifier, which can be referenced in API endpoints.
      Returns:
      the id value.

    • getObject

      public String getObject()
      Get the object property: The object type, which is always `vector_store.file_batch`.
      Returns:
      the object value.

    • getCreatedAt

      public OffsetDateTime getCreatedAt()
      Get the createdAt property: The Unix timestamp (in seconds) for when the vector store files batch was created.
      Returns:
      the createdAt value.

    • getVectorStoreId

      public String getVectorStoreId()
      Get the vectorStoreId property: The ID of the vector store that the file is attached to.
      Returns:
      the vectorStoreId value.

    • getStatus

      public VectorStoreFileBatchStatus getStatus()
      Get the status property: The status of the vector store files batch, which can be either `in_progress`, `completed`, `cancelled` or `failed`.
      Returns:
      the status value.

    • getFileCounts

      public VectorStoreFileCount getFileCounts()
      Get the fileCounts property: Files count grouped by status processed or being processed by this vector store.
      Returns:
      the fileCounts value.

    • toJson

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

    • fromJson

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