langchain_cohere.rerank.CohereRerank¶
- class langchain_cohere.rerank.CohereRerank[source]¶
-
使用 Cohere Rerank API 的文档压缩器。
通过解析和验证关键字参数中的输入数据来创建一个新模型。
如果输入数据无法解析为有效的模型，将引发 ValidationError。
- 参数 client: Any = None¶
用于压缩文档的 Coherence 客户端。
- 参数 cohere_api_key: Optional[str] = None¶
Cohere API 密钥。必须直接指定或通过环境变量 COHERE_API_KEY。
- 参数 model: Optional[str] = None¶
用于重排序的模型。必须指定模型名称。
- 参数 top_n: Optional[int] = 3¶
要返回的文档数量。
- 参数 user_agent : str = 'langchain:partner'¶
请求应用程序的唯一标识符。
- async acompress_documents(documents: Sequence[Document], query: str, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None) Sequence[Document]¶
根据查询上下文异步压缩检索到的文档。
- 参数
documents (Sequence[Document]) – 检索到的文档。
query (str) – 查询上下文。
callbacks (Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]) – 压缩过程中的可选回调。
- 返回
压缩后的文档。
- 返回类型
Sequence[Document]
- compress_documents(documents: Sequence[Document], query: str, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None) Sequence[Document][source]¶
使用 Cohere 的重新排序 API 压缩文档。
- 参数
documents (Sequence[Document]) – 要压缩的文档序列。
query (str) – 用于压缩文档的查询。
callbacks (Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]) – 在压缩过程中运行的回调。
- 返回
压缩文档的序列。
- 返回类型
Sequence[Document]
- rerank(documents: Sequence[Union[str, Document, dict]]], query: str, *, rank_fields: Optional[Sequence[str]] = None, 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]]) – 要重新排序的文档序列。
rank_fields (Optional[Sequence[str]]) – 用于重新排序的键序列。
model (Optional[str]) – 用于重新排序的模型。默认为 self.model。
top_n (Optional[int]) – 返回的结果数量。如果为 None，则返回所有结果。默认为 self.top_n。
max_chunks_per_doc (Optional[int]) – 从每个文档中推导的最大块数。
- 返回类型
列表[字典[str, Any]]