Release v5.2.0

Public Preview: Rerank

This release adds a method for interacting with our Rerank endpoint, now in Public Preview. Rerank is used to order results by relevance to a query.

Currently rerank supports the bge-reranker-v2-m3 model. See the rerank guide for more information on using this feature.

from pinecone import Pinecone

pc = Pinecone(api_key="your api key")

query = "Tell me about Apple's products"

results = pc.inference.rerank(
    model="bge-reranker-v2-m3",
    query=query,
    documents=[
      "Apple is a popular fruit known for its sweetness and crisp texture.",
      "Apple is known for its innovative products like the iPhone.",
      "Many people enjoy eating apples as a healthy snack.",
      "Apple Inc. has revolutionized the tech industry with its sleek designs and user-friendly interfaces.",
      "An apple a day keeps the doctor away, as the saying goes.",
    ],
    top_n=3,
    return_documents=True,
)

print(query)
for r in results.data:
  print(r.score, r.document.text)

Gives output along these lines

Tell me about Apple's products
0.8401279 Apple is known for its innovative products like the iPhone.
0.23318209 Apple Inc. has revolutionized the tech industry with its sleek designs and user-friendly interfaces.
0.17384852 Apple is a popular fruit known for its sweetness and crisp texture.