Ir para o conteúdo

Usar o Assistente de IA do Jitterbit API Manager

Introdução

Usando linguagem natural escrita, o Assistente de IA do APIM ajuda você a criar e manter ativos no API Manager, além de consultar, explicar e baixar dados de análise de API.

Cabeçalho do API Manager com o assistente de IA aberto

Nota

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

Acessar o Assistente de IA do APIM

Acesse o assistente nestes 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 de IA do APIM.

  • Nestas páginas do API Manager, clique em Novo > Criar com IA:

  • Na página Análise, clique em Perguntar à IA.

  • No Studio, use o menu ações da 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 mais longas.

Controles do Assistente de IA do APIM

O painel do Assistente de IA do APIM inclui estes controles:

  • Início: Retorne ao chat atual a partir do histórico de chats.
  • Histórico: Navegue pelos chats anteriores do Assistente de IA e selecione um para visualizar. Para usuários com permissão de Administrador, cada chat na lista também mostra seu uso de tokens (Aviso, Em Cache e contagens de tokens de Resposta) assim que o chat tiver pelo menos uma troca de mensagens. Usuários sem permissão de Administrador veem apenas títulos de chats.
  • Copiar chat: Copie a conversa completa para a área de transferência.
  • Novo chat: Inicie um novo chat.
  • Expandir: Expande o chat. Após expandir, clique no ícone Minimizar para retornar à visualização anterior.
  • Mais ações: Abre um menu com a seguinte opção:
    • Chat de usuários: Visualize o histórico de chats de um usuário específico selecionando seu endereço de e-mail. A lista de chats inclui o uso de tokens de cada chat, como em Histórico. Esta opção está disponível apenas para usuários com permissão de Administrador.
  • Redimensionar: Arraste a borda esquerda do painel para ajustar sua largura.

Interações e capacidades suportadas

As seguintes interações e capacidades 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ável: Criar, editar, atribuir e excluir.
  • Grupos de API: Criar, editar, atribuir e excluir.
  • Informações de 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 do OpenAPI.

  • Análise: Consulte, explique, resuma e baixe dados de análise de API, incluindo chamadas de API, tempo de resposta, códigos de status, erros, utilização de limite de taxa, violações de política e insights de consumidor e IP.

Começar

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 o guiará pelo processo de criação ou atualização de ativos. Solicitará confirmação quando necessário, o solicitará quando precisar de mais informações e confirmará quando tiver executado uma ação.

Se você precisar de ajuda para entender como responder ao assistente, peça que ele esclareça o que quer dizer ou use a documentação da interface como referência complementar.

APIs

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

Exemplos de prompts do usuário

  • Criar uma nova API proxy usando valores padrão.
  • Adicionar um novo serviço de API à minha API existente "Customers".
  • Listar as APIs em rascunho disponíveis para mim.
  • Excluir um dos serviços de API de "Products".
  • Me contar sobre a API "Products".
  • Fornecer uma lista de APIs em rascunho disponíveis para publicar.

Quando você pede ao assistente para excluir uma API, ele avisa se a API está publicada no momento, pede para você confirmar que deseja excluí-la e confirma quando ela foi excluída com sucesso.

Ao clonar uma API personalizada, o nome da API clonada será precedido por Copy of, a raiz do serviço será precedida por Copyof e a versão será acrescida de um número incrementado.

Quando o assistente testa uma API protegida com autenticação básica, ele fornece um diálogo de interface separado para que você insira 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 prompts do usuário

  • Proteger a API "Customers" com um novo perfil de autenticação básica.
  • Atribuir meu perfil de segurança existente "Employee Portal" à API "Employees".
  • 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 APIs

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

Exemplos de prompts do usuário

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

Grupos de IPs confiáveis

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

Exemplos de prompts do usuário

  • Criar um grupo de IPs confiáveis chamado "Office Network" com o intervalo 192.0.2.10 a 192.0.2.50
  • Adicionar um novo intervalo de IPs ao grupo "Office Network".
  • Mostrar todos os grupos de IPs confiáveis.
  • Atribuir o grupo de IPs confiáveis "Office Network" ao meu perfil de segurança.

Analytics

Você pode pedir ao assistente para consultar, explicar, resumir e baixar dados da página Analytics. O assistente usa automaticamente o ambiente, intervalo de tempo, API, versão, método, código de status e filtros de perfil aplicados no momento na página Analytics, para que você não precise reafirmar esse contexto no seu prompt.

Exemplos de prompts do usuário

  • Quais APIs têm as chamadas de API mais altas nos últimos 7 dias?
  • Mostrar a tendência de chamadas de API para esta API.
  • Quais APIs têm os erros mais 5xx (erro de servidor)?
  • Qual é a taxa de chamadas por minuto (CPM) agora?
  • Estamos nos aproximando dos limites de taxa?
  • Quais consumidores ou endereços IP geram a maioria das chamadas de API?
  • Resumir o desempenho da API nesta semana e destacar os principais problemas.
  • Baixar métricas de chamadas dos últimos 7 dias.
  • Expandir o gráfico "Total de chamadas".
  • Recolher este gráfico "Hits".

Quando uma solicitação requer filtragem dos dados, por exemplo "mostrar apenas erros 4xx" ou "filtrar para esta API", o assistente aplica o filtro correspondente na página Analytics.

Você também pode fazer perguntas de análise de outras páginas do API Manager. O assistente navega você para a página Analytics para respondê-las.

Você também pode pedir ao assistente para expandir ou recolher um gráfico individual. O assistente faz isso apenas quando você o solicita.

Você também pode pedir ao assistente para baixar dados da tabela API health monitoring ou dos gráficos nas seções Call metrics e API consumers como arquivo CSV, seguindo o comportamento de Download como CSV para a tabela e o comportamento de Download como CSV para gráficos individuais. O assistente aplica os filtros ativos no momento na página Analytics ao download.

Nota

O assistente retorna e baixa apenas os dados de análise que você tem permissão para visualizar.

Recomendações

Você deve interagir com o Assistente de IA do APIM como faria com qualquer produto de IA em modelo de linguagem grande (LLM). Siga estas sugestões:

  • Escreva em inglês usando a redação que lhe vem naturalmente, 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 obter ideias sobre quais interações você pode executar, pergunte ao assistente em linguagem natural o que ele pode fazer, ou digite help.

  • Leia as respostas do assistente com cuidado antes de digitar sua resposta. Se houver algo que você não entender, peça ao assistente para esclarecer.

  • Depois que o assistente executar uma ação, você pode revisar e confirmar o que ele fez navegando pela configuração na IU. Se alguma configuração não estiver como esperado, você pode pedir ao assistente para editá-la ou editá-la diretamente.

Limitações

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

  • Clonar e excluir APIs proxy.
  • Exportar e importar APIs.
  • Fazer upload de um documento OpenAPI ao criar uma API proxy.
  • Análise preditiva, correção automática ou criação de alertas a partir de dados de análise.
  • Relatórios de análise ou exportações além do download em CSV.

Problema conhecido

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