Create a serverless index

This page shows you how to create a serverless index to store dense or sparse vectors.

​

Create a dense index

Dense indexes store dense vectors, which are numerical representations of the meaning and relationships of text, images, or other types of data. You use dense indexes for semantic search or in combination with sparse indexes for hybrid search.

You can create a dense index with integrated vector embedding or a dense index for storing vectors generated with an external embedding model.

​

Integrated embedding

If you want to upsert and search with source text and have Pinecone convert it to dense vectors automatically, create a dense index with integrated embedding as follows:

• Provide a name for the index.
• Set embed.model to one of Pinecone’s hosted embedding models.
• Set spec.cloud and spec.region to the cloud and region where the index should be deployed.
• Set embed.field_map to the name of the field in your source document that contains the data for embedding.

Other parameters are optional. See the API reference for details.

from pinecone import Pinecone

pc = Pinecone(api_key="YOUR_API_KEY")

index_name = "example-index"

if not pc.has_index(index_name):
    pc.create_index_for_model(
        name=index_name,
        cloud="aws",
        region="us-east-1",
        embed={
            "model":"multilingual-e5-large",
            "field_map":{"text": "chunk_text"}
        }
    )

​

Bring your own vectors

If you use an external embedding model to convert your data to dense vectors, use the create a dense index as follows:

• Provide a name for the index.
• Set the vector_type to dense.
• Specify the dimension and similarity metric of the vectors you’ll store in the index. This should match the dimension and metric supported by your embedding model.
• Set spec.cloud and spec.region to the cloud and region where the index should be deployed. For Python, you also need to import the ServerlessSpec class.

Other parameters are optional. See the API reference for details.

from pinecone.grpc import PineconeGRPC as Pinecone
from pinecone import ServerlessSpec

pc = Pinecone(api_key="YOUR_API_KEY")

index_name = "example-index"

if not pc.has_index(index_name):
    pc.create_index(
        name=index_name,
        vector_type="dense",
        dimension=1536,
        metric="cosine",
        spec=ServerlessSpec(
            cloud="aws",
            region="us-east-1"
        ),
        deletion_protection="disabled",
        tags={
            "environment": "development"
        }
    )

​

Create a sparse index

Sparse indexes store sparse vectors, which are numerical representations of the words or phrases in a document. You use sparse indexes for lexical search, or in combination with dense indexes for hybrid search.

You can create a dense index with integrated vector embedding or a dense index for storing vectors generated with an external embedding model.

​

Integrated embedding

If you want to upsert and search with source text and have Pinecone convert it to sparse vectors automatically, create a sparse index with integrated embedding as follows:

• Provide a name for the index.
• Set the cloud and region where the index should be deployed.
• Set embed.model to one of Pinecone’s hosted sparse embedding models.
• Set embed.field_map to the name of the field in your source document that contains the text for embedding.

Other parameters are optional. See the API reference for details.

from pinecone import Pinecone, ServerlessSpec

pc = Pinecone(api_key="YOUR_API_KEY")

index_name = "example-index"

if not pc.has_index(index_name):
    pc.create_index_for_model(
        name=index_name,
        cloud="aws",
        region="us-east-1",
        embed={
            "model":"pinecone-sparse-english-v0",
            "field_map":{"text": "chunk_text"}
        }
    )

​

Bring your own vectors

If you use an external embedding model to convert your data to sparse vectors, create a sparse index as follows:

• Provide a name for the index.
• Set the vector_type to sparse.
• Set the distance metric to dotproduct. Sparse indexes do not support other distance metrics.
• Set spec.cloud and spec.region to the cloud and region where the index should be deployed.

Other parameters are optional. See the API reference for details.

from pinecone import Pinecone, ServerlessSpec

pc = Pinecone(api_key="YOUR_API_KEY")

index_name = "example-index"

if not pc.has_index(index_name):
    pc.create_index(
        name=index_name,
        vector_type="sparse",
        metric="dotproduct",
        spec=ServerlessSpec(cloud="aws", region="eu-west-1")
    )

​

Create an index from a backup

You can create a dense or sparse index from a backup. For more details, see Restore an index.

​

Migrate a pod-based index to serverless

You can migrate a pod-based index to serverless by creating a new serverless index from a collection. For more information, see Migrate a pod-based index to serverless.