Criar uma API com 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.

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.

Acessar 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.
Na página APIs do API Manager, clique em Novo > Criar 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 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.

Controles do Assistente de IA

O painel do Assistente de IA 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.
Novo chat: Inicie um novo chat.
Chat de usuários: Visualize o histórico de chat para 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 informar ao assistente o que você gostaria que ele fizesse. Por exemplo:

Exemplo de solicitações do usuário

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".

O assistente irá guiá-lo pelo processo de criação ou atualização de uma API. Ele pedirá confirmação quando necessário, solicitará mais informações quando precisar e confirmará quando tiver realizado uma ação.

Você também pode criar, editar, atribuir e excluir perfis de segurança, grupos de API e grupos de IP confiáveis, seja ao criar ou editar uma API, ou como uma interação separada:

Exemplo de solicitações do usuário

Crie um grupo de API chamado "API_GRP_1" com as APIs "Clientes" e "Produtos".
Adicione a nova API "Pedidos" ao "API_GRP_1", depois liste todas as APIs em "API_GRP_1".
Renomeie "API_GRP_1" para "API_GROUP_1" e remova a API "Clientes" dele.
Proteja a API "Clientes" com um novo perfil para autenticação básica.
Atribua meu perfil de segurança existente "OAuth 123".

Você também pode excluir ou clonar uma API personalizada para criar uma cópia dela:

Exemplo de solicitações do usuário

Exclua a API em rascunho "Pedidos".
Quero clonar uma API existente. Mostre-me todas as APIs disponíveis para clonar.

Ao pedir ao assistente para excluir uma API, ele irá avisá-lo se a API estiver atualmente publicada, pedirá que você verifique se deseja excluí-la e confirmará se ela foi excluída com sucesso.

Um nome de 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.

Você também pode publicar e testar APIs:

Exemplo de solicitações do usuário

Me dê uma lista de APIs em rascunho disponíveis para publicação.
Publique a API "Clientes".
Teste a API "Clientes".

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

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 UI como referência suplementar.

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 lhe parecer mais natural, 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 os prompts 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 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.

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.