VertexAI嵌入

class langchain_community.embeddings.vertexai.VertexAIEmbeddings

基础类：_VertexAICommon, Embeddings

自版本0.0.12起已弃用：请改用:class:`~langchain_google_vertexai.VertexAIEmbeddings`。在langchain-community==1.0之前不会移除。

Google Cloud VertexAI 嵌入模型。

初始化 sentence_transformer。

param credentials: Any = None

默认使用的自定义凭据 (google.auth.credentials.Credentials)

param location: str = 'us-central1'

进行API调用时使用的默认位置。

param max_output_tokens: int = 128

令牌限制决定了从一个提示中输出的最大文本量。

param max_retries: int = 6

生成时的最大重试次数。

param model_name: str [Required]

底层模型名称。

param n: int = 1

为每个提示生成多少个完成项。

param project: str | None = None

在进行Vertex API调用时使用的默认GCP项目。

param request_parallelism: int = 5

允许向VertexAI模型发出的请求的并行量。

param show_progress_bar: bool = False

是否显示tqdm进度条。必须安装tqdm。

param stop: List[str] | None = None

生成时使用的可选停用词列表。

param streaming: bool = False

是否流式传输结果。

param temperature: float = 0.0

采样温度，它控制着标记选择的随机程度。

param top_k: int = 40

模型如何选择输出的标记，下一个标记是从

param top_p: float = 0.95

从最可能到最不可能选择令牌，直到它们的总和

async aembed_documents(texts: list[str]) → list[list[float]]

异步嵌入搜索文档。

Parameters:

文本 (列表[字符串]) – 要嵌入的文本列表。

Returns:

嵌入列表。

Return type:

列表[列表[浮点数]]

async aembed_query(text: str) → list[float]

异步嵌入查询文本。

Parameters:

文本 (str) – 要嵌入的文本。

Returns:

嵌入。

Return type:

列表[浮点数]

embed(texts: List[str], batch_size: int = 0, embeddings_task_type: Literal['RETRIEVAL_QUERY', 'RETRIEVAL_DOCUMENT', 'SEMANTIC_SIMILARITY', 'CLASSIFICATION', 'CLUSTERING'] | None = None) → List[List[float]]

嵌入字符串列表。

Parameters:

• texts (List[str]) – List[str] 要嵌入的字符串列表。

• batch_size (int) – [int] 发送到模型的嵌入的批量大小。 如果为零，则将在第一次请求时动态检测最大批量大小，从250开始，逐步减少到5。

• embeddings_task_type (Literal['RETRIEVAL_QUERY', 'RETRIEVAL_DOCUMENT', 'SEMANTIC_SIMILARITY', 'CLASSIFICATION', 'CLUSTERING'] | None) –

  [str] 可选的嵌入任务类型， 以下之一

  RETRIEVAL_QUERY - 文本是一个查询

  在搜索/检索设置中。

  RETRIEVAL_DOCUMENT - 文本是一个文档

  在搜索/检索设置中。

  SEMANTIC_SIMILARITY - 嵌入将用于

  语义文本相似性（STS）。

  CLASSIFICATION - 嵌入将用于分类。 CLUSTERING - 嵌入将用于聚类。

Returns:

嵌入列表，每个文本对应一个。

Return type:

列表[列表[float]]

embed_documents(texts: List[str], batch_size: int = 0) → List[List[float]]

嵌入文档列表。

Parameters:

• texts (List[str]) – List[str] 要嵌入的文本列表。

• batch_size (int) – [int] 发送到模型的嵌入的批量大小。 如果为零，则将在第一次请求时动态检测最大批量大小，从250开始，逐步减少到5。

Returns:

嵌入列表，每个文本对应一个。

Return type:

列表[列表[float]]

embed_query(text: str) → List[float]

嵌入一段文本。

Parameters:

文本 (str) – 要嵌入的文本。

Returns:

文本的嵌入。

Return type:

列表[float]

classmethod validate_environment(values: Dict) → Dict

验证Python包是否存在于环境中。

Parameters:

值 (字典)

Return type:

字典

property is_codey_model: bool

task_executor: ClassVar[Executor | None] = FieldInfo(annotation=NoneType, required=False, default=None, exclude=True)