VectorStoreFileOutput interface
Description of a file attached to a vector store.
Properties
| chunking |
The strategy used to chunk the file. |
| created |
The Unix timestamp (in seconds) for when the vector store file was created. |
| id | The identifier, which can be referenced in API endpoints. |
| last |
The last error associated with this vector store file. Will be |
| object | The object type, which is always |
| status | The status of the vector store file, which can be either Possible values: "in_progress", "completed", "failed", "cancelled" |
| usage |
The total vector store usage in bytes. Note that this may be different from the original file size. |
| vector |
The ID of the vector store that the file is attached to. |
Property Details
chunkingStrategy
The strategy used to chunk the file.
chunkingStrategy: VectorStoreChunkingStrategyResponseOutputProperty Value
createdAt
The Unix timestamp (in seconds) for when the vector store file was created.
createdAt: DateProperty Value
Date
id
The identifier, which can be referenced in API endpoints.
id: stringProperty Value
string
lastError
The last error associated with this vector store file. Will be null if there are no errors.
lastError: null | VectorStoreFileErrorOutputProperty Value
null | VectorStoreFileErrorOutput
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.
Possible values: "in_progress", "completed", "failed", "cancelled"
status: stringProperty Value
string
usageBytes
The total vector store usage in bytes. Note that this may be different from the original file size.
usageBytes: numberProperty Value
number
vectorStoreId
The ID of the vector store that the file is attached to.
vectorStoreId: stringProperty Value
string
