Skip to main content

Embeddings plugin for Pinecone SDK

Project description

Inference API plugin for python SDK

Installation

The plugin is distributed separately from the core python sdk.

# Install the base python SDK, version 4.1.1 or higher
pip install pinecone-client

# And also the plugin functionality
pip install pinecone-plugin-inference

Usage

Interact with Pinecone's Inference APIs, e.g. create embeddings (currently in preview).

Models currently supported:

Generate embeddings

The following example highlights how to use an embedding model to generate embeddings for a list of documents and a user query, with the ultimate goal of retrieving similar documents from a Pinecone index.

from pinecone import Pinecone

pc = Pinecone(api_key="<<PINECONE_API_KEY>>")
model = "multilingual-e5-large"

# Embed documents
text = [
    "Turkey is a classic meat to eat at American Thanksgiving.",
    "Many people enjoy the beautiful mosques in Turkey.",
]
text_embeddings = pc.inference.embed(
    model=model,
    inputs=text,
    parameters={"input_type": "passage", "truncate": "END"},
)

# <<Upsert documents into Pinecone index>>

# Embed query
query = ["How should I prepare my turkey?"]
query_embeddings = pc.inference.embed(
    model=model,
    inputs=query,
    parameters={"input_type": "query", "truncate": "END"},
)

# <<Send query to Pinecone index to retrieve similar documents>>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pinecone_plugin_inference-0.4.0.tar.gz (56.8 kB view details)

Uploaded Source

Built Distribution

pinecone_plugin_inference-0.4.0-py3-none-any.whl (129.2 kB view details)

Uploaded Python 3

File details

Details for the file pinecone_plugin_inference-0.4.0.tar.gz.

File metadata

  • Download URL: pinecone_plugin_inference-0.4.0.tar.gz
  • Upload date:
  • Size: 56.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Linux/6.5.0-1021-azure

File hashes

Hashes for pinecone_plugin_inference-0.4.0.tar.gz
Algorithm Hash digest
SHA256 a67d8be4795994303481440b0c821e59176880f758c72403664c94ad70ca1ea5
MD5 a92fda360bcd38468d42c05794db8ab3
BLAKE2b-256 79984601b7bcc985d563ac0dfc10a686ac4ae14a99de56c7cee258c5c0bdb565

See more details on using hashes here.

File details

Details for the file pinecone_plugin_inference-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pinecone_plugin_inference-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2d4cf3f267e055907e9fbd560cd32f97125680a03cc201c474541ac18ac19cda
MD5 6e5ccf7fdcfb6d759ec5c257dc8ed4d8
BLAKE2b-256 000bb94b20e61b60ab2d8ec4549daf9bbc40f56edff41b1d3fc68e220ef34ece

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page