Pinecone helpers for notebooks
This package contains helper functions for working with Pinecone in the context of a Jupyter or
Google Colab notebook.
Google Colab
Authenticate
This helper function displays a widget to allow the user to authenticate with Pinecone. Once the
user authenticates, they are prompted to select the Pinecone organization and project that they want
to grant access to. An API key is then generated and set as the environment variable
PINECONE_API_KEY
.
Usage
To display the authentication widget:
from pinecone_notebooks.colab import Authenticate
Authenticate()
Note that any usage of the API key should take place in a later cell. The user must complete the
authentication flow before the PINECONE_API_KEY
environment variable can be used.
from pinecone import Pinecone
api_key = os.environ.get('PINECONE_API_KEY')
pinecone_client = Pinecone(api_key=api_key)
source_tag
The Authenticate
function has an optional source_tag
parameter. Pinecone partners should set
this value to receive attribution credit for users of their notebooks who signup to Pinecone.
from pinecone_notebooks.colab import Authenticate
Authenticate(source_tag='MyAwesomeApp')
Jupyter
Coming soon!