VectorStoreFile interface

Package:

@azure/ai-agents

Description of a file attached to a vector store.

Properties

chunkingStrategy	The strategy used to chunk the file.
createdAt	The Unix timestamp (in seconds) for when the vector store file was created.
id	The identifier, which can be referenced in API endpoints.
lastError	The last error associated with this vector store file. Will be null if there are no errors.
object	The object type, which is always vector_store.file.
status	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.
usageBytes	The total vector store usage in bytes. Note that this may be different from the original file size.
vectorStoreId	The ID of the vector store that the file is attached to.

Property Details

chunkingStrategy

The strategy used to chunk the file.

chunkingStrategy: VectorStoreChunkingStrategyResponseUnion

Property Value

VectorStoreChunkingStrategyResponseUnion

createdAt

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

createdAt: Date

Property Value

Date

id

The identifier, which can be referenced in API endpoints.

id: string

Property Value

string

lastError

The last error associated with this vector store file. Will be null if there are no errors.

lastError: null | VectorStoreFileError

Property Value

null | VectorStoreFileError

object

The object type, which is always vector_store.file.

object: "vector_store.file"

Property Value

"vector_store.file"

status

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.

status: VectorStoreFileStatus

Property Value

VectorStoreFileStatus

usageBytes

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

usageBytes: number

Property Value

number

vectorStoreId

The ID of the vector store that the file is attached to.

vectorStoreId: string

Property Value

string