模型API密钥

模型API密钥提供服务Embedding 和 Reranking API的身份验证和授权机制，启用您能够通过API访问权限Voyage AI模型。本页介绍如何在Atlas用户界面中创建和管理API密钥。

注意

它被命名为模型API密钥，以区别于Atlas中的其他API密钥。使用此密钥的方式与使用其他模型提供商的API密钥的方式相同。

创建和管理模型API密钥

您可以从Atlas用户界面中的组织和项目级别创建和管理模型API密钥。速率限制应用于API密钥，具体取决于您是在组织还是项目级别创建的。

所需权限

要创建、更新和删除模型API密钥，请执行以下操作：

在组织级别，您必须拥有Organization Owner访问权限。
在项目级别，您必须拥有对Atlas的Project Model Owner、Project Owner或更高访问权限。

要查看模型API密钥，请执行以下操作：

在组织和项目级别，您必须对Atlas拥有 Organization Read Only 或更高访问权限。
仅在项目级别，您必须对Atlas具有 Project Read Only 或更高访问权限。

有关每个角色权限的完整列表，请参阅组织和项目访问权限。

创建 API 密钥

在组织级别创建模型API密钥时，请将密钥链接到项目。创建密钥后，您无法更改密钥链接到的项目。速率限制应用于项目中的每个键。

注意

如果您通过Atlas创建模型API密钥（如以下过程所述），则该密钥仅对针对 https://ai.mongodb.com/v1/embeddings 的请求进行身份验证。相反，如果您直接通过 VoyageAI 创建密钥，它将验证对 https://api.voyageai.com/v1/embeddings 的请求。

要在组织级别创建模型API密钥，请完成以下步骤：

登录Atlas。

Go Atlas用户界面中的 AI Models 页面。

如果尚未显示，组织从导航栏中的Organizations菜单。
在组织级别，单击导航栏 Services 标题下的 Model API Keys。

创建模型API密钥。

单击 Create new model API key（连接）。
输入密钥的名称。
模型API密钥不能超过 250 个字符。
从下拉列表中选择一个项目以与API密钥链接。
单击 Create（连接）。

保存API密钥。

复制模型API密钥并将其存储在安全位置。
离开显示密钥的页面后，将无法再次查看。如果丢失，请创建一个新的。
单击 Done（连接）。

要在项目级别创建模型API密钥，请完成以下步骤：

登录Atlas。

Go Atlas用户界面中的 AI Models 页面。

如果尚未显示，组织从导航栏中的Organizations菜单。
如果尚未显示，请从导航栏的Projects菜单中选择所需的项目。
在项目级别，单击导航栏 Services 标题下的 AI Models。

创建模型API密钥。

如果尚未显示，请从导航栏中选择 Model API Keys。
单击 Create model API key（连接）。
输入密钥的名称。
模型API密钥不能超过 250 个字符。
单击 Create（连接）。

保存API密钥。

复制模型API密钥并将其存储在安全位置。
离开显示密钥的页面后，将无法再次查看。如果丢失，请创建一个新的。
单击 Done（连接）。

查看API密钥

组织所有者可以查看和编辑组织级别的所有模型API密钥。项目所有者只能查看和编辑他们有权访问权限的项目的模型API密钥。

要在组织级别查看模型API密钥，请完成以下步骤：

登录Atlas。

Go Atlas用户界面中的 AI Models 页面。

如果尚未显示，组织从导航栏中的Organizations菜单。
在组织级别，单击导航栏 Services 标题下的 Model API Keys。

对于每个模型 API 密钥，该页面显示以下内容：

列名称	列值说明
Name	模型 API 密钥的名称。
Secret Key	与模型 API 密钥名称关联的编辑模型 API 密钥。
Created On (UTC)	用户创建模型 API 密钥的 UTC 日期。
Last Used (UTC)	模型 API 密钥上次使用的 UTC 日期。如果密钥是新密钥或从未使用，则值为 `Never`。
Project	与模型 API 密钥链接的项目名称。
Created By	创建密钥的用户名。
Actions	可以对密钥采取的操作。您可以单击：编辑模型 API 密钥。删除模型 API 密钥。

要在项目级别查看模型API密钥，请完成以下步骤：

登录Atlas。

Go Atlas用户界面中的 AI Models 页面。

如果尚未显示，组织从导航栏中的Organizations菜单。
如果尚未显示，请从导航栏的Projects菜单中选择所需的项目。
在项目级别，单击导航栏 Services 标题下的 AI Models。

对于每个模型 API 密钥，页面会显示有关该密钥的以下信息：

列名称	列值说明
Name	模型 API 密钥的名称。
Secret Key	与模型 API 密钥名称关联的编辑模型 API 密钥。
Created On (UTC)	用户创建模型 API 密钥的 UTC 日期。
Last Used (UTC)	模型 API 密钥上次使用的 UTC 日期。如果密钥是新密钥或从未使用，则值为 `Never`。
Project	与模型 API 密钥链接的项目名称。
Created By	创建密钥的用户名。
Actions	可以对密钥采取的操作。您可以单击：编辑模型 API 密钥。删除模型 API 密钥。

编辑API密钥

要在组织级别编辑模型API密钥，请完成以下步骤：

登录Atlas。

Go Atlas用户界面中的 AI Models 页面。

如果尚未显示，组织从导航栏中的Organizations菜单。
在组织级别，单击导航栏 Services 标题下的 Model API Keys。

编辑密钥。

在 Actions 列中，单击与要编辑的密钥相对应的按钮。
在 Edit Model API Key 页面中，修改模型API密钥的名称。
模型API密钥名称对于项目必须是唯一的，长度最多为 250 个字符。
单击 Save（保存）以应用更改。

要在项目级别编辑模型API密钥，请完成以下步骤：

登录Atlas。

Go Atlas用户界面中的 AI Models 页面。

如果尚未显示，组织从导航栏中的Organizations菜单。
如果尚未显示，请从导航栏的Projects菜单中选择所需的项目。
在项目级别，单击导航栏 Services 标题下的 AI Models。

编辑密钥。

在 Actions 列中，单击与要编辑的密钥相对应的按钮。
在 Edit Model API Key 页面中，修改模型API密钥的名称。
该名称在项目中必须是唯一的，长度最多为 250 个字符。
单击 Save（保存）以应用更改。

删除 API 密钥。

当你删除模型API密钥时，MongoDB会立即禁用该密钥并拒绝使用已删除密钥发出的任何API请求。删除密钥后，您将无法查看、恢复或修改它。

要在组织级别删除模型API密钥，请完成以下步骤：

登录Atlas。

Go Atlas用户界面中的 AI Models 页面。

如果尚未显示，组织从导航栏中的Organizations菜单。
在组织级别，单击导航栏 Services 标题下的 Model API Keys。

删除密钥。

在 Actions 列中，单击与要删除的密钥对应的按钮。
在确认模式中，单击 Delete key 以删除密钥。

要在项目级别删除模型API密钥，请完成以下步骤：

登录Atlas。

Go Atlas用户界面中的 AI Models 页面。

如果尚未显示，组织从导航栏中的Organizations菜单。
如果尚未显示，请从导航栏的Projects菜单中选择所需的项目。
在项目级别，单击导航栏 Services 标题下的 AI Models。

删除密钥。

在 Actions 列中，单击与要删除的密钥对应的按钮。
在确认模式中，单击 Delete key 以删除密钥。

后续步骤

创建模型API密钥后，您可以：

来年

组织和项目访问权限