langchain_community.document_compressors.volcengine_rerank.VolcengineRerank

class langchain_community.document_compressors.volcengine_rerank.VolcengineRerank

基础： BaseDocumentCompressor

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

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

如果输入数据不能解析成有效的模型，则引发 ValidationError。

参数 ak: Optional[str] = None

访问密钥 ID。 https://www.volcengine.com/docs/84313/1254553

参数 client: Any = None

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

参数 host: str = 'cn-beijing'

https://www.volcengine.com/docs/84313/1254488.

参数 region: str = 'api-vikingdb.volces.com'

https://www.volcengine.com/docs/84313/1254488.

参数 sk: Optional[str] = None

秘密访问密钥。 https://www.volcengine.com/docs/84313/1254553

参数 top_n: Optional[int] = 3

要返回的文档数量。

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]

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

参数

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

• query (str) – 用于压缩文档的查询。

• callbacks (Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]) – 压缩过程中的回调。

返回值

压缩文档序列。

返回类型

Sequence[Document]

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。

返回类型

列表[字典[str, Any]]