次の方法で共有

VectorStoreFile 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.VectorStoreFile

Implements

JsonSerializable<VectorStoreFile>

public final class VectorStoreFile
implements JsonSerializable<VectorStoreFile>

Description of a file attached to a vector store.

Method Summary

Modifier and Type Method and Description
static VectorStoreFile fromJson(JsonReader jsonReader)

Reads an instance of VectorStoreFile from the JsonReader.
VectorStoreChunkingStrategyResponse getChunkingStrategy()

Get the chunkingStrategy property: The strategy used to chunk the file.
OffsetDateTime getCreatedAt()

Get the createdAt property: The Unix timestamp (in seconds) for when the vector store file was created.
String getId()

Get the id property: The identifier, which can be referenced in API endpoints.
VectorStoreFileError getLastError()

Get the lastError property: The last error associated with this vector store file.
String getObject()

Get the object property: The object type, which is always `vector_store.file`.
VectorStoreFileStatus getStatus()

Get the status property: The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`.
int getUsageBytes()

Get the usageBytes property: The total vector store usage in bytes.
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 VectorStoreFile fromJson(JsonReader jsonReader)

Reads an instance of VectorStoreFile from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of VectorStoreFile 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.

getChunkingStrategy

public VectorStoreChunkingStrategyResponse getChunkingStrategy()

Get the chunkingStrategy property: The strategy used to chunk the file.

Returns:

the chunkingStrategy value.

getCreatedAt

public OffsetDateTime getCreatedAt()

Get the createdAt property: The Unix timestamp (in seconds) for when the vector store file was created.

Returns:

the createdAt value.

getId

public String getId()

Get the id property: The identifier, which can be referenced in API endpoints.

Returns:

the id value.

getLastError

public VectorStoreFileError getLastError()

Get the lastError property: The last error associated with this vector store file. Will be `null` if there are no errors.

Returns:

the lastError value.

getObject

public String getObject()

Get the object property: The object type, which is always `vector_store.file`.

Returns:

the object value.

getStatus

public VectorStoreFileStatus getStatus()

Get the status property: The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`. The status `completed` indicates that the vector store file is ready for use.

Returns:

the status value.

getUsageBytes

public int getUsageBytes()

Get the usageBytes property: The total vector store usage in bytes. Note that this may be different from the original file size.

Returns:

the usageBytes 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