Ir para o conteúdo

Use 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 analíticos da API.

Cabeçalho do API Manager com assistente 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 do APIM

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 de IA do APIM.

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

  • Na página de Análises, clique em Perguntar IA.

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

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

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 seus chats anteriores com o Assistente de IA e selecione um para visualizar.
  • Copiar chat: Copie a conversa completa para a área de transferência.
  • Novo chat: Inicie um novo chat.
  • Chat de usuários: Veja o histórico de chat para um usuário específico selecionando seu endereço de e-mail. Esta opção está disponível apenas para usuários com permissão de Admin permissão.
  • Expandir: Expande o chat. Uma vez expandido, clique no ícone Minimizar para retornar à visualização anterior.
  • 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áveis: Criar, editar, atribuir e excluir.
  • Grupos de API: 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.

  • Análise: Consultar, explicar, resumir e baixar dados analíticos da API, incluindo chamadas de API, tempo de resposta, códigos de status, erros, utilização de limite de taxa, violações de políticas e insights sobre consumidores e IPs.

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 do usuário

  • Criar uma nova API proxy usando valores padrão.
  • Adicionar um novo serviço de API à minha API existente "Clientes".
  • Listar as APIs em rascunho disponíveis para mim.
  • Excluir 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 Cópia de e a versão será acrescida de um número incrementado.

Quando o assistente estiver testando uma API protegida com autenticação básica, ele fornecerá uma caixa de diálogo separada 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", 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.

Análise

Você pode pedir ao assistente para consultar, explicar, resumir e baixar dados da página de Análise. O assistente usa automaticamente o ambiente, intervalo de tempo, API, versão, método, código de status e filtros de perfil atualmente aplicados na página de Análise, então você não precisa reiterar esse contexto em sua solicitação.

Exemplos de solicitações do usuário

  • Quais APIs tiveram o maior número de chamadas nos últimos 7 dias?
  • Mostre-me a tendência de chamadas da API para esta API.
  • Quais APIs têm o maior número de erros 5xx (erro do servidor)?
  • Qual é o número de chamadas por minuto (CPM) agora?
  • Estamos nos aproximando dos limites de taxa?
  • Quais consumidores ou endereços IP geram o maior número de chamadas de API?
  • Resuma o desempenho da API esta semana e destaque os principais problemas.
  • Baixe as métricas de chamadas dos últimos 7 dias.
  • Expanda o gráfico de "Total de chamadas".
  • Colapse este gráfico de "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 analíticas a partir de outras páginas do Gerenciador de API. O assistente navega até a página Analytics para respondê-las.

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

Você também pode pedir ao assistente para baixar dados da tabela de monitoramento de saúde da API ou dos gráficos nas seções Métricas de chamadas e Consumidores de API como um arquivo CSV, correspondendo ao comportamento de Baixar como CSV para a tabela e ao comportamento de Baixar como CSV para gráficos individuais. O assistente aplica os filtros atualmente ativos na página Analytics ao download.

Nota

O assistente retorna e baixa apenas os dados analíticos 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 de modelo de linguagem grande (LLM). Siga estas sugestões:

  • 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 respostas do assistente com atenção antes de digitar sua resposta. Se houver algo que você não entenda, peça ao assistente para esclarecer.

  • Uma vez que o assistente tenha realizado uma ação, você pode revisar e confirmar o que ele fez navegando pela configuração na interface do usuário. Se alguma configuração não estiver como esperado, você pode pedir ao assistente para editá-las ou editá-las 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, remediação automática ou criação de alertas a partir de dados analíticos.
  • Relatórios ou exportações analíticos além do download em CSV.

Problema conhecido

Quando o assistente solicitar que você selecione um ambiente, a lista pode estar desatualizada se você fez 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.