火山引擎重排序

class langchain_community.document_compressors.volcengine_rerank.VolcengineRerank

基础类：BaseDocumentCompressor

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

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

如果输入数据无法验证以形成有效模型，则引发 [ValidationError][pydantic_core.ValidationError]。

self 被显式地设为仅位置参数，以允许 self 作为字段名称。

param ak: str | None = None

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

param client: Any = None

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

param host: str = 'cn-beijing'

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

param region: str = 'api-vikingdb.volces.com'

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

param sk: str | None = None

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

param top_n: int | None = 3

返回的文档数量。

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]

使用Volcengine的rerank API压缩文档。

Parameters:

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

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

• callbacks (list[BaseCallbackHandler] | BaseCallbackManager | None) – 在压缩过程中运行的回调函数。

Returns:

一系列压缩文档。

Return type:

序列[文档]

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

返回按与提供的查询的相关性排序的文档有序列表。

Parameters:

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

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

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

Return type:

列表[字典[str, 任意]]

使用 VolcengineRerank 的示例

• Volcengine Reranker