langchain_community.document_compressors.dashscope_rerank.DashScopeRerank

class langchain_community.document_compressors.dashscope_rerank.DashScopeRerank

继承自: BaseDocumentCompressor

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

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

如果输入数据无法解析为有效的模型，将引发ValidationError。

参数client : Any = None

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

参数dashscope_api_key : Optional[str] = None (别名 'api_key')

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

参数model : Optional[str] = None

用于重排的模型。

参数top_n : Optional[int] = 3

要返回的文档数量。

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

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

参数

• 文档 (序列[文档]) – 获取到的文档。

• 查询 (字符串) – 查询上下文。

• 回调 (可选[联合[列表[基本回调处理程序], 基本回调管理器]]) – 在压缩过程中可选的回调。

返回值

压缩后的文档。

返回类型

序列[文档]

compress_documents(documents: Sequence[文档], query: str, callbacks: Optional[Union[列表[基本回调处理程序], 基本回调管理器]] = None) → Sequence[文档]

使用DashScope的重新排名API压缩文档。

参数

• 文档 (序列[文档]) – 要压缩的文档序列。

• 查询 (字符串) – 用于压缩文档的查询。

• 回调 (可选[联合[列表[基本回调处理程序], 基本回调管理器]]) – 在压缩过程中运行的回调。

返回值

压缩后的文档序列。

返回类型

序列[文档]

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

根据提供的查询顺序返回文档的有序列表。

参数

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

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

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

返回类型

List[Dict[str, Any]]