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-1.0.0.tar.gz (54.4 kB view details)

Uploaded Source

Built Distribution

pinecone_plugin_inference-1.0.0-py3-none-any.whl (117.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pinecone_plugin_inference-1.0.0.tar.gz
  • Upload date:
  • Size: 54.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.4 Linux/6.5.0-1023-azure

File hashes

Hashes for pinecone_plugin_inference-1.0.0.tar.gz
Algorithm Hash digest
SHA256 0bc09829c47803b1533d1263002cf26e238b4d9783435d2fde2b0808ee3593f7
MD5 82e60079c96cc265bff91a3e0a8621f7
BLAKE2b-256 ea066524c568bbb60c938fe929d807c090691739979bd8547e28572144af6f81

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pinecone_plugin_inference-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5a51bf4459c09f7d5a6978dad4e35e2520692f0901bd736288cf0552a72784b8
MD5 e7e6085128e4c448cedba77628cfb522
BLAKE2b-256 f918c1d70066c4407c9003a039da965ea1228ddc9384d2118c1852dfa4c9d73f

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