Skip to main content
POST
/
v5
/
vector-stores
/
{vector_store_name}
/
configure
Configure Vector Store
curl --request POST \
  --url https://api.egp.scale.com/v5/vector-stores/{vector_store_name}/configure \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "indexed_metadata_fields": {}
}
'
{
  "name": "<string>",
  "embedding_config": {
    "type": "<string>",
    "model_deployment_id": "<string>"
  },
  "embedding_dimensions": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "indexed_metadata_fields": {}
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-selected-account-id
string | null

Path Parameters

​
vector_store_name
string
required

The name of the vector store

Body

application/json

Request to configure a vector store.

​
indexed_metadata_fields
Indexed Metadata Fields · object
required

Dictionary mapping metadata field names to their types. Only STRING, NUMBER, and BOOLEAN types can be indexed.

Response

Successful Response

Response model for vector store operations.

​
name
string
required

The name of the vector store

​
embedding_config
EmbeddingConfigModelsAPI · object
required

Embedding configuration identifying the model and its type

​
embedding_dimensions
integer
required

Dimensionality of the embedding vectors

​
created_at
string<date-time>
required

Timestamp of creation

​
updated_at
string<date-time>
required

Timestamp of last update

​
indexed_metadata_fields
Indexed Metadata Fields · object

Dictionary mapping metadata field names to their types