CohereRerank#
- class langchain_cohere.rerank.CohereRerank[source]#
-
使用Cohere Rerank API的文档压缩器。
通过解析和验证来自关键字参数的输入数据来创建一个新模型。
如果输入数据无法验证以形成有效模型，则引发 [ValidationError][pydantic_core.ValidationError]。
self 被显式地设为仅位置参数，以允许 self 作为字段名称。
- param client: Any = None#
用于压缩文档的Cohere客户端。
- param cohere_api_key: SecretStr | None [Optional]#
Cohere API 密钥。必须直接指定或通过环境变量 COHERE_API_KEY 指定。
- param model: str | None = None#
用于重新排序的模型。必须指定模型名称。
- param top_n: int | None = 3#
返回的文档数量。
- param user_agent: str = 'langchain:partner'#
发出请求的应用程序的标识符。
- async acompress_documents(documents: Sequence[Document], query: str, callbacks: list[BaseCallbackHandler] | BaseCallbackManager | None = None) Sequence[Document]#
根据查询上下文异步压缩检索到的文档。
- Parameters:
documents (Sequence[Document]) – 检索到的文档。
query (str) – 查询上下文。
callbacks (list[BaseCallbackHandler] | BaseCallbackManager | None) – 在压缩过程中运行的可选回调函数。
- Returns:
压缩的文档。
- Return type:
序列[文档]
- compress_documents(documents: Sequence[Document], query: str, callbacks: list[BaseCallbackHandler] | BaseCallbackManager | None = None) Sequence[Document][source]#
使用Cohere的重新排序API压缩文档。
- Parameters:
documents (Sequence[Document]) – 要压缩的文档序列。
query (str) – 用于压缩文档的查询。
callbacks (list[BaseCallbackHandler] | BaseCallbackManager | None) – 在压缩过程中运行的回调函数。
- Returns:
一系列压缩文档。
- Return type:
序列[文档]
- rerank(documents: Sequence[str | Document | dict], query: str, *, rank_fields: Sequence[str] | None = None, model: str | None = None, top_n: int | None = -1, max_chunks_per_doc: int | None = None) List[Dict[str, Any]][source]#
返回按与提供的查询的相关性排序的文档有序列表。
- Parameters:
query (str) – 用于重新排序的查询。
documents (Sequence[str | Document | dict]) – 需要重新排序的文档序列。
rank_fields (Sequence[str] | None) – 用于重新排序的键序列。
model (str | None) – 用于重新排序的模型。默认为 self.model。
top_n (int | None) – 返回的结果数量。如果为None，则返回所有结果。 默认为self.top_n。
max_chunks_per_doc (int | None) – 从文档中派生的最大块数。
- Return type:
列表[字典[str, 任意]]