Documentação do Oracle Cloud Infrastructure

Criando uma Ferramenta de Chamada de Ponto Final de API em Generative AI Agents

Em Generative AI Agents, cada agente deve ter uma ou mais ferramentas. Você pode criar uma ferramenta de agente durante ou após a criação do agente. Para ambas as opções, a criação de uma ferramenta tem as mesmas etapas. Esta seção mostra as etapas para criar uma ferramenta de chamada de ponto final de API.

Antes de começar, revise as Diretrizes da Ferramenta de Chamada de Ponto Final de API para Agentes de IA Generativa e conclua todas as tarefas necessárias. Por exemplo, talvez você precise criar um segredo do OCI Vault e adicionar políticas para acessar segredos do vault.

Criando uma Ferramenta de Chamada de Ponto Final de API

  1. Selecione Criar ferramenta e Ferramenta personalizada.
  2. Informe um nome e a descrição para esta ferramenta.
  3. Em Configuração da ferramenta, selecione Chamada do ponto final da API (execução do agente).
  4. (Opcional) Selecione um exemplo, se aplicável.

    Se você selecionar um exemplo, o exemplo será copiado para a caixa esquema de API para importação Inline. Vá em frente para o passo 6.

  5. Para Importar esquema de API, selecione uma das opções a seguir para fornecer o esquema de API para esta ferramenta. Um esquema de API descreve as operações e os métodos do ponto final da API.
    • Em Linha: Para um esquema pequeno, você pode informar uma string que contenha as operações e os métodos do ponto final da API.
    • Escolher no Serviço Object Storage: Para um esquema grande ou um esquema que tenha atualizações frequentes, selecione um compartimento e um bucket. Depois, selecione o arquivo que contém o esquema da API.
  6. Para Tipo de autenticação, selecione uma das opções a seguir e conclua a configuração da ferramenta conforme necessário.
    • Nenhum: Para chamar pontos finais de API públicos ou privados que não exigem autenticação. Quando selecionado, nenhum cabeçalho de autenticação é adicionado a uma solicitação de chamada.
    • Chave de API: Uma chave de API é um token que um cliente fornece ao fazer chamadas de API. A chave da API deve ser armazenada em um segredo do OCI Vault.
      • Localização da chave: Especifique a localização da chave de API em uma solicitação de chamada.
        • Selecione Cabeçalho para enviar a chave no cabeçalho da solicitação.
        • Selecione Parâmetro de consulta para informar a chave como um parâmetro de consulta na solicitação.
      • Nome da chave: Informe o nome de uma chave de cabeçalho (por exemplo, Authorization) ou o nome de uma chave de um parâmetro de consulta (por exemplo, appid).
      • Selecionar segredo do vault: No compartimento apropriado, selecione o segredo do Vault do OCI que tem a chave de API.
    • Básico: Autenticação básica HTTP usando um nome de usuário e uma senha. As credenciais devem ser especificadas no formato <your-username>:<your-password> e armazenadas em um segredo do OCI Vault.
      • Selecionar segredo do vault: No compartimento apropriado, selecione o segredo do Vault do OCI que tem as credenciais no formato necessário.
    • Bearer : Autenticação OAuth 2.0 usando um token portador. O token deve ser armazenado em um segredo do OCI Vault.
      • Selecionar segredo do vault: No compartimento apropriado, selecione o segredo do Vault do OCI que tem o token.
    • IDCS: Autenticação OAuth 2.0 usando o ID do cliente e o segredo do cliente obtidos de um aplicativo confidencial do Oracle Identity Cloud Service (IDCS). O segredo do cliente deve ser armazenado em um segredo do OCI Vault.
      • Domínio de identidades: No compartimento apropriado, selecione o domínio de identidades no qual essa ferramenta será criada.
      • ID do Cliente: Informe o ID do cliente do aplicativo confidencial.
      • Segredo do cliente: No compartimento apropriado, selecione o segredo do OCI Vault que tem o segredo do cliente para o aplicativo confidencial.
      • URL do Escopo: Informe o URL do escopo que define um conjunto específico de recursos e operações que podem ser acessados.
    • Controlador de recursos do OCI: Somente para chamar APIs de serviço do OCI, como Armazenamento de Objetos, Computação e Rede (VCN e sub-rede).
  7. No compartimento apropriado, selecione a VCN e a sub-rede que você deseja usar.
  8. Selecione Criar ferramenta.
Dica

Execute uma das seguintes ações:

  • Se você estiver criando um agente, volte para Criando um Agente em Agentes do Serviço Generative AI para criar outra ferramenta ou um ponto final do agente.
  • Se você tiver adicionado a ferramenta a um agente existente, após a ferramenta estar ativa, na página de detalhes do agente, selecione Iniciar chat para conversar com o agente usando essa ferramenta.
  • Se você criou o agente sem um ponto final de agente, quando estiver pronto para usar o agente, crie um ponto final para esse agente.
Observação

Para permitir que um revisor humano monitore e edite uma resposta antes de enviá-la ao usuário, selecione o recurso opcional Ativar humano no loop no ponto final do agente.