Create an index
This operation deploys a Pinecone index. This is where you specify the measure of similarity, the dimension of vectors to be stored in the index, which cloud provider you would like to deploy with, and more.
For guidance and examples, see Create an index.
Authorizations
An API Key is required to call Pinecone APIs. Get yours from the console.
Body
The configuration needed to create 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 '-'.
The dimensions of the vectors to be inserted in the index.
The distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'.
cosine, euclidean, dotproduct Whether deletion protection is enabled/disabled for the index.
disabled, enabled Custom user tags added to an index. Keys must be alphanumeric and 80 characters or less. Values must be 120 characters or less.
The spec object defines how the index should be deployed.
For serverless indexes, you define only the cloud and region where the index should be hosted. For pod-based indexes, you define the environment where the index should be hosted, the pod type and size to use, and other index characteristics.
Response
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 '-'.
The dimensions of the vectors to be inserted in the index.
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.
Whether deletion protection is enabled/disabled for the index.
disabled, enabled Custom user tags added to an index. Keys must be alphanumeric and 80 characters or less. Values must be 120 characters or less.
Was this page helpful?