The Pinecone python client
For more information, see the docs at https://www.pinecone.io/docs/
Install a released version from pip:
pip3 install pinecone-clientOr the gRPC version of the client for tuning performance
pip3 install "pinecone-client[grpc]"Or the latest development version:
pip3 install git+https://git@github.com/pinecone-io/pinecone-python-client.gitOr a specific development version:
pip3 install git+https://git@github.com/pinecone-io/pinecone-python-client.git
pip3 install git+https://git@github.com/pinecone-io/pinecone-python-client.git@example-branch-name
pip3 install git+https://git@github.com/pinecone-io/pinecone-python-client.git@259deffThe following example creates an index without a metadata configuration. By default, Pinecone indexes all metadata.
import pinecone
pinecone.init(api_key="YOUR_API_KEY",
environment="us-west1-gcp")
pinecone.create_index("example-index", dimension=1024)The following example creates an index that only indexes the "color" metadata field. Queries against this index cannot filter based on any other metadata field.
metadata_config = {
"indexed": ["color"]
}
pinecone.create_index("example-index-2", dimension=1024,
metadata_config=metadata_config)The following example returns all indexes in your project.
import pinecone
pinecone.init(api_key="YOUR_API_KEY", environment="us-west1-gcp")
active_indexes = pinecone.list_indexes()The following example returns information about the index example-index.
import pinecone
pinecone.init(api_key="YOUR_API_KEY", environment="us-west1-gcp")
index_description = pinecone.describe_index("example-index")The following example deletes example-index.
import pinecone
pinecone.init(api_key="YOUR_API_KEY", environment="us-west1-gcp")
pinecone.delete_index("example-index")The following example changes the number of replicas for example-index.
import pinecone
pinecone.init(api_key="YOUR_API_KEY", environment="us-west1-gcp")
new_number_of_replicas = 4
pinecone.configure_index("example-index", replicas=new_number_of_replicas)The following example returns statistics about the index example-index.
import pinecone
pinecone.init(api_key="YOUR_API_KEY", environment="us-west1-gcp")
index = pinecone.Index("example-index")
index_stats_response = index.describe_index_stats()The following example upserts vectors to example-index.
import pinecone
pinecone.init(api_key="YOUR_API_KEY", environment="us-west1-gcp")
index = pinecone.Index("example-index")
upsert_response = index.upsert(
vectors=[
("vec1", [0.1, 0.2, 0.3, 0.4], {"genre": "drama"}),
("vec2", [0.2, 0.3, 0.4, 0.5], {"genre": "action"}),
],
namespace="example-namespace"
)The following example queries the index example-index with metadata
filtering.
import pinecone
pinecone.init(api_key="YOUR_API_KEY", environment="us-west1-gcp")
index = pinecone.Index("example-index")
query_response = index.query(
namespace="example-namespace",
top_k=10,
include_values=True,
include_metadata=True,
vector=[0.1, 0.2, 0.3, 0.4],
filter={
"genre": {"$in": ["comedy", "documentary", "drama"]}
}
)The following example deletes vectors by ID.
import pinecone
pinecone.init(api_key="YOUR_API_KEY", environment="us-west1-gcp")
index = pinecone.Index("example-index")
delete_response = index.delete(ids=["vec1", "vec2"], namespace="example-namespace")The following example fetches vectors by ID.
import pinecone
pinecone.init(api_key="YOUR_API_KEY", environment="us-west1-gcp")
index = pinecone.Index("example-index")
fetch_response = index.fetch(ids=["vec1", "vec2"], namespace="example-namespace")The following example updates vectors by ID.
import pinecone
pinecone.init(api_key="YOUR_API_KEY", environment="us-west1-gcp")
index = pinecone.Index("example-index")
update_response = index.update(
id="vec1",
values=[0.1, 0.2, 0.3, 0.4],
set_metadata={"genre": "drama"},
namespace="example-namespace"
)The following example creates the collection example-collection from
example-index.
import pinecone
pinecone.init(api_key="YOUR_API_KEY",
environment="us-west1-gcp")
pinecone.create_collection("example-collection", "example-index")The following example returns a list of the collections in the current project.
import pinecone
pinecone.init(api_key="YOUR_API_KEY", environment="us-west1-gcp")
active_collections = pinecone.list_collections()The following example returns a description of the collection
example-collection.
import pinecone
pinecone.init(api_key="YOUR_API_KEY", environment="us-west1-gcp")
collection_description = pinecone.describe_collection("example-collection")The following example deletes the collection example-collection.
import pinecone
pinecone.init(api_key="YOUR_API_KEY", environment="us-west1-gcp")
pinecone.delete_collection("example-collection")If you'd like to make a contribution, or get setup locally to develop the Pinecone python client, please see our contributing guide