Database
Inference
- Standalone
- Integrated
Assistant
- Assistants
- Files
- Chat
- Evaluation
- Context snippets
List indexes
This operation returns a list of all indexes in a project.
{
"indexes": [
{
"dimension": 384,
"host": "semantic-search-c01b5b5.svc.us-west1-gcp.pinecone.io",
"metric": "cosine",
"name": "semantic-search",
"spec": {
"pod": {
"environment": "us-west1-gcp",
"pod_type": "p1.x1",
"pods": 4,
"replicas": 2,
"shards": 2
}
},
"status": {
"ready": true,
"state": "Ready"
},
"vector_type": "dense"
},
{
"dimension": 200,
"host": "image-search-a31f9c1.svc.us-east1-gcp.pinecone.io",
"metric": "dotproduct",
"name": "image-search",
"spec": {
"serverless": {
"cloud": "aws",
"region": "us-east-1"
}
},
"status": {
"ready": false,
"state": "Initializing"
},
"vector_type": "dense"
},
{
"host": "sparse-index-1a2b3c4d.svc.us-east1-gcp.pinecone.io",
"metric": "dotproduct",
"name": "sparse-index",
"spec": {
"serverless": {
"cloud": "aws",
"region": "us-east-1"
}
},
"status": {
"ready": true,
"state": "Ready"
},
"vector_type": "sparse"
}
]
}Response
The list of indexes that exist in the project.
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 - 45The dimensions of the vectors to be inserted in the index.
1 < x < 20000The distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'. If the 'vector_type' is 'sparse', the metric must be 'dotproduct'. If the vector_type is dense, the metric defaults to 'cosine'.
cosine, euclidean, dotproduct The URL address where the index is hosted.
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.
The embedding model and document fields mapped to embedding inputs.
The name of the embedding model used to create the index.
The distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'. If not specified, the metric will be defaulted according to the model. Cannot be updated once set.
cosine, euclidean, dotproduct The dimensions of the vectors to be inserted in the index.
1 < x < 20000The index vector type. You can use 'dense' or 'sparse'. If 'dense', the vector dimension must be specified. If 'sparse', the vector dimension should not be specified.
Identifies the name of the text field from your document model that is embedded.
The read parameters for the embedding model.
The write parameters for the embedding model.
Configuration needed to deploy a pod-based index.
The environment where the index is hosted.
The type of pod to use. One of s1, p1, or p2 appended with . and one of x1, x2, x4, or x8.
The number of replicas. Replicas duplicate your index. They provide higher availability and throughput. Replicas can be scaled up or down as your needs change.
x > 1The number of shards. Shards split your data across multiple pods so you can fit more data into an index.
x > 1The number of pods to be used in the index. This should be equal to shards x replicas.'
x > 1Configuration for the behavior of Pinecone's internal metadata index. By default, all metadata is indexed; when metadata_config is present, only specified metadata fields are indexed. These configurations are only valid for use with pod-based indexes.
By default, all metadata is indexed; to change this behavior, use this property to specify an array of metadata fields that should be indexed.
The name of the collection to be used as the source for the index.
The index vector type. You can use 'dense' or 'sparse'. If 'dense', the vector dimension must be specified. If 'sparse', the vector dimension should not be specified.
Was this page helpful?
{
"indexes": [
{
"dimension": 384,
"host": "semantic-search-c01b5b5.svc.us-west1-gcp.pinecone.io",
"metric": "cosine",
"name": "semantic-search",
"spec": {
"pod": {
"environment": "us-west1-gcp",
"pod_type": "p1.x1",
"pods": 4,
"replicas": 2,
"shards": 2
}
},
"status": {
"ready": true,
"state": "Ready"
},
"vector_type": "dense"
},
{
"dimension": 200,
"host": "image-search-a31f9c1.svc.us-east1-gcp.pinecone.io",
"metric": "dotproduct",
"name": "image-search",
"spec": {
"serverless": {
"cloud": "aws",
"region": "us-east-1"
}
},
"status": {
"ready": false,
"state": "Initializing"
},
"vector_type": "dense"
},
{
"host": "sparse-index-1a2b3c4d.svc.us-east1-gcp.pinecone.io",
"metric": "dotproduct",
"name": "sparse-index",
"spec": {
"serverless": {
"cloud": "aws",
"region": "us-east-1"
}
},
"status": {
"ready": true,
"state": "Ready"
},
"vector_type": "sparse"
}
]
}