Skip to main content

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)

# ... proceed to use pinecone_client to create indexes, upload data, query, etc.
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!

Release files for pinecone-notebooks 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for pinecone-notebooks 0.1.1
File Interpreter ABI Platform
pinecone_notebooks-0.1.1-py3-none-any.whl Python 3 none any Details

Release files / pinecone_notebooks-0.1.1-py3-none-any.whl

Download URL pinecone_notebooks-0.1.1-py3-none-any.whl
Size 7.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6f5eb0b163fe7d50e3ef61d4fe2e0a6d5c15b762214c5f756979adf7a44f7762
BLAKE2b-256 checksum
How to use checksums
2b833d0eff668327fbfc844037790351e01260c697f70574d7bcf6167e6f3e4c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.3 CPython/3.12.3 Linux/6.5.0-1021-azure
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page