langchain_google_community.vertex_rank.VertexAIRank

类 langchain_google_community.vertex_rank.VertexAIRank[源代码]

基础： BaseDocumentCompressor

使用可配置参数初始化 Vertex AI Ranker。

分别继承自 BaseDocumentCompressor 以实现文档处理和验证功能。

project_id

Google Cloud 项目 ID

类型

str

location_id

排序服务的位置 ID。

类型

str

ranking_config

必需。排序服务配置的名称，例如 default_config。默认情况下，如果没有指定，则设置为 default_config。

类型

str

model

使用的模型的标识符。它是以下之一

  • semantic-ranker-512@latest：最大输入令牌大小为 512 的语义排名模型。

如果没有指定，默认设置为 semantic-ranker-512@latest。

类型

str

top_n

要返回的结果数量。如果没有设置或小于或等于零，则返回所有结果。

类型

int

ignore_record_details_in_response

如果为 true，则响应将仅包含记录 ID 和分数。默认情况下为 false，响应将包含记录详情。

类型

bool

id_field

指定一个唯一的文档元数据字段

类型

Optional[str]

用于 作为 id.
title_field

指定用作标题的文档元数据字段

类型

Optional[str]

to use as title.
credentials

Google Cloud 凭据对象。

类型

Optional[Credentials]

credentials_path

Google Cloud 服务凭据文件的路径。

类型

Optional[str]

account credentials file.

VertexAIRanker 构造函数，允许指定排序配置和初始化 Google Cloud 服务。

接受的参数与上面列出的属性相同。

param client : Any = None
参数credentials: 可选Ellipse[Credentials] = None
参数credentials_path: 可选Ellipse[str] = None
参数id_field: 可选Ellipse[str] = None
参数ignore_record_details_in_response: bool = False
参数location_id: str = 'global'
参数model: str = 'semantic-ranker-512@latest'
参数project_id: str = None
参数ranking_config: str = 'default_config'
参数title_field: 可选Ellipse[str] = None
参数top_n: int = 10
async acompress_documents(documents: Sequence[Document], query: str, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None) → Sequence[Document]

根据查询上下文异步压缩检索到的文档。

参数
返回

压缩后的文档。

返回类型

Sequence[Document]

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

使用Vertex AI的重排序API压缩文档。

参数

  • documents (Sequence[Document]) – 要压缩的Document实例列表。

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

  • callbacks (Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]) – 压缩过程中执行的回调函数（在此未使用）。

返回

压缩后的Document实例列表。

返回类型

Sequence[Document]