`langchain_community.embeddings.vertexai`.VertexAIEmbeddings¶

class langchain_community.embeddings.vertexai.VertexAIEmbeddings[源代码]¶

基类： _VertexAICommon，Embeddings

自版本 0.0.12 起已弃用：使用 langchain_google_vertexai.VertexAIEmbeddings 代替。

Google Cloud VertexAI嵌入模型。

初始化 sentence_transformer。

参数 credentials: 任意 = None¶: 默认的自定义身份验证凭证（google.auth.credentials.Credentials）以供使用

参数 location: 字符串 = 'us-central1'¶: 在调用API时用作默认位置。

参数 max_output_tokens: 整数 = 128¶: 标记限制决定了一个提示词的文本输出最大量。

参数 max_retries: 整数 = 6¶: 在生成时尝试的最大次数。

参数 model_name [必填]¶: 底层模型名称。

参数 n: 整数 = 1¶: 对于每个提示，生成多少次补全。

参数 project: Optional[str] = None¶: 在调用 Vertex API 时使用的默认 GCP 项目。

参数 request_parallelism: int = 5¶: 对于发送给 VertexAI 模型的请求允许的并行度。

参数 show_progress_bar: bool = False¶: 是否显示 tqdm 进度条。必须已安装 tqdm。

参数 stop: Optional[List[str]] = None¶: 当生成文本时使用的可选停用词列表。

参数 streaming: bool = False¶: 是否流式传输结果。

参数 temperature: float = 0.0¶: 采样温度，它控制了选择标记时的随机程度。

参数 top_k: int = 40¶: 模型如何选择输出标记，下一标记将从

参数 top_p: float = 0.95¶: 从最可能到最不可能选择标记，直到它们的和达到

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']] = None) → List[List[float]][source]¶

将字符串列表嵌入。

参数

texts (List[str]) – 要嵌入的字符串列表。
batch_size (int) – [int] 将嵌入的数据发送到模型的批次大小。如果为零，则在第一次请求时会动态检测最大的批次大小，从250开始，到5结束。
embeddings_task_type (Optional[Literal['RETRIEVAL_QUERY', 'RETRIEVAL_DOCUMENT', 'SEMANTIC_SIMILARITY', 'CLASSIFICATION', 'CLUSTERING']]) –
[str] 可选嵌入任务类型，以下之一

RETRIEVAL_QUERY - 文本是一个查询
在搜索/检索设置中。

检索文档 - 文本是一个文档
在搜索/检索设置中。

语义相似性 - 将使用嵌入进行。
用于语义文本相似度（STS）。

分类 - 将使用嵌入进行分类。聚簇 - 将使用嵌入进行聚簇。

返回

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

返回类型

List[List[float]]

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

嵌入文档列表。

参数

texts (列表[字符串]) – 要嵌入的文本列表。
batch_size (int) – [int] 将嵌入的数据发送到模型的批次大小。如果为零，则在第一次请求时会动态检测最大的批次大小，从250开始，到5结束。

返回

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

返回类型

List[List[float]]

embed_query(text: 字符串) → List[float][source]¶

嵌入文本。

参数: text (字符串) – 要嵌入的文本。
返回: 文本的嵌入。
返回类型: List[float]

属性 is_codey_model: bool¶

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

langchain_community.embeddings.vertexai.VertexAIEmbeddings¶

使用VertexAIEmbeddings的示例¶

`langchain_community.embeddings.vertexai`.VertexAIEmbeddings¶