访问 Voyage AI模型

Embedding and Reranking API处于预览版中。在预览期间，该功能和相应的文档可能随时更改。

您可以使用 Embedding and Reranking API（可通过MongoDB Atlas获取）访问权限Voyage AI模型。使用以下方法访问权限API：

REST API：用于与语言无关的访问权限。
Python客户端：官方客户端，易于使用。

本页概述了如何访问权限API。有关API的完整详情，包括速率限制和使用层级，请参阅 API参考文档。

API 密钥

Embedding and Reranking API使用API密钥来监控使用情况和管理权限。要创建和管理模型API密钥，请使用MongoDB Atlas用户界面。有关说明，请参阅模型API密钥。

REST API

以下示例演示了如何通过REST API调用嵌入服务。该API支持 cURL 以及来自任何编程语言的HTTP请求。

身份验证是通过模型API密钥处理的，您必须将其作为持有者令牌包含在每个API请求的授权标头中。

要学习；了解更多信息，请参阅完整的API规范。

语言

Python客户端

要使用 pip 安装官方Python包：

pip install --upgrade voyageai

使用--upgrade 或-U 选项安装最新版本的包。这使您访问权限最新的功能和错误修复。有关特定于模型的参数，请参阅每个模型页面的用法示例。

重要

您必须使用 0.3.7 或更高版本的Python客户端端库。此版本增加了对嵌入和重新排名API的支持。

voyageai.Client 类提供了一个同步接口来调用 Voyage 的API。创建客户端对象并使用它来访问权限Voyage AI模型。

例子

以下示例展示了如何使用自定义设置初始化客户端并生成嵌入：

import voyageai
# Initialize the client with custom settings
vo = voyageai.Client(
    api_key="<model-api-key>",  # Or use VOYAGE_API_KEY environment variable
    max_retries=3,              # Retry up to 3 times on rate limit errors
    timeout=30                  # Timeout after 30 seconds
)
# Generate embeddings
result = vo.embed(
    texts=["MongoDB is redefining what a database is in the AI era."],
    model="voyage-4-large"
)
print(f"Embedding dimension: {len(result.embeddings[0])}")
print(f"Total tokens used: {result.total_tokens}")

下表描述了初始化客户端时可以传递的参数：

Parameter	类型	必需	说明
`api_key`	字符串	No	模型API密钥。默认为“无”。如果为“无”，客户端将按以下顺序搜索API密钥： `voyageai.api_key_path`，包含密钥的文件路径环境变量 `VOYAGE_API_KEY_PATH`，可设立为包含密钥的文件的路径 `voyageai.api_key`，这是 voyageai 模块的一个属性，可用于存储密钥环境变量 `VOYAGE_API_KEY` 注意： Python客户端根据API密钥格式自动将请求路由到正确的API端点：在MongoDB Atlas中创建的模型API密钥会路由到`https://ai.mongodb.com/` 端点。在 Voyage 平台上创建的API密钥会路由到 `https://api.voyageai.com/` 端点。您可以通过在创建客户端时设置 `base_url` 参数来覆盖此行为。
`max_retries`	整型	No	在出现速率限制错误或服务器临时不可用的情况下，每个API请求的最大重试次数。默认为 0。客户端采用等待并重试策略来处理此类错误，并在达到最大重试限制时引发异常。默认下，客户端不会重试。
`timeout`	整型	No	中止请求之前等待API响应的最长时间（以秒为单位）。默认为“无”。如果超过指定的超时时间，则请求将终止并引发超时异常。默认下，不实施任何超时约束。
`base_url`	字符串	No	API请求的自定义基本URL 。默认下，客户端会根据提供的API密钥自动检测正确的端点。

后退

模型