Consumo de fluxos de trabalho da API

Consumindo fluxos de trabalho de API a partir do Orchestrator

Para executar seus fluxos de trabalho de API publicados a partir do Orchestrator:

1. Em seu Automation Cloud Orchestrator, acesse a pasta onde o processo de fluxo de trabalho da API está.
2. Navegue até Automações > Processos.
3. Para o processo de fluxo de trabalho da API desejado, selecione Iniciar um trabalho no final da linha correspondente.
4. Na página que será aberta, forneça:
   • Opções de Destino da Execução
   • Opções de Argumentos de runtime . A seção Entrada representa seu esquema de entrada de solicitação de API e permite que você especifique propriedades a serem usadas como entradas para execução.
5. Para executar seu processo, selecione Iniciar.

Depois que seu fluxo de trabalho for executado com sucesso, você poderá visualizar a resposta gerada nos detalhes de execução do fluxo de trabalho: Automações > Trabalhos.

Invocando fluxos de trabalho de API em um Agente

Estenda a capacidade de seus agentes da UiPath integrando fluxos de trabalho de API como ferramentas. Os agentes consultam automaticamente esses fluxos de trabalho para coletar contexto relevante, permitindo controle preciso sobre os dados disponíveis para seus agentes e modelos de IA.

O cenário a seguir demonstra como um fluxo de trabalho de API pode transformar dados recuperados do Workday, limitando as informações expostas aos agentes apenas a nomes e endereços de e-mail. Na caixa de área restrita do Workday, ela é configurada como uma gerente com relatórios diretos e pares atribuídos. Exemplos de consultas para o agente incluem:

• "quem se reporta aBeeBee:
• "Forneça todos os pares para bucket bucket.."
• "Algum dos colegas deBeeBee tem relatórios?"

Importante: o agente não armazena suas credenciais do Workday, não pode consultar diretamente o Workday e depende apenas das respostas retornadas pelo fluxo de trabalho da API.

Antes de começar, certifique-se de que os seguintes pré-requisitos sejam atendidos:

• Você publicou seu fluxo de trabalho da API do Workday no Orchestrator. Confirme se o fluxo de trabalho é executado com sucesso quando executado a partir do Orchestrator.
• As Platform Units são atribuídas ao seu tenant.
• Para seguir o exemplo de integração do Workday fornecido, certifique-se de que seu fluxo de trabalho inclua:
  • Um esquema de entrada com campos para primeiro nome e sobrenome.
  • Um esquema de saída contendo matrizes para Pares e Relatórios Diretos.

1. Crie seu agente manualmente. Como alternativa, use o gerador do Autopilot com o seguinte prompt:

   "Consulta do Workday para detalhes de gerentes, relatórios e pares."

   Seu agente é criado com o Autopilot, que sugere as solicitações e a configuração do agente. Neste exemplo, os prompts sugeridos foram inicialmente aceitos, mas o Prompt do Usuário foi posteriormente simplificado para conter apenas a variável {{query }} .

2. No painel Gerenciador de dados do seu agente, defina uma propriedade de entrada chamada query, do tipo String. Isso garante que seu Prompt do Usuário contenha uma referência válida.
   
3. Selecionar Depurar na nuvem. Você é solicitado a fornecer a consulta para seu Prompt do Usuário. No entanto, o painel Rastreamento de execução mostra que o agente atualmente não tem acesso ao Workday e, portanto, ainda não pode fornecer uma resposta.
4. Na seção Ferramentas do seu agente, selecione Adicionar ferramenta > Fluxo de trabalho de API.
5. Selecione o fluxo de trabalho da API existente (aquele que consulta o Workday) e forneça uma descrição para ele. Como uma prática recomendada, forneça detalhes suficientes para que o agente configure automaticamente o fluxo de trabalho com base na sua solicitação. Uma descrição clara normalmente inclui detalhes sobre seus parâmetros de entrada. Por exemplo:
   "Recebe o nome e o sobrenome de um trabalhador como entrada e fornece seus relatórios diretos e pares na resposta. A entrada de nome é o gerenciador que procuraremos no Workday."
6. Execute seu agente novamente selecionando Depurar na nuvem. Forneça a seguinte consulta: "quem se reporta aBee. O painel Rastreamento da execução agora identifica que o agente chama o fluxo de trabalho da API, incluindo:
   • A solicitação enviada para o fluxo de trabalho da API
   • A resposta recebida do fluxo de trabalho da API
   • Como o agente usa a resposta para preencher sua consulta

Parabéns!

Agora você pode criar variações do prompt do usuário do seu agente. Dependendo da consulta, o agente pode disparar várias chamadas para seu fluxo de trabalho da API antes de fornecer uma resposta completa.

Uso de fluxos de trabalho da API como tarefas no Maestro

Os fluxos de trabalho de API como tarefas no Maestro encapsulam transformações de dados e encadeamento de API detalhado. Isso mantém o processo primário do Maestro claro, conciso e fácil de seguir. Ao isolar interações específicas da API dentro de fluxos de trabalho da API, você mantém a legibilidade e promove a reusabilidade em vários processos.

O cenário a seguir demonstra como o Maestro chama as APIs do Workday e, em seguida, envia uma notificação da equipe do Slack sempre que um funcionário é encerrado.

Antes de começar, certifique-se de que os seguintes pré-requisitos sejam atendidos:

• Você publicou seu fluxo de trabalho da API do Workday no Orchestrator. Confirme se o fluxo de trabalho é executado com sucesso quando executado a partir do Orchestrator.

  Certifique-se de que seu fluxo de trabalho de API inclua:

  • Um esquema de entrada com campos para Nome e Sobrenome.
  • Um esquema de saída contendo matrizes para Pares e Relatórios Diretos.

Etapa 1: criação de um processo com agente

1. Crie um processo com agente.
2. Adicione um elemento Evento de início . Nomeie-a "Employee Hid".
   1. Para a propriedade Ação do evento Iniciar, selecione Aguardar evento de conector.
   2. Para a propriedade Conector , selecione Workday REST - Worker Created. Esse é o evento que dispara o processo.
3. Adicione um elemento Tarefa e conecte o evento Iniciar a ele. Nomeie-a "Encontrar relacionamentos de funcionários".
4. Adicione outro elemento Tarefa , nomeie-o como "Enviar Notificações" e conecte o elemento Find Employee Connections a ele.
5. Adicione um Evento de término. Nomeie-a "Notificação enviada".

Esta é a configuração do processo. Sempre que um novo funcionário é contratado, o processo dispara o fluxo de trabalho da API, que recupera informações do funcionário, como sua estrutura de hierarquia e relacionamentos associados.

Etapa 2: configuração da tarefa Find Employee Relationship

O fluxo de trabalho da API exigido pelo processo com agente reside na tarefa Encontrar relacionamentos de funcionários. Aqui está como configurá-lo:

1. Selecione a tarefa Encontrar Relacionamentos de Funcionários .
2. Para a propriedade Ação , selecione Iniciar e aguarde o fluxo de trabalho da API.
3. Para a propriedade Fluxo de trabalho da API , selecione o fluxo de trabalho da API do Workday publicado. O painel de propriedades exibe entradas e saídas para o fluxo de trabalho selecionado. Para este exemplo:
   • As entradas incluem Sobrenome e Nome.
   • As saídas incluem detalhes para Gerente, Pares e Relatórios.
4. Configure as entradas da seguinte forma:
   • Nome como uma variável do objeto de resposta de evento Start . Abra o Editor de expressão, selecione Inserir variável e navegue até Employee Hid > response > Worker > Full name. Em seguida, adicione Split(' ')[0] à expressão. Ele deve ter a seguinte aparência:

     vars.response_1.worker.descriptor.Split(' ')[0]

     Onde worker é o objeto de resposta da resposta de Evento de início , e.Split(' ')[0] divide o nome completo pelo caractere de espaço e busca a primeira parte do nome completo.
   • Sobrenome como uma variável do objeto de resposta de evento Start . Abra o Editor de expressão, selecione Inserir variável e navegue até Employee Hid > response > Worker > Full name. Em seguida, adicione Split(' ')[1] à expressão. Ele deve ter a seguinte aparência:

     vars.response_1.worker.descriptor.Split(' ')[1]

     Onde worker é o objeto de resposta da resposta de Evento de início , e.Split(' ')[1] divide o nome completo pelo caractere de espaço e busca a segunda parte do nome completo.

Etapa 3: personalização da tarefa Enviar notificação

Nesta etapa, você configura a tarefa Enviar notificação para usar dados retornados do fluxo de trabalho da API executado na Etapa 2.

1. Selecione a tarefa Enviar notificação .
2. Para a propriedade Ação , selecione Executar evento de conector.
3. Para a propriedade Conector , selecione Slack e configure-o para usar sua Conexão.
4. Para a propriedade Atividade , selecione Enviar mensagem para o canal.
5. Para o Nome/ID do canal, escreva o ID do canal do Slack para onde a notificação deve ser enviada.
6. Para a propriedade Mensagem , selecione as variáveis de saída da Etapa 2: Gerente, Pares e Relatórios.
7. Para a propriedade Enviar como , selecione bot.

Etapa 4: testar seu processo com agente

Para testar com sucesso esse processo com agente, certifique-se de ter acesso ao seu ambiente de área restrita do Workday.

Selecione Testar para validar seu fluxo de trabalho. O Maestro solicita que você forneça duas conexões essenciais:

• Conexão do Slack—Exigido pela tarefa Enviar notificação .
• Conexão do Workday —Exigida pelo evento de início.

Importante: o Maestro não solicita conexões para o fluxo de trabalho da API, pois essas conexões são gerenciadas separadamente dentro do próprio fluxo de trabalho da API.