`langchain_community.embeddings.voyageai`.VoyageEmbeddings¶

class langchain_community.embeddings.voyageai.VoyageEmbeddings[source]¶

基准：BaseModel，Embeddings

自版本 0.0.29 起已废弃：请使用 langchain_voyageai.VoyageAIEmbeddings 代替。

Voyage 嵌入模型。

要使用，您需要设置环境变量 VOYAGE_API_KEY 并使用您的 API 密钥，或者将其作为构造函数的命名参数传递。

示例

from langchain_community.embeddings import VoyageEmbeddings

voyage = VoyageEmbeddings(voyage_api_key="your-api-key", model="voyage-2")
text = "This is a test query."
query_result = voyage.embed_query(text)

通过解析和验证从关键字参数中输入的数据来创建一个新的模型。

如果输入数据无法解析为一个有效的模型，将引发 ValidationError。

参数batch_size: int [必需]¶: 每次 API 请求中嵌入的最大文本数量。

参数max_retries: int = 6¶: 生成时的最大重试次数。

参数model: str [必需]¶

参数request_timeout: Optional[Union[float, Tuple[float,float]]] = None¶: API 请求的超时时间（秒）。

参数show_progress_bar: bool= False¶: 是否在嵌入时显示进度条。如果设置为 True，必须已安装 tqdm。

参数truncation: bool= True¶

是否截断输入文本以适应上下文长度。

如果为真，超过长度限制的输入文本将在嵌入模型向量化之前被截断，以适应上下文长度。如果为假，如果任何给定文本超出上下文长度，将引发错误。

参数 voyage_api_base: str = 'https://api.voyageai.com/v1/embeddings'¶

参数 voyage_api_key: Optional[SecretStr] = None¶

约束

类型 = 字符串
只写 = True
格式 = 密码

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

异步嵌入文档

参数: texts (列表[str]) – 要嵌入的文本列表。
返回: 嵌入列表。
返回类型: 列表[[float]]

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

异步嵌入查询文本。

参数: text (str) – 要嵌入的文本。
返回: 嵌入。
返回类型: 列表[[float]]

embed_documents(texts: List[str]) → List[List[float]]

调用 Voyage 嵌入端点进行嵌入搜索。

参数: texts (列表[str]) – 要嵌入的文本列表。
返回: 每个文本一个嵌入的列表。
返回类型: 列表[[float]]

embed_general_texts(texts: List[str], *, input_type: Optional[str] = None) → List[List[float]][source]¶

调用 VoyageEmbedding 端点为通用文本进行嵌入。

参数

texts (列表[str]) – 要嵌入的文本列表。
input_type (可选项[str]) – 输入文本的类型。默认为 None，表示类型未指定。其他选项：查询，文档。

返回

文本的嵌入。

返回类型

列表[[float]]

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

调用 VoyageEmbedding 端点嵌入查询文本。

参数: text (str) – 要嵌入的文本。
返回: 文本的嵌入。
返回类型: 列表[[float]]

langchain_community.embeddings.voyageai.VoyageEmbeddings¶

`langchain_community.embeddings.voyageai`.VoyageEmbeddings¶