Azure OpenAI APIs
- GETReturns a list of vector stores.
- POSTCreates a vector store.
- GETRetrieves a vector store.
- POSTModifies a vector store.
- DELDelete a vector store.
- POSTCreate a vector store file batch.
- GETRetrieves a vector store file batch.
- POSTCancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.
- GETReturns a list of vector store files in a batch.
- GETReturns a list of vector store files.
- POSTCreate a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).
- GETRetrieves a vector store file.
- POSTPost vector stores files
- DELDelete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the [delete file](/docs/api-reference/files/delete) endpoint.
A valid request URL is required to generate request examples{
"id": "<string>",
"object": "vector_store",
"created_at": 123,
"name": "<string>",
"usage_bytes": 123,
"file_counts": {
"in_progress": 123,
"completed": 123,
"failed": 123,
"cancelled": 123,
"total": 123
},
"status": "expired",
"last_active_at": 123,
"metadata": {},
"expires_at": 123
}Modifies a vector store.
A valid request URL is required to generate request examples{
"id": "<string>",
"object": "vector_store",
"created_at": 123,
"name": "<string>",
"usage_bytes": 123,
"file_counts": {
"in_progress": 123,
"completed": 123,
"failed": 123,
"cancelled": 123,
"total": 123
},
"status": "expired",
"last_active_at": 123,
"metadata": {},
"expires_at": 123
}Authorizations
Path Parameters
The ID of the vector store to modify.
Query Parameters
The explicit Azure AI Foundry Models API version to use for this request.
v1 if not otherwise specified.
v1, preview Body
The name of the vector store.
The expiration policy for a vector store.
Show child attributes
Show child attributes
Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.
Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
Show child attributes
Show child attributes
Response
The request has succeeded.
A vector store is a collection of processed files can be used by the file_search tool.
The identifier, which can be referenced in API endpoints.
The object type, which is always vector_store.
vector_store The Unix timestamp (in seconds) for when the vector store was created.
The name of the vector store.
The total number of bytes used by the files in the vector store.
Show child attributes
Show child attributes
The status of the vector store, which can be either expired, in_progress, or completed. A status of completed indicates that the vector store is ready for use.
expired, in_progress, completed The Unix timestamp (in seconds) for when the vector store was last active.
Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.
Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
Show child attributes
Show child attributes
The expiration policy for a vector store.
Show child attributes
Show child attributes
The Unix timestamp (in seconds) for when the vector store will expire.