迁移应用程序以使用Atlas Embedding and Reranking API

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

如果您是 Voyage AI 的现有用户，请完成以下步骤，迁移应用程序以使用Atlas Embedding and Reranking API。

步骤

注册一个免费的Atlas帐户或登录。

如果您是Atlas的新用户，它会为您创建一个组织和项目。

要学习；了解更多信息，请参阅创建Atlas帐户。

为您的项目创建模型API密钥。

在Atlas项目中，从导航栏中选择 AI Models。
单击 Create model API key（连接）。
为API密钥命名，然后单击 Create。

要确认API密钥有效，您可以向 Embedding and Reranking API发出测试请求：

curl \
  --request POST 'https://ai.mongodb.com/v1/embeddings' \
  --header "Authorization: Bearer $VOYAGE_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "input": "Sample text",
    "model": "voyage-4-lite",
    "input_type": "document"
  }'

要学习；了解有关创建和管理API密钥的更多信息，请参阅模型API密钥。

将现有的 Voyage API密钥替换为模型API密钥。

示例，如果您将API密钥设立为环境变量，更新该值：

VOYAGE_API_KEY="<your-new-model-api-key>"

如果直接在代码中传递API密钥，请在初始化客户端或发出API请求时更新该值。

注意

如果将API密钥设立为环境变量，则可以运行以下命令来验证变量是否已设立：

echo $VOYAGE_API_KEY

将显式API端点替换为嵌入和重新排名API端点。

如果您的应用程序显式指定了API端点，请将其更新为使用等效的 Embedding 和 Reranking API API端点：

旧端点	新端点
`https://api.voyageai.com/v1/embeddings`	`https://ai.mongodb.com/v1/embeddings`
`https://api.voyageai.com/v1/rerank`	`https://ai.mongodb.com/v1/rerank`
`https://api.voyageai.com/v1/multimodalembeddings`	`https://ai.mongodb.com/v1/multimodalembeddings`
`https://api.voyageai.com/v1/contextualizedembeddings`	`https://ai.mongodb.com/v1/contextualizedembeddings`

注意

如果您使用 voyageai Python客户端（版本 0.3.7 或更高版本），该客户端会根据API密钥格式自动将请求路由到正确的端点。如果您在未显式设置 base_url 参数的情况下使用客户端，则无需更改端点。

要学习；了解更多信息，请参阅Python客户端。

验证您的应用程序是否可以使用新的API密钥。

测试您的应用程序，确保其使用 Embedding 和 Reranking API正确生成嵌入并执行重排名操作。

删除旧的 Voyage AI API密钥。

确认您的应用程序可使用模型API密钥后，请从 Voyage AI平台中删除旧API密钥，以防止未经授权的访问权限。