Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.
Menu Docs
Início dos Modelos da Voyage AI
Início dos Modelos da Voyage AI
Início dos Modelos da Voyage AI

Gerenciar chaves de API do modelo Voyage AI

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 UI do Atlas nos níveis de organização e projeto . Oslimites 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:

Para visualizar as chaves de API do modelo:

  • Nos níveis de organização e projeto , você deve ter acesso Organization Read Only ou superior ao Atlas.

  • Somente no nível do projeto , você deve ter acesso Project Read Only ou 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 autentica solicitações para os pontos de extremidade ai.mongodb.com. Por outro lado, se você criar uma chave diretamente por meio da Voyage AI, a chave autentica 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:

1
Conecte-se ao Atlas.
2
Acesse a página AI Model APIs na interface do usuário do Atlas .

  1. Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.

  2. No nível da organização , clique em Model API Keys sob o cabeçalho Services na barra de navegação.

3

Crie a chave API do modelo.

  1. Clique em Create new model API key.

  2. Insira um nome para a chave.

    As chaves da API do modelo não podem exceder 250 caracteres.

  3. Selecione um projeto no menu suspenso para vincular à chave de API.

  4. Selecione um provedor de nuvem no menu suspenso Cloud provider.

    Selecione any para deixar a dimensão da nuvem sem escopo.

  5. Opcional. Selecione uma geografia no menu suspenso Geography.

    A maioria das chaves não precisa de uma Geografia. Selecione any para deixar a dimensão geográfica sem escopo.

    O Atlas exibe o API Endpoint somente leitura para o escopo que você selecionar. A chave autentica contra este ponto de extremidade.

  6. Clique em Create.

4

Salve a chave API.

  1. Copie a chave API do modelo e armazene-a em uma localização segura.

    Depois de sair da página onde a chave é exibida, você não poderá visualizá-la novamente. Se você perdê-lo, crie um novo.

  2. Clique em Done.

Escopo Principal

Ao criar uma chave API de modelo, você fornece um cloud e um geography. Juntos, estes definem o escopo da chave, que determina o ponto de extremidade contra o qual a chave se autentica.

Defina um dos valores como any para deixar essa dimensão sem escopo. Uma chave com cloud e geography ambos definidos como any é uma chave não delimitada e funciona contra ai.mongodb.com.

Endpoint
Geograficamente

ai.mongodb.com

Não delimitado. O Atlas pode servir à solicitação de qualquer geografia.

eu.ai.mongodb.com

Europa

us.ai.mongodb.com

Estados Unidos

Pontos de extremidade com escopo seguem o padrão <geography>.ai.mongodb.com, onde <geography> é o valor geography da chave de API do modelo que você envia com a solicitação.

Para aprender o que é uma Geografia e quando associar uma chave a uma, consulte Geografias para Inferência do Voyage AI.

Considere o seguinte ao definir o escopo de uma chave:

  • O escopo é fixo quando você cria a chave. Para usar uma nuvem ou região diferente, exclua a chave e crie uma nova. Uma solicitação PATCH para uma chave de API de modelo altera apenas o nome da chave.

  • O prefixo da chave codifica o escopo. Por exemplo, uma chave com escopo na Europa começa com al-eu-. Use o prefixo para identificar o escopo de uma chave sem recriá-la.

  • Chaves com escopo exigem um tier de uso pago. Você não pode definir o escopo de uma chave no teste gratuito. Para aprender mais, consulte tiers de Uso.

Chaves de API do modelo que você criou antes que as Geographies estivessem disponíveis são exibidas como cloud=any e geography=any. Estas chaves continuam funcionando contra ai.mongodb.com e não são migradas. Para usar um escopo, crie uma nova chave.

Restringir o escopo da chave de API do modelo usando uma política de recurso

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 Geografia ou ambos. Para fazer isso, adicione uma regra forbid escrita em Cedar que visa a ação da Embedding and Reranking API.

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.

Exemplo: Restringir o escopo da chave API do modelo com exceções
forbid (principal, action == ResourcePolicy::Action::"project.aiModelAPI.modify", resource) unless { <exception> };

Para restringir chaves a uma Geografia, use o atributo context.aiModelApi.geography na cláusula unless. A política a seguir permite que os usuários criem chaves de API de modelo apenas para a Geografia da Europa:

Exemplo: Restringir chaves de API do modelo à geografia da Europa
forbid (principal, action == ResourcePolicy::Action::"project.aiModelAPI.modify", resource) unless { context.aiModelApi.geography == ResourcePolicy::Geography::"eu" };

Para saber mais sobre como configurar a política de recursos, consulte Visão geral das 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:

1
Conecte-se ao Atlas.
2
Acesse a página AI Model APIs na interface do usuário do Atlas .

  1. Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.

  2. No nível da organização , clique em Model API Keys sob o cabeçalho Services na barra de navegação.

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 é Never se a chave for nova ou nunca tiver sido usada.

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 editar a chave de API do modelo.

  • para excluir a chave API do modelo.

Editar uma chave API

Para editar as chaves de API do modelo no nível da organização , complete as seguintes etapas:

1
Conecte-se ao Atlas.
2
Acesse a página AI Model APIs na interface do usuário do Atlas .

  1. Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.

  2. No nível da organização , clique em Model API Keys sob o cabeçalho Services na barra de navegação.

3

Edite a chave.

  1. Na coluna Actions, clique em correspondente à chave que você deseja editar.

  2. Na página Edit Model API Key, modifique o nome da chave de API do modelo.

    o nome da chave API do modelo deve ser exclusivo para o projeto e pode ter até 250 caracteres.

  3. Clique em Save para aplicar as alterações.

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:

1
Conecte-se ao Atlas.
2
Acesse a página AI Model APIs na interface do usuário do Atlas .

  1. Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.

  2. No nível da organização , clique em Model API Keys sob o cabeçalho Services na barra de navegação.

3

Exclua a chave.

  1. Na coluna Actions, clique em correspondente à chave que você deseja excluir.

  2. No modal de confirmação, clique em Delete key para excluir a chave.

Próximos passos

Depois de criar uma chave de API de modelo, você pode:

Próximo
Acesso à organização e ao projeto
Avalie esta página

Nesta página