langchain.retrievers.document_compressors.cohere_rerank.CohereRerank

class langchain.retrievers.document_compressors.cohere_rerank.CohereRerank(*, client: Client, top_n: int = 3, model: str = 'rerank-english-v2.0')

Bases: BaseDocumentCompressor

DocumentCompressor that uses Cohere’s rerank API to compress documents.

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

Raises ValidationError if the input data cannot be parsed to form a valid model.

param client: Client [Required]

Cohere client to use for compressing documents.

param model: str = 'rerank-english-v2.0'

Model to use for reranking.

param top_n: int = 3

Number of documents to return.

async acompress_documents(documents: Sequence[Document], query: str, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None) → Sequence[Document]

Compress retrieved documents given the query context.

compress_documents(documents: Sequence[Document], query: str, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None) → Sequence[Document]

Compress documents using Cohere’s rerank API.

Parameters

• documents – A sequence of documents to compress.

• query – The query to use for compressing the documents.

• callbacks – Callbacks to run during the compression process.

Returns

A sequence of compressed documents.

validator validate_environment  »  all fields

Validate that api key and python package exists in environment.

model Config

Bases: object

Configuration for this pydantic object.

arbitrary_types_allowed = True

extra = 'forbid'

Examples using CohereRerank

• Cohere Reranker

• Cohere