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{
"object": "list",
"data": [
{
"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
}
],
"first_id": "<string>",
"last_id": "<string>",
"has_more": true
}Returns a list of vector stores.
A valid request URL is required to generate request examples{
"object": "list",
"data": [
{
"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
}
],
"first_id": "<string>",
"last_id": "<string>",
"has_more": true
}Authorizations
Query Parameters
The explicit Azure AI Foundry Models API version to use for this request.
v1 if not otherwise specified.
v1, preview A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
Sort order by the created_at timestamp of the objects. asc for ascending order anddesc
for descending order.
asc, desc A cursor for use in pagination. after is an object ID that defines your place in the list.
For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
subsequent call can include after=obj_foo in order to fetch the next page of the list.
A cursor for use in pagination. before is an object ID that defines your place in the list.
For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
subsequent call can include before=obj_foo in order to fetch the previous page of the list.