Vector Stores - Create Vector Store

Service:: AI Foundry

API Version:: v1

Creates a vector store.

POST {endpoint}/vector_stores?api-version=v1

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string (uri)	Project endpoint in the form of: https://<aiservices-id>.services.ai.azure.com/api/projects/<project-name>
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
chunking_strategy	VectorStoreChunkingStrategyRequest: VectorStoreAutoChunkingStrategyRequest VectorStoreStaticChunkingStrategyRequest	The chunking strategy used to chunk the file(s). If not set, will use the auto strategy. Only applicable if file_ids is non-empty.
configuration	VectorStoreConfiguration	The vector store configuration, used when vector store is created from Azure asset URIs.
expires_after	VectorStoreExpirationPolicy	Details on when this vector store expires
file_ids	string[]	A list of file IDs that the vector store should use. Useful for tools like `file_search` that can access files.
metadata	object	A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.
name	string	The name of the vector store.

Responses

Name	Type	Description
200 OK	VectorStore	The request has succeeded.
Other Status Codes	AgentV1Error	An unexpected error response.

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Scopes

Name	Description
https://ai.azure.com/.default

Examples

VectorStores_CreateVectorStore_MaximumSet

VectorStores_CreateVectorStore_MinimumSet

VectorStores_CreateVectorStore_MaximumSet

Sample request

HTTP

POST {endpoint}/vector_stores?api-version=v1

{
  "file_ids": [
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs",
    "ftbzgxmtythuxbhs"
  ],
  "name": "vidfcwh",
  "configuration": {
    "data_sources": [
      {
        "uri": "jtookuzhwojyylbips",
        "type": "uri_asset"
      }
    ]
  },
  "expires_after": {
    "anchor": "last_active_at",
    "days": 102
  },
  "chunking_strategy": {
    "type": "VectorStoreChunkingStrategyRequest"
  },
  "metadata": {
    "key3221": "kpsoqourrnirxgzrl"
  }
}

Sample response

Status code:: 200

{
  "id": "bxcw",
  "object": "vector_store",
  "created_at": 6,
  "name": "nhjsetafmqp",
  "usage_bytes": 9,
  "file_counts": {
    "in_progress": 14,
    "completed": 21,
    "failed": 12,
    "cancelled": 1,
    "total": 25
  },
  "status": "expired",
  "expires_after": {
    "anchor": "last_active_at",
    "days": 102
  },
  "expires_at": 22,
  "last_active_at": 14,
  "metadata": {
    "key1986": "qlxm"
  }
}

VectorStores_CreateVectorStore_MinimumSet

Sample request

HTTP

POST {endpoint}/vector_stores?api-version=v1

{}

Sample response

Status code:: 200

{
  "id": "bxcw",
  "object": "vector_store",
  "created_at": 6,
  "name": "nhjsetafmqp",
  "usage_bytes": 9,
  "file_counts": {
    "in_progress": 14,
    "completed": 21,
    "failed": 12,
    "cancelled": 1,
    "total": 25
  },
  "status": "expired",
  "last_active_at": 14,
  "metadata": {}
}

Definitions

Name	Description
AgentErrorDetail	Describes the error information returned by the agents API.
AgentV1Error	Error payload returned by the agents API.
VectorStore	A vector store is a collection of processed files can be used by the `file_search` tool.
VectorStoreAutoChunkingStrategyRequest	The default strategy. This strategy currently uses a max_chunk_size_tokens of 800 and chunk_overlap_tokens of 400.
VectorStoreChunkingStrategyRequestType	Type of chunking strategy
VectorStoreConfiguration	Vector storage configuration is the list of data sources, used when multiple files can be used for the enterprise file search.
VectorStoreDataSource	The structure, containing Azure asset URI path and the asset type of the file used as a data source for the enterprise file search.
VectorStoreDataSourceAssetType	Type of vector storage asset. Asset type may be a uri_asset, in this case it should contain asset URI ID, in the case of id_asset it should contain the data ID.
VectorStoreExpirationPolicy	The expiration policy for a vector store.
VectorStoreExpirationPolicyAnchor	Describes the relationship between the days and the expiration of this vector store
VectorStoreFileCount	Counts of files processed or being processed by this vector store grouped by status.
VectorStoreOptions	Request object for creating a vector store.
VectorStoreStaticChunkingStrategyOptions	Options to configure a vector store static chunking strategy.
VectorStoreStaticChunkingStrategyRequest	A statically configured chunking strategy.
VectorStoreStatus	Vector store possible status

AgentErrorDetail

Object

Describes the error information returned by the agents API.

Name	Type	Description
code	string	Machine-readable error code.
message	string	Human-readable description of the error.
param	string	Name of the parameter that caused the error, if applicable.
type	string	Error type identifier (e.g. `invalid_request_error`).

AgentV1Error

Object

Error payload returned by the agents API.

Name	Type	Description
error	AgentErrorDetail	Represents the error.

VectorStore

Object

A vector store is a collection of processed files can be used by the file_search tool.

Name	Type	Description
created_at	integer (unixtime)	The Unix timestamp (in seconds) for when the vector store was created.
expires_after	VectorStoreExpirationPolicy	Details on when this vector store expires
expires_at	integer (unixtime)	The Unix timestamp (in seconds) for when the vector store will expire.
file_counts	VectorStoreFileCount	Files count grouped by status processed or being processed by this vector store.
id	string	The identifier, which can be referenced in API endpoints.
last_active_at	integer (unixtime)	The Unix timestamp (in seconds) for when the vector store was last active.
metadata	object	A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.
name	string	The name of the vector store.
object	enum: vector_store	The object type, which is always `vector_store`
status	VectorStoreStatus	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.
usage_bytes	integer (int32)	The total number of bytes used by the files in the vector store.

VectorStoreAutoChunkingStrategyRequest

Object

The default strategy. This strategy currently uses a max_chunk_size_tokens of 800 and chunk_overlap_tokens of 400.

Name	Type	Description
type	string: auto	The object type.

VectorStoreChunkingStrategyRequestType

Enumeration

Type of chunking strategy

Value	Description
auto
static

VectorStoreConfiguration

Object

Vector storage configuration is the list of data sources, used when multiple files can be used for the enterprise file search.

Name	Type	Description
data_sources	VectorStoreDataSource[]	Data sources

VectorStoreDataSource

Object

The structure, containing Azure asset URI path and the asset type of the file used as a data source for the enterprise file search.

Name	Type	Description
type	VectorStoreDataSourceAssetType	The asset type
uri	string	Asset URI.

VectorStoreDataSourceAssetType

Enumeration

Type of vector storage asset. Asset type may be a uri_asset, in this case it should contain asset URI ID, in the case of id_asset it should contain the data ID.

Value	Description
uri_asset	Azure URI
id_asset	The data ID

VectorStoreExpirationPolicy

Object

The expiration policy for a vector store.

Name	Type	Description
anchor	VectorStoreExpirationPolicyAnchor	Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`.
days	integer (int32) minimum: 1 maximum: 365	The anchor timestamp after which the expiration policy applies.

VectorStoreExpirationPolicyAnchor

Enumeration

Describes the relationship between the days and the expiration of this vector store

Value	Description
last_active_at	The expiration policy is based on the last time the vector store was active.

VectorStoreFileCount

Object

Counts of files processed or being processed by this vector store grouped by status.

Name	Type	Description
cancelled	integer (int32)	The number of files that were cancelled.
completed	integer (int32)	The number of files that have been successfully processed.
failed	integer (int32)	The number of files that have failed to process.
in_progress	integer (int32)	The number of files that are currently being processed.
total	integer (int32)	The total number of files.

VectorStoreOptions

Object

Request object for creating a vector store.

Name	Type	Description
chunking_strategy	VectorStoreChunkingStrategyRequest: VectorStoreAutoChunkingStrategyRequest VectorStoreStaticChunkingStrategyRequest	The chunking strategy used to chunk the file(s). If not set, will use the auto strategy. Only applicable if file_ids is non-empty.
configuration	VectorStoreConfiguration	The vector store configuration, used when vector store is created from Azure asset URIs.
expires_after	VectorStoreExpirationPolicy	Details on when this vector store expires
file_ids	string[]	A list of file IDs that the vector store should use. Useful for tools like `file_search` that can access files.
metadata	object	A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.
name	string	The name of the vector store.

VectorStoreStaticChunkingStrategyOptions

Object

Options to configure a vector store static chunking strategy.

Name	Type	Description
chunk_overlap_tokens	integer (int32)	The number of tokens that overlap between chunks. The default value is 400. Note that the overlap must not exceed half of max_chunk_size_tokens.
max_chunk_size_tokens	integer (int32) minimum: 100 maximum: 4096	The maximum number of tokens in each chunk. The default value is 800. The minimum value is 100 and the maximum value is 4096.

VectorStoreStaticChunkingStrategyRequest

Object

A statically configured chunking strategy.

Name	Type	Description
static	VectorStoreStaticChunkingStrategyOptions	The options for the static chunking strategy.
type	string: static	The object type.

VectorStoreStatus

Enumeration

Vector store possible status

Value	Description
expired	expired status indicates that this vector store has expired and is no longer available for use.
in_progress	in_progress status indicates that this vector store is still processing files.
completed	completed status indicates that this vector store is ready for use.

Share via

Vector Stores - Create Vector Store

URI Parameters

Request Body

Responses

Security

OAuth2Auth

Scopes

Examples

VectorStores_CreateVectorStore_MaximumSet

Sample request

Sample response

VectorStores_CreateVectorStore_MinimumSet

Sample request

Sample response

Definitions

AgentErrorDetail

AgentV1Error

VectorStore

VectorStoreAutoChunkingStrategyRequest

VectorStoreChunkingStrategyRequestType

VectorStoreConfiguration

VectorStoreDataSource

VectorStoreDataSourceAssetType

VectorStoreExpirationPolicy

VectorStoreExpirationPolicyAnchor

VectorStoreFileCount

VectorStoreOptions

VectorStoreStaticChunkingStrategyOptions

VectorStoreStaticChunkingStrategyRequest

VectorStoreStatus