Share via

VectorStoreFileBatch Class

Package:
com.azure.ai.agents.persistent.models
Maven Artifact:
com.azure:azure-ai-agents-persistent:1.0.0-beta.2
  • java.lang.Object
    • com.azure.ai.agents.persistent.models.VectorStoreFileBatch

Implements

JsonSerializable<VectorStoreFileBatch>

public final class VectorStoreFileBatch
implements JsonSerializable<VectorStoreFileBatch>

A batch of files attached to a vector store.

Method Summary

Modifier and Type Method and Description
static VectorStoreFileBatch fromJson(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.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static VectorStoreFileBatch fromJson(JsonReader jsonReader)

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:

IOException

 - If the deserialized JSON object was missing any required properties.

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.

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.

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.

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.

getVectorStoreId

public String getVectorStoreId()

Get the vectorStoreId property: The ID of the vector store that the file is attached to.

Returns:

the vectorStoreId value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to