WatsonxRerank#
- class langchain_ibm.rerank.WatsonxRerank[源代码]#
-
使用watsonx Rerank API的文档压缩器。
通过解析和验证来自关键字参数的输入数据来创建一个新模型。
如果输入数据无法验证以形成有效模型，则引发 [ValidationError][pydantic_core.ValidationError]。
self 被显式地设为仅位置参数，以允许 self 作为字段名称。
- param apikey: SecretStr | None [Optional]#
Watson Machine Learning 或 CPD 实例的 API 密钥。
- param instance_id: SecretStr | None [Optional]#
CPD实例的Instance_id。
- param model_id: str [Required]#
使用的模型类型。
- param params: dict | RerankParameters | None = None#
在请求生成期间使用的模型参数。
- param password: SecretStr | None [Optional]#
CPD实例的密码。
- param project_id: str | None = None#
Watson Studio 项目的 ID。
- param space_id: str | None = None#
Watson Studio 空间的 ID。
- param streaming: bool = False#
是否流式传输结果。
- param token: SecretStr | None [Optional]#
CPD实例的令牌。
- param url: SecretStr [Optional]#
Watson Machine Learning 或 CPD 实例的 URL。
- param username: SecretStr | None [Optional]#
CPD实例的用户名。
- param validate_model: bool = True#
模型ID验证。
- param verify: str | bool | None = None#
您可以传递以下之一作为验证： * CA_BUNDLE文件的路径 * 包含受信任CA证书的目录路径 * True - 将采用默认的信任库路径 * False - 将不进行验证
- param version: SecretStr | None = None#
CPD实例的版本。
- param watsonx_client: APIClient | None = None#
- 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, **kwargs: Any) Sequence[Document][source]#
使用watsonx的rerank API压缩文档。
- Parameters:
documents (Sequence[Document]) – 要压缩的文档序列。
query (str) – 用于压缩文档的查询。
callbacks (list[BaseCallbackHandler] | BaseCallbackManager | None) – 在压缩过程中运行的回调函数。
kwargs (Any)
- Returns:
一系列压缩文档。
- Return type:
序列[文档]