langchain.retrievers.document_compressors.cohere_rerank.CohereRerank

class langchain.retrievers.document_compressors.cohere_rerank.CohereRerank[source]

基类: BaseDocumentCompressor

自版本 0.0.30 起已弃用: 请使用 langchain_cohere.CohereRerank 代替。

使用 Cohere Rerank API 的文档压缩器。

通过解析和验证关键字参数中的输入数据来创建一个新的模型。

如果输入数据无法解析为有效模型，则引发 ValueError。

参数 client : Any = None

用于压缩文档的 Cohere 客户端。

参数 cohere_api_key : Optional[str] = None

Cohere API 密钥。必须直接指定或通过环境变量 COHERE_API_KEY 指定。

参数 model : str = 'rerank-english-v2.0'

用于重新排序要使用的模型。

参数 top_n : Optional[int] = 3

要返回的文档数量。

参数 user_agent : str = 'langchain'

请求应用的自定义标识符。

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

根据查询上下文异步压缩检索到的文档。

参数
返回

压缩后的文档。

返回类型

Sequence[Document]

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

使用Cohere的重新排序API压缩文档。

参数
返回

压缩文档的序列。

返回类型

Sequence[Document]

rerank(documents: Sequence[Union[str, Document, dict]]], query: str, *, model: Optional[str] = None, top_n: Optional[int] = -1, max_chunks_per_doc: Optional[int] = None) → List[Dict[str, Any]][source]

根据提供的查询对文档进行排序并返回。

参数

  • query (str) – 用于重新排序的查询。

  • documents (Sequence[Union[str, Document, dict]]) – 要重新排序的文档序列。

  • model (Optional[str]) – 用于重新排序的模型。默认为 self.model。

  • top_n (Optional[int]) – 返回的结果数量。如果为 None，则返回所有结果。默认为 self.top_n。

  • max_chunks_per_doc (Optional[int]) – 从一个文档中得出的最大块数。

返回类型

List[Dict[str, Any]]