This page shows you how to convert a free starter index in the gcp-starter environment to a serverless index.

Serverless indexes are in public preview and are available only on AWS in the us-west-2, us-east-1, and eu-west-1 regions. Check current limits and restrictions and test thoroughly before using them in production.

Before you begin

Make sure your starter index is in the gcp-starter environment. Starter indexes in other environments cannot be converted to serverless at this time.

1. Pause traffic to the index

Converting your index to serverless takes less than 5 minutes. During that time, upsert and update requests will fail, so it’s recommended to pause client traffic to the index before starting conversion.

2. Update clients and code

If you are using an older version of the Python or Node.js client, you must update the client to work with serverless indexes and make minor changes to your code.

  1. Check your client version:

    # For the Python client:  
    pip show pinecone-client  
    # For the Node.js client:  
    npm list | grep @pinecone-database/pinecone  
  2. If your client version is less than 3.0.0 for Python, 2.0.0 for Node.js, or 1.0.0 for Java, upgrade the client as follows:

    pip install pinecone-client --upgrade  
  3. In your code, change how you import the Pinecone library and authenticate and initialize the client:

    from pinecone import Pinecone, ServerlessSpec, PodSpec  
    # ServerlessSpec and PodSpec are required only when  
    # creating serverless and pod-based indexes.  
    pc = Pinecone(api_key="YOUR_API_KEY")  

Depending on your usage of the client, there may be other changes to make. For a comprehensive list, see the Python client v3 migration guide or Node.js client v2 migration guide.

3. Convert the index

In the Pinecone console, go to your starter index and click Convert to serverless.

The process takes less than 5 minutes and does not involve creating or deleting any indexes; instead, this process transforms your starter index into a serverless index and moves it to the us-east-1 region of the AWS cloud.

4. Reinitialize clients

Once your index has been converted to serverless, your index will have a new DNS endpoint.

  • If you are using Pinecone clients, reinitialize them so they pick up the new index endpoint.

  • If you are using the REST API directly, get the new index endpoint and use it in all data plane requests:

    curl -X POST "https://$INDEX_HOST/describe_index_stats" \  
       -H "Api-Key: $PINECONE_API_KEY"  

See also