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": {}
}
'import requests
url = "https://api.egp.scale.com/v5/vector-stores/{vector_store_name}/configure"
payload = { "indexed_metadata_fields": {} }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({indexed_metadata_fields: {}})
};
fetch('https://api.egp.scale.com/v5/vector-stores/{vector_store_name}/configure', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.egp.scale.com/v5/vector-stores/{vector_store_name}/configure",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'indexed_metadata_fields' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.egp.scale.com/v5/vector-stores/{vector_store_name}/configure"
payload := strings.NewReader("{\n \"indexed_metadata_fields\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.egp.scale.com/v5/vector-stores/{vector_store_name}/configure")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"indexed_metadata_fields\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.egp.scale.com/v5/vector-stores/{vector_store_name}/configure")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"indexed_metadata_fields\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"embedding_dimensions": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"embedding_config": {
"type": "models_api",
"model_deployment_id": "<string>"
},
"indexed_metadata_fields": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Configure Vector Store
Update the indexed metadata fields configuration for a vector store.
This replaces the current set of indexed metadata fields. Only indexed fields can be used for filtering during query, list, and count operations; non-indexed fields are still stored and returned, but cannot be filtered on.
Field Types: Only STRING, NUMBER, and BOOLEAN fields can be indexed (maximum 20 fields). OBJECT and LIST types are stored but cannot be indexed for filtering.
Adding Fields: New indexed fields can be added at any time. They are indexed for documents upserted after the change; to make existing documents filterable on a new field, re-upsert them.
Removing Fields: Omitting a field removes it from this configuration, so it can no longer be filtered on. The underlying index is append-only, so removal does not reclaim storage or reduce write overhead; the field stays in the physical index until the store is recreated. Prefer indexing only the fields you filter on.
Note: The name and embedding_config are immutable after creation.
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": {}
}
'import requests
url = "https://api.egp.scale.com/v5/vector-stores/{vector_store_name}/configure"
payload = { "indexed_metadata_fields": {} }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({indexed_metadata_fields: {}})
};
fetch('https://api.egp.scale.com/v5/vector-stores/{vector_store_name}/configure', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.egp.scale.com/v5/vector-stores/{vector_store_name}/configure",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'indexed_metadata_fields' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.egp.scale.com/v5/vector-stores/{vector_store_name}/configure"
payload := strings.NewReader("{\n \"indexed_metadata_fields\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.egp.scale.com/v5/vector-stores/{vector_store_name}/configure")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"indexed_metadata_fields\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.egp.scale.com/v5/vector-stores/{vector_store_name}/configure")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"indexed_metadata_fields\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"embedding_dimensions": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"embedding_config": {
"type": "models_api",
"model_deployment_id": "<string>"
},
"indexed_metadata_fields": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Headers
Path Parameters
The name of the vector store
Body
Request to configure a vector store.
Dictionary mapping metadata field names to their types. Only STRING, NUMBER, and BOOLEAN types can be indexed.
Show child attributes
Show child attributes
Response
Successful Response
Response model for vector store operations.
The unique identifier of the vector store
The name of the vector store
Dimensionality of the embedding vectors
Timestamp of creation
Timestamp of last update
Embedding configuration identifying the model and its type. None for raw-embedding-only stores.
- EmbeddingConfigModelsAPI
- EmbeddingConfigBase
Show child attributes
Show child attributes
Dictionary mapping metadata field names to their types
Show child attributes
Show child attributes

