OpenAPI
Conectores OpenAPI: Integração com APIs Externas
Os Conectores OpenAPI permitem que os Agentes de IA do Power Omni interajam diretamente com serviços de API externos, utilizando a especificação OpenAPI (Swagger). Este tipo de conector é ideal para ler e escrever dados em sistemas em tempo real.
1. Visão Geral do Processo
A criação do conector é dividida em três etapas:
Configuração da API: Informar a URL da especificação e o tipo de autenticação.
Definição da Ferramenta: Nomear e descrever a ferramenta para o Agente de IA.
Seleção de Endpoints: Escolher quais funções da API o Agente pode utilizar.
Relacionamento: Associar o Conector final ao Agente de IA.
2. Passo a Passo: Criação do Conector OpenAPI
A criação do Conector ocorre no Portal de Administração (Artefatos > Conectores).
2.1 Configuração da API e Autenticação
No Portal de Administração, navegue até Conectores.
Clique em "Adicionar Conector" e selecione o tipo "Conector OpenAPI".
Preencha os campos iniciais de acesso à API:
Campo
Descrição
URL da Especificação OpenAPI
Insira a URL completa (HTTPS) do arquivo de especificação OpenAPI (JSON) da sua API.
Tipo de Autenticação
Selecione o mecanismo de segurança da sua API (Ex: API Key, Bearer Token).
Chave de Autenticação
Necessário apenas se o Tipo de Autenticação for API Key. Insira a chave da API. Por padrão, a Chave de Autenticação será incluída no cabeçalho (Header) da requisição.
2.2 Detalhes do Conector e Descrição para o Agente
Estes campos são cruciais para que o Agente de IA entenda quando e como usar o conector.
Campo
Função
Explicação
Nome do Conector
Identificação Interna
Nome para visualização no Portal de Administração (Ex: "API Faturamento ERP").
Descrição da Ferramenta
Instrução para a IA
Descreva a finalidade do conector de forma clara para o Agente de IA. Ex: "Use esta ferramenta para consultar a cotação atual do dólar."
Nome da Conexão
Agrupamento
Nome interno para a conexão (pode ser o nome da API).
2.3 Seleção de Endpoints (Operações)
Nesta etapa, você define as permissões do Agente dentro da API:
Análise da API: O Power Omni analisará o arquivo OpenAPI da URL fornecida e listará todas as operações (endpoints) disponíveis (GET, POST, etc.).
Seleção: Marque (selecione) apenas as operações que o Agente de IA tem permissão e necessidade de executar.
Teste Individual: Recomenda-se testar as requisições, se a interface permitir, para garantir que o endpoint responda conforme o esperado.
Após a seleção, clique em "Salvar" para finalizar a criação do Conector OpenAPI.
3. Passo Final: Relacionando o Conector ao Agente
O Agente só terá acesso às funções da API após o relacionamento.
Acesse a seção de Artefatos > Agentes no Portal de Administração.
Selecione o Agente de IA que precisa interagir com a API.
Navegue até a aba ou seção de Relacionamentos (ou Conectores).
Na lista de Conectores disponíveis, localize o Conector OpenAPI recém-criado.
Associe o Conector ao Agente.
Clique em "Salvar" para aplicar as alterações.
✅ Resultado Final
O Agente agora está habilitado para tomar decisões e chamar as funções da API:
O Agente usará a "Descrição da Ferramenta" para determinar se uma solicitação do usuário deve acionar este conector.
O Agente formará a requisição, incluindo a autenticação configurada, e chamará o endpoint relevante para obter ou manipular dados em tempo real.
Atualizado