VoyageAIRerank#
- class langchain_voyageai.rerank.VoyageAIRerank[source]#
-
使用VoyageAI Rerank API的文档压缩器。
通过解析和验证来自关键字参数的输入数据来创建一个新模型。
如果输入数据无法验证以形成有效模型，则引发 [ValidationError][pydantic_core.ValidationError]。
self 被显式地设为仅位置参数，以允许 self 作为字段名称。
- param aclient: voyageai.AsyncClient = None#
VoyageAI 客户端用于压缩文档。
- param client: voyageai.Client = None#
- param model: str [Required]#
用于重新排序的模型。
- param top_k: int | None = None#
返回的文档数量。
- param truncation: bool = True#
- param voyage_api_key: SecretStr | None = None#
VoyageAI API 密钥。必须直接指定或通过环境变量 VOYAGE_API_KEY 指定。
- async acompress_documents(documents: Sequence[Document], query: str, callbacks: list[BaseCallbackHandler] | BaseCallbackManager | None = None) Sequence[Document][source]#
使用VoyageAI的重新排序API压缩文档。
- 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]#
使用VoyageAI的重新排序API压缩文档。
- Parameters:
documents (Sequence[Document]) – 要压缩的文档序列。
query (str) – 用于压缩文档的查询。
callbacks (list[BaseCallbackHandler] | BaseCallbackManager | None) – 在压缩过程中运行的回调函数。
- Returns:
一系列按相关性分数排序的压缩文档。
- Return type:
序列[文档]