REST: Retrieve vector store
Retrieves a vector store.
HTTP request
GET https://ai.api.cloud.yandex.net/v1/vector_stores/{vector_store_id}
Path parameters
|
Field |
Description |
|
vector_store_id |
string Required field. The ID of the vector store to retrieve. |
Response
HTTP Code: 200
OK
Response schema: application/json
{
"id": "string",
"object": "string",
"created_at": "integer",
"name": "string",
"usage_bytes": "integer",
"file_counts": {
"in_progress": "integer",
"completed": "integer",
"failed": "integer",
"cancelled": "integer",
"total": "integer"
},
"status": "string",
"expires_after": {
"anchor": "string",
"days": "integer"
},
"expires_at": "unknown",
"last_active_at": "unknown",
"metadata": "unknown"
}
A vector store is a collection of processed files can be used by the file_search tool.
|
Field |
Description |
|
id |
string Required field. The identifier, which can be referenced in API endpoints. |
|
object |
enum Required field. The object type, which is always
|
|
created_at |
integer Required field. The Unix timestamp (in seconds) for when the vector store was created. |
|
name |
string Required field. The name of the vector store. |
|
usage_bytes |
integer Required field. The total number of bytes used by the files in the vector store. |
|
file_counts |
Required field. |
|
status |
enum Required field. The status of the vector store, which can be either
|
|
expires_after |
Required field. The expiration policy for a vector store. |
|
expires_at |
Any of integer | null |
|
last_active_at |
Any of integer | null |
|
metadata |
Any of object (map<string, string>) | null |
FileCounts
|
Field |
Description |
|
in_progress |
integer Required field. The number of files that are currently being processed. |
|
completed |
integer Required field. The number of files that have been successfully processed. |
|
failed |
integer Required field. The number of files that have failed to process. |
|
cancelled |
integer Required field. The number of files that were cancelled. |
|
total |
integer Required field. The total number of files. |
VectorStoreExpirationAfter
The expiration policy for a vector store.
|
Field |
Description |
|
anchor |
enum Required field. Anchor timestamp after which the expiration policy applies.
|
|
days |
integer Required field. The number of days after the anchor time that the vector store will expire. |