VoyageEmbeddings

class langchain_community.embeddings.voyageai.VoyageEmbeddings

基础类：BaseModel, Embeddings

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

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][pydantic_core.ValidationError]。

self 被显式地设为仅位置参数，以允许 self 作为字段名称。

param batch_size: int [Required]

每个API请求中嵌入的最大文本数量。

param max_retries: int = 6

生成时的最大重试次数。

param model: str [Required]

param request_timeout: float | Tuple[float, float] | None = None

API请求的超时时间（以秒为单位）。

param show_progress_bar: bool = False

是否在嵌入时显示进度条。如果设置为True，则必须安装tqdm。

param truncation: bool = True

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

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

param voyage_api_base: str = 'https://api.voyageai.com/v1/embeddings'

param voyage_api_key: SecretStr | None = None

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_documents(texts: List[str]) → List[List[float]]

调用Voyage Embedding端点以嵌入搜索文档。

Parameters:

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

Returns:

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

Return type:

列表[列表[float]]

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

调用Voyage Embedding端点以嵌入一般文本。

Parameters:

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

• input_type (str | None) – 输入文本的类型。默认为 None，表示类型未指定。其他选项：query, document。

Returns:

文本的嵌入。

Return type:

列表[列表[float]]

embed_query(text: str) → List[float]

调用Voyage Embedding端点以嵌入查询文本。

Parameters:

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

Returns:

文本的嵌入。

Return type:

列表[float]