langchain_google_vertexai.embeddings.VertexAIEmbeddings

class langchain_google_vertexai.embeddings.VertexAIEmbeddings[source]

基类： _VertexAICommon, Embeddings

Google Cloud VertexAI 嵌入模型。

初始化 sentence_transformer。

param additional_headers: Optional[Dict[str, str]] = None

一个键值字典，表示模型调用的附加标头

param api_endpoint: Optional[str] = None (别名 'base_url')

所需的 API 端点，例如 us-central1-aiplatform.googleapis.com

param api_transport: Optional[str] = None

所需的 API 传输方法，可以是 ‘grpc’ 或 ‘rest’。如果已定义，则使用 vertexai.init 中的默认参数。

param client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None

一个回调函数，返回客户端证书字节和私钥字节

param credentials: Any = None

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

param full_model_name: Optional[str] = None

模型端点的完整名称。

param location: str = 'us-central1'

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

param max_output_tokens: Optional[int] = None (别名 'max_tokens')

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

param max_retries: int = 6

生成时进行的最大重试次数。

param model_name: str = None (别名 'model')

底层模型名称。

param n: int = 1

为每个提示生成多少个补全。

param project: Optional[str] = None

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

param request_parallelism: int = 5

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

param safety_settings: Optional['SafetySettingsType'] = None

用于所有生成的默认安全设置。

例如

from langchain_google_vertexai import HarmBlockThreshold, HarmCategory

safety_settings = {

HarmCategory.HARM_CATEGORY_UNSPECIFIED: HarmBlockThreshold.BLOCK_NONE, HarmCategory.HARM_CATEGORY_DANGEROUS_CONTENT: HarmBlockThreshold.BLOCK_MEDIUM_AND_ABOVE, HarmCategory.HARM_CATEGORY_HATE_SPEECH: HarmBlockThreshold.BLOCK_ONLY_HIGH, HarmCategory.HARM_CATEGORY_HARASSMENT: HarmBlockThreshold.BLOCK_LOW_AND_ABOVE, HarmCategory.HARM_CATEGORY_SEXUALLY_EXPLICIT: HarmBlockThreshold.BLOCK_NONE,

}

param stop: Optional[List[str]] = None (别名 'stop_sequences')

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

param streaming: bool = False

是否流式传输结果。

param temperature: Optional[float] = None

采样温度，它控制令牌选择中随机性的程度。

param top_k: Optional[int] = None

模型如何选择令牌进行输出，下一个令牌从以下项中选择

param top_p: Optional[float] = None

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

param tuned_model_name: Optional[str] = None

已调优模型的名称。如果传递了 tuned_model_name，则 model_name 将用于确定模型系列

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

异步嵌入搜索文档。

参数

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

返回

嵌入列表。

返回类型

List[List[float]]

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

异步嵌入查询文本。

参数

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

返回

嵌入。

返回类型

List[float]

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

嵌入字符串列表。

参数

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

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

  • embeddings_task_type (Optional[Literal['RETRIEVAL_QUERY', 'RETRIEVAL_DOCUMENT', 'SEMANTIC_SIMILARITY', 'CLASSIFICATION', 'CLUSTERING', 'QUESTION_ANSWERING', 'FACT_VERIFICATION']]) –

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

    RETRIEVAL_QUERY - 文本是查询

    在搜索/检索设置中。

    RETRIEVAL_DOCUMENT - 文本是文档

    在搜索/检索设置中。

    SEMANTIC_SIMILARITY - 嵌入将用于

    语义文本相似度 (STS)。

    CLASSIFICATION - 嵌入将用于分类。CLUSTERING - 嵌入将用于聚类。以下仅在预览模型上受支持：QUESTION_ANSWERING FACT_VERIFICATION

  • dimensions (Optional[int]) – [int] 可选。输出嵌入维度。仅在预览模型上受支持。

返回

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

返回类型

List[List[float]]

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

嵌入文档列表。

参数

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

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

返回

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

返回类型

List[List[float]]

embed_image(image_path: str, contextual_text: Optional[str] = None) → List[float][source]

嵌入图像。

参数

  • image_path (str) – 生成嵌入的图像路径（本地、Google Cloud Storage 或 Web）

  • for. (embeddings) –

  • contextual_text (Optional[str]) – 用于生成嵌入的文本。

返回

图像的嵌入。

返回类型

List[float]

embed_query(text: str) → List[float][source]

嵌入文本。

参数

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

返回

文本的嵌入。

返回类型

List[float]

get_num_tokens(text: str) → int

获取文本中存在的令牌数量。

用于检查输入是否适合模型的上下文窗口。

参数

text (str) – 要标记化的字符串输入。

返回

文本中令牌的整数数量。

返回类型

int

property async_prediction_client: PredictionServiceAsyncClient

返回 PredictionServiceClient。

property model_type: str
property model_version: GoogleEmbeddingModelVersion
property prediction_client: PredictionServiceClient

返回 PredictionServiceClient。

task_executor: ClassVar[Optional[Executor]] = FieldInfo(exclude=True, extra={})

使用 VertexAIEmbeddings 的示例