As chaves da API do modelo servem como o mecanismo de autenticação e autorização para a API de incorporação e reclassificação e permitem acessar os modelos do Voyage AI por meio da API. Esta página descreve como criar e gerenciar suas chaves de API na IU do Atlas.
Observação
Ele é nomeado chave de API do modelo para diferenciá-lo de outras chaves de API no Atlas. Use essa chave da mesma forma que as chaves API de outros fornecedores de modelos.
Criar e gerenciar chaves de API do modelo
Você pode criar e gerenciar chaves de API de modelo a partir da IU do Atlas nos níveis de organização e projeto. Os limites de taxa se aplicam às chaves de API com base no fato de você criá-las no nível da organização ou do projeto.
Permissões necessárias
Para criar, atualizar e excluir chaves de API do modelo:
No nível da organização , você deve ter acesso ao
Organization OwnerAtlas.No nível do projeto , você deve ter acesso, ou superior ao
Project Model OwnerProject OwnerAtlas.
Para visualizar as chaves de API do modelo:
Nos níveis de organização e projeto , você deve ter acesso ou superior ao
Organization Read OnlyAtlas.Somente no nível do projeto , você deve ter acesso ou superior ao
Project Read OnlyAtlas.
Para obter uma lista completa de permissões para cada função, consulte Acesso a organização e projeto.
Criar uma chave API
Ao criar uma chave de API de modelo no nível da organização, vincule a chave a um projeto. Depois de criar a chave, você não poderá alterar a qual projeto a chave está vinculada. Os limites de taxa se aplicam a cada chave no projeto.
Observação
Se você criar uma chave de API de modelo por meio do Atlas, conforme descrito no procedimento a seguir, a chave autenticará solicitações para os endpoints ai.mongodb.com . Por outro lado, se você criar uma chave diretamente por meio da VoyageAI, ela autenticará as solicitações para https://api.voyageai.com/v1/embeddings.
Você também define o escopo da chave ao criá-la. Para saber mais, consulte Escopo da chave.
Para criar chaves de API do modelo no nível da organização , complete as seguintes etapas:
Conecte-se ao Atlas.
Crie a chave API do modelo.
Clique em Create new model API key.
Insira um nome para a chave.
As chaves da API do modelo não podem exceder 250 caracteres.
Selecione um projeto no menu suspenso para vincular à chave de API.
Selecione um provedor de nuvem no menu suspenso Cloud provider.
Selecione
anypara deixar a dimensão de nuvem sem escopo.Opcional. Selecione uma localização geográfica no menu suspenso Geography.
A maioria das chaves não precisa de uma localização geográfica. Selecione
anypara deixar a dimensão geográfica sem escopo.O Atlas exibe o API Endpoint somente leitura para o escopo que você seleciona. A chave autentica neste endpoint.
Clique em Create.
Para criar chaves de API do modelo no nível do projeto , complete as seguintes etapas:
Conecte-se ao Atlas.
Vá para a página AI Model APIs no Atlas IU.
Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.
Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.
No nível do projeto , clique em AI Model APIs sob o cabeçalho Services na barra de navegação.
Crie a chave API do modelo.
Se ainda não tiver sido exibido, selecione Model API Keys na barra de navegação.
Clique em Create model API key.
Insira um nome para a chave.
As chaves da API do modelo não podem exceder 250 caracteres.
Selecione um provedor de nuvem no menu suspenso Cloud provider.
Selecione
anypara deixar a dimensão de nuvem sem escopo.Opcional. Selecione uma localização geográfica no menu suspenso Geography.
A maioria das chaves não precisa de uma localização geográfica. Selecione
anypara deixar a dimensão geográfica sem escopo.O Atlas exibe o API Endpoint somente leitura para o escopo que você seleciona. A chave autentica neste endpoint.
Clique em Create.
Escopo principal
Observação
Visualização pública
A região geográfica da Europa e seu endpoint, eu.ai.mongodb.com, estão disponíveis como um recurso de visualização pública. O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização.
Ao criar uma chave de API de modelo, você fornece um cloud e um geography. Juntos, eles definem o escopo da chave, o que determina o endpoint com o qual a chave se autentica.
Defina qualquer valor como any para deixar essa dimensão sem escopo. Uma chave com cloud e geography definidos como any é uma chave sem escopo e funciona contra ai.mongodb.com.
Endpoint | Geograficamente |
|---|---|
| Sem escopo. O Atlas pode atender à solicitação de qualquer localização geográfica. |
| Europa |
| Estados Unidos |
Os endpoints com escopo seguem o padrão <geography>.ai.mongodb.com, em que <geography> é o valor geography da chave de API do modelo que você envia com a solicitação.
Para saber o que é uma geográfica e quando definir o escopo de uma chave para uma, consulte Geographies for Voyage AI Inference.
Considere o seguinte ao definir o escopo de uma chave:
O escopo é fixado quando você cria a chave. Para usar uma nuvem ou localidade diferente, exclua a chave e crie uma nova. Uma solicitação de
PATCHpara uma chave de API de modelo altera apenas o nome da chave.O prefixo da chave codifica o escopo. Por exemplo, um escopo chave para a Europa começa com
al-eu-. Use o prefixo para identificar o escopo de uma chave sem recriá-lo.As chaves com escopo exigem um nível de uso pago. Você não pode definir o escopo de uma chave na avaliação gratuita. Para saber mais, consulte Níveis de uso.
as chaves da API do modelo que você criou antes que as Geographies estivessem disponíveis, lidas como cloud=any e geography=any. Essas chaves continuam funcionando no ai.mongodb.com e não são migradas. Para usar um escopo, crie uma nova chave.
Restringir o escopo da chave API do modelo usando uma Política de recursos
Você pode configurar uma política de recursos no nível da organização para exigir que novas chaves de API de modelo sejam criadas em uma determinada nuvem, uma determinada Geograficamente ou ambas. Para fazer isso, adicione uma regra forbid escrita em Cedar que tenha como alvo a ação de API de incorporação e reclassificação.
A política rege a criação de chaves. Ele não restringe onde uma chave existente é usada. Se você configurar esta política, os usuários não poderão criar chaves fora do escopo que você permite. No entanto, a política não revoga nem redige as chaves que já existem. Essas chaves continuam funcionando. Para remover uma chave que é anterior à política, consulte Excluir uma chave de API.
Você pode permitir escopos específicos usando a cláusula unless na regra forbid.
forbid (principal, action == ResourcePolicy::Action::"project.aiModelAPI.modify", resource) unless { <exception> };
Para saber mais sobre como configurar a política de recursos, consulte Políticas de Recursos do Atlas .
Visualizar uma chave API
Os proprietários da organização podem visualizar e editar todas as chaves de API do modelo para a organização no nível da organização. Os proprietários do projeto podem visualizar e editar apenas as chaves API do modelo dos projetos aos quais têm acesso.
Para visualizar as chaves de API do modelo no nível da organização , complete as seguintes etapas:
Conecte-se ao Atlas.
Para cada chave de API do modelo, a página exibe o seguinte:
Nome da coluna | Descrição do valor da coluna |
|---|---|
Name | Nome da chave API do modelo. |
Secret Key | Chave de API do modelo redigida associada ao nome da chave de API do modelo. |
Created On (UTC) | Data em UTC quando o usuário criou a chave API do modelo. |
Last Used (UTC) | Data em UTC em que a chave da API do modelo foi usada pela última vez. O valor é |
Project | Nome do projeto vinculado à chave API do modelo. |
Created By | Nome do usuário que criou a chave. |
Actions | Ações que você pode realizar na chave. Você pode clicar em:
|
Para visualizar as chaves de API do modelo no nível do projeto , complete as seguintes etapas:
Conecte-se ao Atlas.
Vá para a página AI Model APIs no Atlas IU.
Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.
Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.
No nível do projeto , clique em AI Model APIs sob o cabeçalho Services na barra de navegação.
Para cada chave de API do modelo, a página exibe as seguintes informações sobre a chave:
Nome da coluna | Descrição do valor da coluna |
|---|---|
Name | Nome da chave API do modelo. |
Secret Key | Chave de API do modelo redigida associada ao nome da chave de API do modelo. |
Created On (UTC) | Data em UTC quando o usuário criou a chave API do modelo. |
Last Used (UTC) | Data em UTC em que a chave da API do modelo foi usada pela última vez. O valor é |
Project | Nome do projeto vinculado à chave API do modelo. |
Created By | Nome do usuário que criou a chave. |
Actions | Ações que você pode realizar na chave. Você pode clicar em:
|
Editar uma chave API
Para editar as chaves de API do modelo no nível da organização , complete as seguintes etapas:
Conecte-se ao Atlas.
Para editar chaves de API de modelo no nível do projeto , complete as seguintes etapas:
Conecte-se ao Atlas.
Vá para a página AI Model APIs no Atlas IU.
Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.
Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.
No nível do projeto , clique em AI Model APIs sob o cabeçalho Services na barra de navegação.
Excluir uma chave de API
Quando você exclui uma chave de API de modelo, o MongoDB desativa imediatamente a chave e rejeita todas as solicitações de API feitas com a chave excluída. Depois de excluir a chave, você não poderá visualizá-la, restaurá-la ou modificá-la.
Para excluir chaves de API de modelo no nível da organização , complete as seguintes etapas:
Conecte-se ao Atlas.
Para excluir chaves de API de modelo no nível do projeto , complete as seguintes etapas:
Conecte-se ao Atlas.
Vá para a página AI Model APIs no Atlas IU.
Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.
Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.
No nível do projeto , clique em AI Model APIs sob o cabeçalho Services na barra de navegação.
Próximos passos
Depois de criar uma chave de API de modelo, você pode:
Defina limites de taxa para as chaves de API do modelo.
Monitore o uso da chave API em tempo real.