Authorizations
Path Parameters
The name of the index to configure.
Body
The desired pod size and replica configuration for the index.
Configuration used to scale an index.
Whether deletion protection is enabled/disabled for the index.
disabled
, enabled
Custom user tags added to an index. Keys must be 80 characters or less. Values must be 120 characters or less. Keys must be alphanumeric, '', or '-'. Values must be alphanumeric, ';', '@', '', '-', '.', '+', or ' '. To unset a key, set the value to be an empty string.
{ "tag0": "val0", "tag1": "val1" }
Response
The request to configure the index has been accepted. Check the index status to see when the change has been applied.
The IndexModel describes the configuration and status of a Pinecone index.
The name of the index. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.
1 - 45
"example-index"
The dimensions of the vectors to be inserted in the index.
1 <= x <= 20000
1536
The distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'.
cosine
, euclidean
, dotproduct
The URL address where the index is hosted.
"semantic-search-c01b5b5.svc.us-west1-gcp.pinecone.io"
{
"pod": {
"environment": "us-east-1-aws",
"metadata_config": {
"indexed": ["genre", "title", "imdb_rating"]
},
"pod_type": "p1.x1",
"pods": 1,
"replicas": 1,
"shards": 1
}
}
{
"ready": true,
"state": "ScalingUpPodSize"
}
Whether deletion protection is enabled/disabled for the index.
disabled
, enabled
Custom user tags added to an index. Keys must be 80 characters or less. Values must be 120 characters or less. Keys must be alphanumeric, '', or '-'. Values must be alphanumeric, ';', '@', '', '-', '.', '+', or ' '. To unset a key, set the value to be an empty string.
{ "tag0": "val0", "tag1": "val1" }