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
Organization Ownerao Atlas.No nível do projeto, você deve ter acesso de
Project Model Owner,Project Ownerou superior ao Atlas.
Para visualizar as chaves de API do modelo:
Nos níveis de organização e projeto, você deve ter acesso
Organization Read Onlyou superior ao Atlas.Somente no nível do projeto, você deve ter acesso
Project Read Onlyou superior ao Atlas.
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á somente solicitações para https://ai.mongodb.com/v1/embeddings. 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.
Para criar chaves de API do modelo no nível da organização , complete as seguintes etapas:
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 Models 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 Models sob o cabeçalho Services na barra de navegação.
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 Models 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 Models 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 Models 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 Models 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 API solicitações 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 Models 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 Models 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.