VertexAIRank#
- class langchain_google_community.vertex_rank.VertexAIRank[source]#
-
使用可配置参数初始化Vertex AI Ranker。
继承自BaseDocumentCompressor，分别用于文档处理和验证功能。
- project_id#
Google Cloud 项目 ID
- Type:
字符串
- location_id#
排名服务的位置ID。
- Type:
字符串
- ranking_config#
必填。排名服务配置的名称，例如 default_config。 如果未指定，则默认设置为 default_config。
- Type:
字符串
- model#
要使用的模型的标识符。它是以下之一：
semantic-ranker-512@latest: 语义排序模型，最大输入标记大小为512。
如果未指定，默认设置为
semantic-ranker-512@latest。- Type:
字符串
- top_n#
返回的结果数量。如果未设置或不大于零，则返回所有结果。
- Type:
整数
- ignore_record_details_in_response#
如果为真，响应将仅包含记录ID和分数。默认情况下，它为假，响应将包含记录详细信息。
- Type:
布尔
- id_field#
指定一个唯一的文档元数据字段
- Type:
可选[str]
- to use as an id.
- title_field#
指定文档元数据字段
- Type:
可选[str]
- to use as title.
- credentials#
Google Cloud 凭证对象。
- Type:
可选的[凭据]
- credentials_path#
Google Cloud 服务的路径
- Type:
可选[str]
- account credentials file.
VertexAIRanker 的构造函数，允许指定排名配置并初始化 Google Cloud 服务。
接受的参数与上面列出的属性相同。
- param client: Any = None#
- param credentials: Credentials | None = None#
- param credentials_path: str | None = None#
- param id_field: str | None = None#
- param ignore_record_details_in_response: bool = False#
- param location_id: str = 'global'#
- param model: str = 'semantic-ranker-512@latest'#
- param project_id: str = None#
- param ranking_config: str = 'default_config'#
- param title_field: str | None = None#
- param top_n: int = 10#
- 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][source]#
使用Vertex AI的重新排序API压缩文档。
- Parameters:
documents (Sequence[Document]) – 要压缩的Document实例列表。
query (str) – 用于压缩文档的查询字符串。
callbacks (list[BaseCallbackHandler] | BaseCallbackManager | None) – 在压缩期间执行的回调（此处未使用）。
- Returns:
一个压缩后的Document实例列表。
- Return type:
序列[文档]