/* Global styles */

#topbar-cta-button span {
  border-radius: 4px;
  padding: 4px 2px;
  font-weight: bold;
}

.documentation-link {
  color: #1c17ff;
  text-decoration: none;
}

.documentation-link:hover {
  color: #000000; /* Black color when hovering */
}

.custom-button {
  display: inline-block;
  padding: 2px 8px;
  background-color: #f1f1f1;
  color: #333; /* Text color */
  border: 1px solid #aaa; /* Border color */
  border-radius: 25px; /* Rounded borders */
  text-align: center;
  user-select: none;
  transition: background-color 0.3s ease; /* Smooth transition for background color */
}

/* Change the button color on hover (make it unclickable) */
.custom-button:hover {
  background-color: #1c17ff;
  color: #f1f1f1;
}

/* Adjust the width for the second column */
td:nth-child(2) {
  width: 200px; /* Adjust the width as per your requirement */
}

/* 
Add an announcement bar 
TODO: Figure out how to make this versions-specific. 
*/
/* #navbar:before {
  background-color: #ff4c04;
  content: "This API is currently in beta. If you'd like to request access, contact our Support Team";
  color: rgb(255, 255, 255);
  display: block;
  text-align: center;
  padding: 6px;
  font-size: 90%;
} */


This operation returns a list of all indexes in a project.

List indexes

The IndexModel describes the configuration and status of a Pinecone index.

The dimensions of the vectors to be inserted in the index.

The URL address where the index is hosted.

The distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'.

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 '-'.


Configuration needed to deploy a pod-based index.

The environment where the index is hosted.

Configuration 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 type of pod to use. One of `s1`, `p1`, or `p2` appended with `.` and one of `x1`, `x2`, `x4`, or `x8`.

The number of pods to be used in the index. This should be equal to `shards` x `replicas`.'

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.

The number of shards. Shards split your data across multiple pods so you can fit more data into an index.

The name of the collection to be used as the source for the index.

Configuration needed to deploy a serverless index.

The public cloud where you would like your index hosted. Serverless indexes can be hosted only in AWS at this time.

The region where you would like your index to be created.  Serverless indexes can be created only in the us-west-2 region of AWS at this time.

ApiKeyAuth

This operation returns a list of all the indexes that you have previously created, and which are associated with the given project

A list containing one serverless index and one pod-based index.

The list of indexes that exist in the project.

Unauthorized. Possible causes: Invalid API key.

The response shape used for all error responses.

Pinecone

Forum

Support

Status

Guides

Reference

Examples

Integrations

Libraries

Tools

Troubleshooting

Releases

Sign Up Free

Log In

Introduction

Pinecone Documentation

An introduction to the Pinecone vector database.

Overview

Pinecone overview

Quickstart

This guide explains how to authenticate API calls to your Pinecone project.

Authentication

Understanding organizations

Setting up billing through AWS Marketplace

Setting up billing through Azure Marketplace

Setting up billing through GCP Marketplace

Changing your billing plan

Understanding subscription status

Understanding cost

Monitoring your usage

Managing cost

Single sign-on with Okta

Manage organization members

Understanding projects

Create a project

Manage project members

Rename a project

Set a project pod limit

Understanding indexes

Create an index

View index information

Back up an index

Delete an index

Using namespaces

Choosing a pod type and size

Configure pod-based indexes

Scale pod-based indexes

Understanding collections

Convert a starter index to serverless

Upsert data

Query data

Fetch data

Update data

Delete data

List record IDs

Get an index endpoint

Filtering with metadata

Manage RAG documents

Understanding hybrid search

Encode sparse vectors

Upsert sparse-dense vectors

Query sparse-dense vectors

Using public Pinecone datasets

Creating and loading private datasets

Migrate to the new API

Moving to production

Performance tuning

Monitoring

Understanding multitenancy

Common errors

The `upsert` operation writes vectors into a namespace. If a new value is upserted for an existing vector ID, it will overwrite the previous value.

For guidance and examples, see [Upsert data](https://docs.pinecone.io/docs/upsert-data).

Upsert vectors

The `query` operation searches a namespace, using a query vector. It retrieves the ids of the most similar items in a namespace, along with their similarity scores.

For guidance and examples, see [Query data](https://docs.pinecone.io/docs/query-data).

Query vectors

The `fetch` operation looks up and returns vectors, by ID, from a single namespace. The returned vectors include the vector data and/or metadata.

For guidance and examples, see [Fetch data](https://docs.pinecone.io/docs/fetch-data).

Fetch vectors

The `update` operation updates a vector in a namespace. If a value is included, it will overwrite the previous value. If a `set_metadata` is included, the values of the fields specified in it will be added or overwrite the previous value.

For guidance and examples, see [Update data](https://docs.pinecone.io/docs/update-data).

Update a vector

The `delete` operation deletes vectors, by id, from a single namespace.

For guidance and examples, see [Delete data](https://docs.pinecone.io/docs/delete-data).

Delete vectors

The `list` operation lists the IDs of vectors in a single namespace of a serverless index. An optional prefix can be passed to limit the results to IDs with a common prefix.

`list` returns up to 100 IDs at a time by default in sorted order (bitwise/"C" collation). If the `limit` parameter is set, `list` returns up to that number of IDs instead. Whenever there are additional IDs to return, the response also includes a `pagination_token` that you can use to get the next batch of IDs. When the response does not include a `pagination_token`, there are no more IDs to return.

For guidance and examples, see [Get record IDs](https://docs.pinecone.io/docs/get-record-ids).

**Note:** `list` is supported only for serverless indexes.

List vector IDs

The `describe_index_stats` operation returns statistics about the contents of an index, including the vector count per namespace and the number of dimensions, and the index fullness.

Serverless indexes scale automatically as needed, so index fullness is relevant only for pod-based indexes.

For pod-based indexes, the index fullness result may be inaccurate during pod resizing; to get the status of a pod resizing process, use [`describe_index`](https://www.pinecone.io/docs/api/operation/describe_index/).

Get index stats

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](https://docs.pinecone.io/docs/create-an-index#create-a-serverless-index).

Describe an index

This operation deletes an existing index.

This operation specifies the pod type and number of replicas for an index. It applies to pod-based indexes only. Serverless indexes scale automatically based on usage.

Configure an index

This operation returns a list of your Pinecone collections.

Serverless and starter indexes do not support collections.


List collections

This operation creates a Pinecone collection.

Serverless and starter indexes do not support collections.


Create a collection

This operation gets a description of a collection.

Serverless and starter indexes do not support collections.


Describe a collection

This operation deletes an existing collection.

Serverless and starter indexes do not support collections.


Delete a collection

Pinecone clients

Community clients

Serverless architecture

Pod-based architecture

Limits

Security

Notebooks

Sample apps

Utilities

Reference architectures

Airbyte

Confluent

Using Databricks and Pinecone to create and index vector embeddings at scale

Databricks

Snowflake

Pinecone as a Knowledge Base for Amazon Bedrock

Amazon Bedrock

Amazon SageMaker

Haystack

LangChain

LlamaIndex

Amazon Web Services (AWS)

Azure

Google Cloud Platform (GCP)

Pulumi

Vercel

Anyscale

Cohere

Hugging Face Inference Endpoints

OpenAI

Datadog

New Relic

Using TruLens and Pinecone to evaluate grounded LLM applications

REST API

Clients

Architecture

Miscellaneous

List indexes

Authorizations

Response