Ir para o conteúdo

Use o Assistente de IA do Jitterbit API Manager

Introdução

O Assistente de IA do APIM ajuda você a criar e manter ativos no API Manager interagindo com ele usando linguagem natural escrita.

Cabeçalho do API Manager com bot de IA aberto

Nota

Para usar o Assistente de IA do APIM, sua licença Harmony deve incluir a opção de Assistente de IA do APIM. Entre em contato com seu Gerente de Sucesso do Cliente (CSM) para adicionar essa opção à sua licença.

Acesse o Assistente de IA

Acesse o assistente a partir destes locais:

  • No cabeçalho do portal Harmony em qualquer página do API Manager ou Studio, use o ícone Jitterbit AI. No painel, use o menu suspenso para selecionar Assistente APIM.

  • A partir destas páginas do API Manager, clique em Novo > Construir com IA:

  • No Studio, use o menu de ações de operação para selecionar Publicar como uma API usando IA.

  • Na página Assistente de IA do Console de Gerenciamento, acesse a interface dedicada de página inteira para conversas estendidas.

Interações suportadas

As seguintes interações são suportadas:

  • APIs Personalizadas: Criar, publicar, editar, testar, clonar e excluir.
  • APIs Proxy: Criar, publicar, editar e testar.
  • Perfis de segurança: Criar, editar, atribuir e excluir.
  • Grupos de IP confiáveis: Criar, editar, atribuir e excluir.
  • Grupos de APIs: Criar, editar, atribuir e excluir.
  • Informações da API: Obter explicações detalhadas e insights sobre APIs existentes.

    Dica

    O assistente fornece explicações mais ricas e detalhadas quando sua API inclui descrições abrangentes e documentação OpenAPI.

Controles do Assistente de IA

O painel do Assistente de IA inclui os seguintes controles:

  • Início: Retorne ao chat atual a partir do histórico de chats.
  • Histórico: Navegue pelos seus chats anteriores com o Assistente de IA e selecione um para visualizar.
  • Novo chat: Inicie um novo chat.
  • Chat de usuários: Visualize o histórico de chat de um usuário específico selecionando seu endereço de email. Esta opção está disponível apenas para usuários com Admin permissão.

Começando

Para começar a usar o Assistente de IA do APIM, use linguagem natural para dizer ao assistente o que você gostaria que ele fizesse. O assistente irá guiá-lo pelo processo de criação ou atualização de ativos. Ele pedirá confirmação quando necessário, solicitará mais informações quando precisar e confirmará quando tiver realizado uma ação.

Se você precisar de ajuda para entender como responder ao assistente, peça para ele esclarecer o que significa ou use a documentação da interface do usuário como referência suplementar.

APIs

Você pode criar, editar, publicar, testar, clonar e excluir APIs.

Exemplos de solicitações de usuários

  • Crie uma nova API proxy usando valores padrão.
  • Adicione um novo serviço de API à minha API existente "Clientes".
  • Liste as APIs em rascunho disponíveis para mim.
  • Exclua um dos serviços de API de "Produtos".
  • Fale-me sobre a API "Produtos".
  • Dê-me uma lista de APIs em rascunho disponíveis para publicação.

Quando você pede ao assistente para excluir uma API, ele avisará se a API está atualmente publicada, pedirá que você verifique se deseja excluí-la e confirmará quando ela tiver sido excluída com sucesso.

Quando você clona uma API personalizada, o nome da API clonada será precedido por Cópia de, a raiz do serviço será precedida por Copia de e a versão será acrescida de um número incrementado.

Quando o assistente estiver testando uma API protegida por autenticação básica, ele fornecerá um diálogo separado na interface do usuário para inserir suas credenciais por motivos de segurança. Suas credenciais não são compartilhadas com o modelo de linguagem grande (LLM).

Perfis de segurança

Você pode criar, editar, atribuir e excluir perfis de segurança, seja ao criar ou editar uma API, ou como uma interação separada.

Exemplos de solicitações do usuário

  • Proteger a API "Clientes" com um novo perfil para autenticação básica.
  • Atribuir meu perfil de segurança "Portal do Funcionário" existente à API "Funcionários".
  • Criar um novo perfil de segurança com autenticação OAuth 2.0.
  • Mostrar todos os perfis de segurança no ambiente de Produção.

Grupos de API

Você pode criar, editar, atribuir e excluir grupos de API.

Exemplos de solicitações do usuário

  • Criar um grupo de API chamado "API_GRP_1" com as APIs "Clientes" e "Produtos".
  • Adicionar a nova API "Pedidos" ao "API_GRP_1", e depois listar todas as APIs em "API_GRP_1".
  • Renomear "API_GRP_1" para "API_GROUP_1" e remover a API "Clientes" dele.
  • Mostrar todos os grupos de API na minha organização.

Grupos de IP confiáveis

Você pode criar, editar, atribuir e excluir grupos de IP confiáveis.

Exemplos de solicitações do usuário

  • Criar um grupo de IP confiável chamado "Rede do Escritório" com o intervalo de 192.0.2.10 a 192.0.2.50
  • Adicionar um novo intervalo de IP ao grupo "Rede do Escritório".
  • Mostrar todos os grupos de IP confiáveis.
  • Atribuir o grupo de IP confiável "Rede do Escritório" ao meu perfil de segurança.

Recomendações

Você deve interagir com o Assistente de IA do APIM como faria com qualquer produto de IA de modelo de linguagem grande (LLM).

As seguintes sugestões são recomendadas:

  • Escreva em inglês usando a redação que vier naturalmente a você, como se estivesse conversando com uma pessoa com seu próprio nível de conhecimento em TI e negócios. Outros idiomas podem ser usados, mas não foram validados.

  • Para ter ideias sobre quais interações você pode realizar, pergunte ao assistente em linguagem natural o que ele pode fazer, ou digite help.

  • Leia as solicitações com atenção antes de digitar sua resposta. Se houver algo que você não entenda, peça ao assistente para esclarecer.

  • Assim que o assistente terminar a configuração dos ativos, revise e confirme o que ele criou navegando pela configuração no Gerenciador de API. Se alguma configuração não estiver como esperado, você pode pedir ao assistente para editá-las ou editá-las diretamente.

Limitações

As interações a seguir ainda não são suportadas:

  • Clonar e excluir APIs de proxy.
  • Exportar e importar APIs.
  • Fazer upload de um documento OpenAPI ao criar uma API de proxy.

Problema conhecido

Quando o assistente solicitar que você selecione um ambiente, a lista pode estar desatualizada se você tiver feito alterações nos ambientes na mesma sessão do navegador. Como solução alternativa, saia do portal Harmony e faça login novamente para que o assistente retorne uma lista atualizada de ambientes.