Agente de Conhecimento Jitterbit

Visão Geral

O Agente de Conhecimento Jitterbit (Agente de Conhecimento) é um agente de IA fornecido através do Jitterbit Marketplace que tem como objetivo permitir que a equipe interna da sua organização obtenha respostas inteligentes a partir dos dados internos da sua organização. Ele faz o seguinte:

• Conecta-se e busca informações das seguintes fontes usando o Jitterbit Integration Studio:

  • Páginas do Atlassian Confluence
  • Problemas do Atlassian Jira
  • Documentos do Google Drive
  • Casos de suporte do Salesforce (do objeto Case)

• Integra-se com o Azure OpenAI para alimentar um chatbot inteligente de IA usando dados das fontes acima acessados por meio de uma API personalizada criada com o Jitterbit API Manager.

Este documento explica a configuração e operação do agente. Primeiro cobre os pré-requisitos, em seguida fornece exemplos de prompts para mostrar o que o agente pode fazer, e então fornece passos para instalar, configurar e operar o agente.

Pré-requisitos

Para usar o Agente de Conhecimento, os seguintes componentes são necessários ou assumidos no design do agente.

Componentes do Harmony

Você deve ter uma licença Jitterbit Harmony com acesso aos seguintes componentes:

• Jitterbit Integration Studio
• Jitterbit API Manager
• Agente de Conhecimento Jitterbit adquirido como um complemento de licença

Recursos do Azure

Você deve ter uma assinatura do Microsoft Azure com permissões para criar e gerenciar os seguintes recursos:

• Armazenamento do Azure com um contêiner Blob para armazenar dados buscados.
• Azure AI Search com um serviço de busca que pode ser configurado com um índice e indexador.
• Azure OpenAI com um modelo gpt-4o ou gpt-4.1 implantado.

Endpoints suportados

Os seguintes endpoints estão incorporados no design do agente.

Base de conhecimento

Você pode usar qualquer um ou todos esses endpoints como a base de conhecimento para este agente de IA:

• Atlassian Confluence: A fonte das páginas do Confluence.
• Atlassian Jira: A fonte dos problemas do Jira.
• Google Drive: A fonte dos arquivos armazenados em um drive compartilhado do Google.
• Salesforce: A fonte dos casos de suporte ao cliente do objeto Case.

Interface de chat

O design do agente incorpora o Slack como a interface de chat para interagir com o agente de IA. Se você quiser usar um aplicativo diferente como a interface de chat, um fluxo de trabalho separado e instruções para uma configuração de API genérica estão incluídos neste agente de IA.

Exemplos de prompts

Aqui estão exemplos de prompts que o Agente de Conhecimento pode lidar com acesso aos dados apropriados. O agente pode encontrar informações em qualquer um ou todos os endpoints conectados.

• "Estou tendo um problema com o componente 'ABC'. Você pode ajudar com isso?"
• "Como posso me conectar a um banco de dados MySQL usando JDBC?"
• "Você pode me dar detalhes sobre o ticket do Jira número 123?"
• "Existem tickets do Jira relacionados ao conector SQL?"
• "Qual é a política de segurança para instalar software no meu computador de trabalho?" (Pode haver um documento no Google Drive ou uma página do Confluence sobre este tópico.)

Instalação, configuração e operação

Siga estas etapas para instalar, configurar e operar este agente de IA:

1. Baixar personalizações e instalar o projeto do Integration Studio.
2. Revisar fluxos de trabalho do projeto.
3. Criar recursos do Microsoft Azure.
4. Configurar uma conta de serviço do Google e um drive compartilhado.
5. Configurar variáveis do projeto.
6. Testar conexões.
7. Implantar o projeto.
8. Criar a API personalizada do Jitterbit.
9. Criar o aplicativo Slack, testar a conexão do Slack e reimplantar o projeto.
10. Acionar os fluxos de trabalho do projeto.

Baixar personalizações e instalar o projeto

Siga estas etapas para baixar arquivos de personalização e instalar o projeto do Integration Studio para o agente de IA:

1. Faça login no portal Harmony em https://login.jitterbit.com e abra Marketplace.

2. Localize o agente de IA chamado Jitterbit Knowledge Agent. Para localizar o agente, você pode usar a barra de pesquisa ou, no painel Filtros, sob Tipo, selecione Agente de IA para limitar a exibição aos agentes de IA disponíveis.

3. Clique no link Documentação do agente de IA para abrir sua documentação em uma nova aba. Mantenha a aba aberta para consultar depois de iniciar o projeto.

4. Clique em Iniciar Projeto para abrir um diálogo de configuração em duas etapas para baixar personalizações e importar o agente de IA como um projeto do Integration Studio.

   Nota

   Se você ainda não adquiriu o agente de IA, Adquirir este agente será exibido em vez disso. Clique nele para abrir um diálogo informativo e, em seguida, clique em Enviar para que um representante entre em contato com você sobre a compra do agente de IA.

5. Na etapa de configuração 1, Baixar Personalizações, os seguintes arquivos são fornecidos para facilitar a configuração do índice e do indexador no Azure AI Search e para criar o aplicativo Slack. Selecione os arquivos e clique em Baixar Arquivos:

   • Arquivos de definição JSON do índice e indexador do Azure AI Search

     • Azure_AI_Search_Datasource_Definition.json
     • Azure_AI_Search_Index_Definition.json
     • Azure_AI_Search_Indexer_Definition.json

   • Arquivo de manifesto do aplicativo Slack

     • slack_app_manifest.json

   Dica

   O diálogo de configuração inclui um aviso para não importar o modelo antes de aplicar as personalizações de endpoint. Esse aviso não se aplica a este agente de IA e pode ser ignorado. Siga a ordem recomendada de etapas nesta documentação.

   Clique em Próximo.

6. No passo de configuração 2, Criar um Novo Projeto, selecione um ambiente onde o projeto do Integration Studio será criado e clique em Criar Projeto.

7. Um diálogo de progresso será exibido. Assim que indicar que o projeto foi criado, use o link do diálogo Ir para o Integration Studio ou abra o projeto diretamente na página de Projetos do Integration Studio.

Revisar fluxos de trabalho do projeto

No projeto aberto do Integration Studio, revise os fluxos de trabalho juntamente com as descrições abaixo para entender o que eles fazem.

1. Utilitário de Upload de Dados - Ticket JIRA para Índice Azure

   Este fluxo de trabalho busca problemas do Jira e, em seguida, executa o fluxo de trabalho Utilitário - Upload de Dados e Índice Azure para fazer upload dos problemas para o Azure Blob Storage e indexá-los no índice de Pesquisa AI do Azure.

   A operação inicial é Principal - upload de tickets JIRA. Os seguintes campos são buscados:

   "fields": [
       "summary",
       "status",
       "assignee",
       "description",
       "reporter",
       "created",
       "updated",
       "priority",
       "issuetype",
       "components",
       "comment"
    ]
   

   Este fluxo de trabalho pode ser configurado para buscar todos os problemas ou apenas problemas novos e atualizados, usando as variáveis do projeto Jira.

2. Utilitário de Upload de Dados - Casos SF para Índice Azure

   Este fluxo de trabalho recupera casos de suporte do Salesforce e, em seguida, executa o fluxo de trabalho Utilitário - Upload de Dados e Índice Azure para fazer upload dos casos para o Azure Blob Storage e indexá-los no índice de Pesquisa AI do Azure.

   A operação inicial é Main - SF Cases Upload.

   Na configuração da atividade de Consulta do Salesforce, a seguinte consulta recupera informações de casos de suporte por agente. Se sua organização Salesforce não usar esses objetos e campos, ou se as informações de casos de suporte estiverem armazenadas em objetos e campos diferentes, este fluxo de trabalho não funcionará corretamente. Personalize a consulta neste fluxo de trabalho para alinhar-se ao modelo de dados da sua organização Salesforce:

   SELECT Account.Name,
          Owner.Email,
          Owner.Name,
          (SELECT CreatedBy.Email,
                  CreatedBy.Name,
                  Id,
                  CommentBody,
                  CreatedDate,
                  LastModifiedDate,
                  LastModifiedBy.Email,
                  LastModifiedBy.Name
           FROM   CaseComments),
          Id,
          CaseNumber,
          CreatedDate,
          Description,
          LastModifiedDate,
          Origin,
          Priority,
          Reason,
          Status,
          Subject,
          Type,
          CreatedBy.Email,
          CreatedBy.Name,
          LastModifiedBy.Email,
          LastModifiedBy.Name
   FROM Case
   

   Este fluxo de trabalho pode ser configurado para buscar todos os casos, ou apenas casos novos e atualizados, usando as variáveis de projeto do Salesforce.

3. Utilitário de upload de dados - Páginas do Confluence para Índice do Azure

   Este fluxo de trabalho recupera páginas do Confluence, em seguida, executa o fluxo de trabalho Utility - Azure Data Upload and Index para fazer upload de documentos para o Azure Blob Storage e indexá-los no índice de pesquisa do Azure AI.

   A operação inicial é Main - Load Confluence Pages.

   Este fluxo de trabalho busca todas as páginas do Confluence em cada execução.

4. Utilitário de upload de dados - Google Drive para Azure Blob

   Este fluxo de trabalho recupera arquivos do Google Drive, em seguida, executa o fluxo de trabalho Utility - Azure Data Upload and Index para indexá-los no índice de pesquisa do Azure AI.

   A operação inicial é Main - Google Drive Upload.

   Os tipos de arquivo suportados incluem Google Docs, Google Spreadsheets e aqueles suportados pela indexação de blobs do Azure Storage.

   Os tamanhos máximos de arquivo suportados estão listados como o tamanho máximo de blob nos limites do Indexador do Azure AI Search para o seu nível de serviço de pesquisa AI. Por exemplo, para o nível básico, o limite é 16 MB; para S1, o limite é 128 MB.

   Este fluxo de trabalho pode ser configurado para buscar todos os arquivos, ou apenas arquivos novos e atualizados, usando as variáveis de projeto do Google Drive.

5. Utilitário - Upload de Dados para Azure e Indexação

   Este é um fluxo de trabalho utilitário comum usado pelos fluxos de trabalho do Utilitário de Upload de Dados para enviar dados para o Azure Blob Storage e indexá-los no Azure AI Search.

6. Entrada Principal - Manipulador de Solicitações da API do Slack

   Este fluxo de trabalho gerencia as solicitações recebidas do bot do Slack. Ele é acionado por meio de uma API personalizada do Jitterbit sempre que sua equipe interage com a interface de chat do bot do Slack (ou seja, envia uma mensagem para o Slack). A configuração da API personalizada do Jitterbit é descrita em Criar a API personalizada do Jitterbit mais adiante nesta página.

   Se você não estiver usando o Slack, este fluxo de trabalho pode ser ignorado e não será acionado. Para usar uma interface de chat diferente para sua equipe interagir, utilize o fluxo de trabalho Manipulador de Solicitações da API Genérica, também acionado por meio de uma API personalizada do Jitterbit.

7. Manipulador de Solicitações da API Genérica

   Este fluxo de trabalho processa solicitações de API HTTP de qualquer aplicativo. Para integrar com seus aplicativos, crie uma API personalizada do Jitterbit que acione a operação Manipulador de Solicitações da API Genérica. A URL dessa API pode então ser usada por qualquer aplicativo para enviar e receber solicitações.

   A configuração da API personalizada do Jitterbit é descrita em Criar a API personalizada do Jitterbit mais adiante nesta página.

Criar recursos do Microsoft Azure

Crie os seguintes recursos do Microsoft Azure e mantenha as seguintes informações para configurar o agente de IA. Para criar e gerenciar esses recursos, você deve ter uma assinatura do Microsoft Azure com as permissões apropriadas.

Contêiner Blob do Azure

Você deve criar um contêiner Blob do Azure para armazenar os detalhes do cliente. Os dados do contêiner Blob serão indexados no Azure AI Search usando um índice e um indexador.

Você precisará da URL SAS do contêiner para usar na determinação dos valores das variáveis do projeto do Azure Blob Storage. Para gerar a URL SAS:

1. No portal do Azure, navegue até Contas de armazenamento e abra a conta de armazenamento específica.
2. No menu de recursos sob Armazenamento de dados, selecione Contêineres e abra o contêiner específico.
3. No menu de recursos sob Configurações, selecione Tokens de acesso compartilhado.

4. Use o menu Permissões para verificar se a URL da assinatura de acesso compartilhado (SAS) para este contêiner possui no mínimo as permissões de Leitura e Gravação:

   

5. Clique em Gerar token e URL SAS.

6. Copie a URL SAS do Blob exibida na parte inferior.
7. Determine os valores das variáveis do projeto do Azure Blob Storage a partir da URL SAS. A URL SAS está no formato {{ azure_blob_base_url }}/{{ Azure_Blob_Container_Name }}?{{ azure_blob_sas_token }}.

Se estiver usando os arquivos de definição JSON incluídos nos arquivos de personalização do agente de IA para gerar o índice e o indexador, você também precisará da chave da conta do Azure Blob Storage. Para visualizar as chaves de acesso da conta:

1. No portal do Azure, navegue até Contas de armazenamento e abra a conta de armazenamento específica.
2. No menu de recursos sob Segurança + rede, selecione Chaves de acesso.

3. Clique em Mostrar chaves para revelar a chave de acesso a ser usada durante a configuração do Azure AI Search.

   

Serviço de pesquisa do Azure AI

Você deve criar um serviço de pesquisa do Azure AI e configurar seu índice e indexador para processar os dados do contêiner Blob.

Você precisará da URL e da chave da API do serviço de pesquisa do Azure AI para determinar os valores das variáveis do projeto do Azure AI Search:

• URL: Para obter o valor a ser usado para azure_ai_search_url, consulte a documentação do Azure Obter informações do serviço.
• Chave da API: Para obter o valor a ser usado para azure_ai_search_api_key, consulte a documentação do Azure Configurar acesso baseado em função.

Você pode usar os arquivos de definição JSON incluídos nos arquivos de personalização do agente de IA para gerar o índice e o indexador, ou pode criá-los você mesmo.

Se estiver usando os arquivos de definição fornecidos, você deve substituir os seguintes espaços reservados pelos seus próprios valores de configuração:

Azure_AI_Search_Indexer_Definition.json

Azure_AI_Search_Datasource_Definition.json

Recurso Azure OpenAI

Você deve criar um recurso Azure OpenAI e implantar um modelo gpt-4o ou gpt-4.1 através do portal Azure AI Foundry.

Você precisará do nome da implantação, da URL do endpoint Azure OpenAI e da chave da API para determinar os valores das variáveis do projeto Azure OpenAI. Para encontrar esses valores:

1. No portal Azure AI Foundry, abra o recurso OpenAI específico.

2. Os valores a serem usados para a URL do endpoint (azure_openai_base_url) e a chave da API (azure_openai_api_key) são exibidos na página inicial do recurso:

   

3. No menu de navegação sob Recursos compartilhados, selecione Implantações. O nome da implantação (Azure_OpenAI_Deployment_Name) é exibido.

Configurar uma conta de serviço do Google e unidade compartilhada

Essa configuração é necessária apenas se você estiver usando o fluxo de trabalho Utilitário de upload de dados - Google Drive para Azure Blob. Você deve ter um projeto ativo do Google Cloud para prosseguir. Se não tiver um, você pode criar um seguindo as instruções do Google.

Criar uma conta de serviço do Google

Siga os passos abaixo para criar uma chave para a conta de serviço do Google, permitindo que o utilitário acesse seus arquivos do Google Drive de forma segura:

1. No console do Google Cloud, use a barra de pesquisa para encontrar e navegar até a página Contas de Serviço.

2. Se você já tiver uma conta de serviço que deseja usar, prossiga para o passo 3. Caso contrário, clique em Criar conta de serviço, forneça um nome e clique em Concluído. Nenhuma permissão ou acesso adicional é necessário.

   

3. Selecione a conta de serviço para abrir os Detalhes da conta de serviço:

   

4. Navegue até a aba Chaves e use o menu Adicionar chave para selecionar Criar nova chave.

   

5. Escolha JSON como o tipo de chave e clique em Criar. Um arquivo JSON contendo as credenciais será baixado para o seu computador.

6. Abra o arquivo JSON baixado para encontrar os seguintes valores necessários para configurar as variáveis do projeto Google Drive:

   • client_email: Este é o valor para a variável de projeto Google_Client_Email e necessário para configurar o Google Drive compartilhado na próxima seção.
   • private_key: Este é o valor para a variável de projeto Google_Private_Key.

7. Ative a API do Google Drive na sua conta do Google Cloud:

   1. No console do Google Cloud, use a barra de pesquisa para encontrar e navegar até a página APIs e Serviços.

   2. Acesse a Biblioteca de APIs e selecione a API do Google Drive:

      

   3. Clique no botão Ativar:

      

Configurar o Google Drive compartilhado

O Google Drive compartilhado deve ser configurado da seguinte forma para permitir que a utilidade acesse quaisquer arquivos que você enviar para ele:

1. Crie um Google Drive compartilhado se você ainda não tiver um.

2. Abra o drive compartilhado e copie seu ID da URL do navegador. O ID é a longa sequência de caracteres no final. Por exemplo, se a URL for https://drive.google.com/drive/folders/dftg-LbGrP7hdfd, o ID é dftg-LbGrP7hdfd. Este ID é o valor para a variável de projeto Google_Drive_ID ao configurar as variáveis do projeto Google Drive.

3. Clique no nome da unidade compartilhada na parte superior da página e selecione Gerenciar membros. Um diálogo aparece.

4. No campo Adicionar pessoas e grupos, cole o valor de client_email do arquivo JSON que você baixou anteriormente.

5. Atribua o papel de Gerente de conteúdo à conta de serviço e confirme a ação.

Configurar variáveis do projeto

No projeto do Integration Studio instalado anteriormente via Marketplace, é necessário definir valores para as seguintes variáveis do projeto.

Isso pode ser feito usando o menu de ações do projeto para selecionar Variáveis do Projeto e abrir um painel na parte inferior da página onde você pode revisar e definir os valores.

Salesforce

Jira

Confluence

Google Drive

Azure Blob Storage

Azure AI Search

Azure OpenAI

Slack

Comum

Testar conexões

Teste as configurações de endpoint para verificar a conectividade usando os valores de variáveis de projeto definidos.

Isso pode ser feito na aba Endpoints e conectores do projeto do painel de componentes de design, passando o mouse sobre cada endpoint e clicando em Testar.

Implantar o projeto

Implante o projeto do Integration Studio. Isso pode ser feito usando o menu de ações do projeto para selecionar Implantar.

Criar a API personalizada do Jitterbit

Criar uma API personalizada usando o API Manager para um dos seguintes:

• Manipulador de solicitações da API do bot Slack: Necessário se estiver usando a notificação do Slack incluída no design deste agente de IA.
• Manipulador de solicitações da API genérica: Opcional. Use para manipular solicitações de API de qualquer aplicativo.

Criar o manipulador de solicitações da API do bot Slack

Esta API personalizada do Jitterbit acionará a operação Manipulador de Solicitações da API do Bot Slack. Configure e publique a API personalizada com as seguintes configurações:

• Serviço da API: Manipulador de Solicitações da API do Bot Slack
• Caminho: /
• Projeto: Selecione o projeto do Integration Studio criado a partir do Agente de Conhecimento Jitterbit no Marketplace
• Operação a Acionar: Manipulador de Solicitações da API do Bot Slack
• Método: POST
• Tipo de Resposta: Variável do Sistema

Mantenha a URL do serviço da API publicada para uso na criação do aplicativo Slack. A URL do serviço pode ser encontrada na gaveta de detalhes da API na aba Serviços, passando o mouse sobre a coluna Ações do serviço e clicando em Copiar URL do serviço da API.

Manipulador de solicitações da API genérica

Esta API personalizada do Jitterbit acionará a operação Generic API request Handler. Não é obrigatório. Crie esta API se você estiver usando outros aplicativos para processar solicitações de API HTTP. Configure e publique a API personalizada com as seguintes configurações:

• Nome do serviço: Generic API request Handler
• Projeto: Selecione o projeto do Integration Studio criado a partir do Jitterbit Knowledge Agent no Marketplace
• Operação: Generic API request Handler
• Método: POST
• Tipo de resposta: System Variable

{
    "username": "johnr",
    "prompt": "How to connect to mysql using a connector?"
}

{
    "message": "To connect to a MySQL database using the Database connector, follow these steps:   - Use the MySQL JDBC driver that ships with the agent for additional features like manual queries.",
    "references": [],
    "status_code": 200
}

Crie o aplicativo Slack, teste a conexão e reimplante o projeto

Para criar a interface de chat do Knowledge Agent no Slack, crie um aplicativo Slack usando o arquivo de manifesto do aplicativo Slack fornecido com os arquivos de personalização deste agente de IA. Ou, crie-o do zero.

Se estiver usando o arquivo de manifesto do aplicativo Slack fornecido (slack_app_manifest.json), você deve substituir os seguintes espaços reservados pelos seus próprios valores de configuração:

Após instalar o aplicativo Slack, obtenha seu token de bot.

Reabra a configuração das variáveis do projeto e insira o token de bot no valor da variável do projeto Slack_Bot_Token.

Uma vez que o token de bot esteja configurado, teste a conexão com o Slack e reimplante o projeto.

Acionar os fluxos de trabalho do projeto

Para a carga inicial de dados, execute qualquer um ou todos os fluxos de trabalho do Data upload Utility, dependendo de suas fontes de dados. Isso pode ser feito usando a opção Executar da operação inicial, que é exibida ao passar o mouse sobre a operação. Você precisará executar a operação novamente no futuro se seus dados forem atualizados.

Os outros dois principais fluxos de trabalho são acionados pelas APIs personalizadas do Jitterbit:

• Main Entry - Slack API Request Handler: Este fluxo de trabalho é acionado a partir do Slack via a API personalizada Slack Bot API Request Handler. Enviar uma mensagem direta para o aplicativo Slack iniciará o acionamento da API personalizada.

• Generic API Request Handler: Este fluxo de trabalho é acionado a partir de outro aplicativo via a API personalizada Generic API request Handler. Enviar uma solicitação para a API configurada iniciará o acionamento da API personalizada.

Todos os outros fluxos de trabalho são acionados por outras operações e estão a jusante dos listados acima. Eles não são destinados a serem executados sozinhos.

Solução de Problemas

Revise os logs da API e os logs de operações para informações detalhadas de solução de problemas.

Para assistência adicional, entre em contato com o suporte do Jitterbit.