Criação, implantação e publicação de APIs usando API Agent

Editar online

API Agent foi projetado para acelerar a jornada da API com mais eficiência, velocidade e confiança. Esse recurso foi desenvolvido para trabalhar com a rápida evolução de modelos de linguagem grandes (LLMs) e agentes de IA, que estão impulsionando mudanças no mundo do consumo e da criação de APIs.

Esse novo recurso permite que os desenvolvedores e usuários técnicos criem APIs por meio de uma interface baseada em bate-papo, permitindo que eles definam, projetem e implementem APIs usando interações naturais e de conversação.

Visão geral

API Agent foi desenvolvido com base em uma estrutura agêntica para que possa planejar, entender e executar consultas de usuários. Disponível como um plug-in Visual Studio Code (VS Code), ele simplifica e automatiza fluxos de trabalho complexos de gerenciamento de API. Ao traduzir de forma inteligente as consultas dos usuários em ações, o API Agent simplifica a descoberta, a criação, a governança e o teste de APIs.

Diagrama de visão geral do agente de API

O API Agent usa uma estrutura agêntica que oferece suporte a várias ferramentas para automatizar tarefas como a busca de APIs e tabelas e a geração de código para interagir com bancos de dados. Para obter uma lista abrangente de prompts, consulte Biblioteca de prompts.

Essas ferramentas incluem:
  • Pesquisador de artefatos: Localiza recursos existentes, como APIs, tabelas de banco de dados ou objetos de origem de aplicativos.
  • OAS Creator: Automatiza a criação de APIs a partir de tabelas de banco de dados e aplicativos baseados no pacote de conectores IBM.
  • Governança da API: Fornece acesso a vários recursos importantes de governança de API do API Connect por meio do API Agent. Com essa ferramenta, você pode listar conjuntos de regras, listar regras em conjuntos de regras, validar um documento OpenAPI usando conjuntos de regras e corrigir um documento OpenAPI com conjuntos de regras compatíveis.
  • API Connect Testador: Facilita os fluxos de trabalho de geração e execução de testes de API.
  • API Connect Tarefa: Lida com tarefas relacionadas ao IBM API Connect, como a publicação ou a proteção de APIs.
  • OpenAPI Python Generator (Gerador): Gera código boilerplate ou personalizado a partir das especificações do site OpenAPI usando a estrutura FastAPI.
  • OpenAPI Aprimorador: Realiza a atualização ou modificação de um arquivo OpenAPI de entrada ou rascunho de API com descrições e exemplos aprimorados e retifica automaticamente qualquer arquivo OpenAPI com problemas ou erros de validação.
  • OpenAPI Gerador: Gera OpenAPI documentos a partir de uma descrição de linguagem natural (NLP). O usuário fornece um prompt para o API Agent, descrevendo a funcionalidade pretendida do aplicativo. Com base nesse prompt, o site API Agent gera uma especificação OpenAPI que representa a API descrita.

    A estrutura garante que as tarefas sejam encaminhadas para a ferramenta apropriada com base na consulta do usuário. Na versão inicial, o API Agent confirma com o usuário se o plano de ação proposto é preciso antes de executá-lo, garantindo precisão e controle do usuário.

  • Implementação de código: Simplifica a implantação do código-fonte do aplicativo em serviços compatíveis, fornecendo uma maneira flexível e controlada de gerenciar implantações.

Componentes do API Agent

API Agent tem os seguintes componentes:

  • Fontes de agentes de API
    A inteligência por trás do API Agent é alimentada por fontes do API Agent configuradas pelos administradores para integrar várias fontes que alimentam os recursos do sistema. Aproveitando um padrão RAG (Retrieval-Augmented Generation) robusto, esse catálogo rastreia e indexa fontes compatíveis, incluindo APIs e tabelas de banco de dados, armazenando-as como embeddings vetoriais.
    Principais recursos:
    • Atuar como um hub centralizado para gerenciar e configurar os recursos necessários para o desenvolvimento de APIs.
    • Permitindo a conexão e a configuração perfeitas de fontes de dados, como bancos de dados e APIs.
    • Fornecer acesso imediato a todos os recursos configurados para criar e gerenciar APIs.
  • Interface de bate-papo
    Usando o Visual Studio Code, você pode instalar o API Agent, que oferece uma interface de chat na qual é possível inserir diferentes comandos. Por exemplo, Search for available APIs ou Create an openapi with the table purchaseorder.

    O API Agent se conecta a fontes API Agent , recupera as informações necessárias e fornece resultados acionáveis.

API Agent funções do usuário

As funções e permissões do usuário para IBM® API Connect controlam as ações que os usuários podem realizar em API Agent. Para mais detalhes, consulte Funções.

Os tópicos a seguir fornecem detalhes completos sobre a configuração e o uso do site API Agent.