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.file",
"usage_bytes": 123,
"created_at": 123,
"vector_store_id": "<string>",
"status": "in_progress",
"last_error": {
"code": "server_error",
"message": "<string>"
},
"attributes": {}
}Retrieves a vector store file.
A valid request URL is required to generate request examples{
"id": "<string>",
"object": "vector_store.file",
"usage_bytes": 123,
"created_at": 123,
"vector_store_id": "<string>",
"status": "in_progress",
"last_error": {
"code": "server_error",
"message": "<string>"
},
"attributes": {}
}Authorizations
Path Parameters
The ID of the vector store that the file belongs to.
The ID of the file being retrieved.
Query Parameters
The explicit Azure AI Foundry Models API version to use for this request.
v1 if not otherwise specified.
v1, preview Response
The request has succeeded.
A list of files attached to a vector store.
The identifier, which can be referenced in API endpoints.
The object type, which is always vector_store.file.
vector_store.file The total vector store usage in bytes. Note that this may be different from the original file size.
The Unix timestamp (in seconds) for when the vector store file was created.
The ID of the vector store that the File is attached to.
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.
in_progress, completed, cancelled, failed The last error associated with this vector store file. Will be null if there are no errors.
Show child attributes
Show child attributes
The strategy used to chunk the file.
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, booleans, or numbers.
Show child attributes
Show child attributes