PineconeRerank#

class langchain_pinecone.rerank.PineconeRerank[source]#

Bases: BaseDocumentCompressor

Document compressor that uses Pinecone Rerank API.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

param async_client: PineconeAsyncio | None = None#

Pinecone client to use for compressing documents.

param client: Pinecone | None = None#

Pinecone client to use for compressing documents.

param model: str = 'bge-reranker-v2-m3'#

Model to use for reranking.

Model to use for reranking. Default is ‘bge-reranker-v2-m3’.

param pinecone_api_key: SecretStr | None [Optional]#

Pinecone API key. Must be specified directly or via environment variable PINECONE_API_KEY.

param rank_fields: List[str] | None = None#

Fields to use for reranking when documents are dictionaries.

param return_documents: bool = True#

Whether to return the documents in the reranking results.

param top_n: int | None = 3#

Number of documents to return.

async acompress_documents(
documents: Sequence[Document],
query: str,
callbacks: list[BaseCallbackHandler] | BaseCallbackManager | None = None,
) → Sequence[Document][source]#

Async compress documents using Pinecone’s rerank API.

Parameters:
Return type:

Sequence[Document]

async arerank(
documents: Sequence[str | Document | dict],
query: str,
*,
rank_fields: List[str] | None = None,
model: str | None = None,
top_n: int | None = None,
truncate: str = 'END',
) → List[Dict[str, Any]][source]#

Async rerank documents using Pinecone’s reranking API.

Parameters:

  • documents (Sequence[str | Document | dict])

  • query (str)

  • rank_fields (List[str] | None)

  • model (str | None)

  • top_n (int | None)

  • truncate (str)

Return type:

List[Dict[str, Any]]

compress_documents(
documents: Sequence[Document],
query: str,
callbacks: list[BaseCallbackHandler] | BaseCallbackManager | None = None,
) → Sequence[Document][source]#

Compress documents using Pinecone’s rerank API.

Parameters:
Return type:

Sequence[Document]

rerank(
documents: Sequence[str | Document | dict],
query: str,
*,
rank_fields: List[str] | None = None,
model: str | None = None,
top_n: int | None = None,
truncate: str = 'END',
) → List[Dict[str, Any]][source]#

Returns an ordered list of documents ordered by their relevance to the provided query.

Parameters:

  • documents (Sequence[str | Document | dict])

  • query (str)

  • rank_fields (List[str] | None)

  • model (str | None)

  • top_n (int | None)

  • truncate (str)

Return type:

List[Dict[str, Any]]