Criar uma API com o Assistente de IA do Jitterbit API Manager

Introdução

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

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 Integration Studio usando o ícone Jitterbit AI . No painel do chatbot, use o menu suspenso para selecionar Assistente APIM.
No Integration Studio usando o menu ações de operação para selecionar Publicar como uma API usando IA.
Na página Assistente de IA do Console de Gerenciamento, que fornece uma interface dedicada em tela cheia para conversas prolongadas.

Importante

O Assistente de IA do APIM está oculto, a menos que sua licença Harmony inclua a opção do Assistente de IA do APIM. Entre em contato com seu Gerente de Sucesso do Cliente (CSM) para que ele seja adicionado à sua licença Harmony.

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: Retornar ao chat atual a partir do histórico de chats.
Histórico: Navegar pelos chats anteriores do Assistente de IA e selecionar um para visualizar.
Novo chat: Iniciar um novo chat.
Chat de usuários: Visualizar 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 permissão Admin permissão.

Comece a usar

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. 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 avisará se a API estiver atualmente publicada, pedirá que você verifique se deseja excluí-la e confirmará se ela foi excluída com sucesso.

O nome de uma 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.

Você também pode publicar e testar APIs:

Exemplo de solicitações do usuário

Dê-me uma lista de APIs em rascunho disponíveis para publicar.
Publique a API "Clientes".
Teste a API "Clientes".

Quando o assistente estiver testando uma API protegida com autenticação básica, ele fornecerá uma caixa de diálogo de interface de usuário separada 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 interface do usuário como referência suplementar.

Recomendações

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

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.
Depois que o assistente terminar a configuração dos ativos, revise e confirme o que ele criou navegando pela configuração no API Manager. 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.