langchain_voyageai.rerank.VoyageAIRerank

class langchain_voyageai.rerank.VoyageAIRerank

基类: BaseDocumentCompressor

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

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

如果输入数据无法解析来形成有效的模型，则引发 ValidationError。

参数 aclient: AsyncClient = None

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

参数 client: Client = None

参数 model: str [必需]

用于重排序的模型。

参数 top_k: 可选[int] = None

返回的文档数量。

参数 truncation: 布尔值 = True

参数 voyage_api_key: 可选[SecretStr] = None

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

约束

• 类型 = 字符串

• 只写 = True

• 格式 = 密码

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

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

参数

• 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]

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

参数

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

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

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

返回值

按相关度评分排序的压缩文档序列。

返回类型

Sequence[Document]