Crie o fluxo de trabalho da API

Crie um fluxo de trabalho da API Consultar o Monstro que chama o SRD 5e do D&D e retorne dados estruturados do Monstro.

Etapa 1 - Construir o fluxo de trabalho da API do Monstruário Query

Um Fluxo de trabalho de API é um fluxo de trabalho leve publicado como um endpoint de API. Você cria um que encapsula a pesquisa de robôs Open5e D&D 5e SRD: uma entrada, uma solicitação HTTP, uma saída. Após publicada, ela aparece no Agent Builder como uma ferramenta que seu agente pode chamar.

Essa etapa possui seis subetapas; Consulte o orçamento de 10 a 15 minutos para concluí-lo.

Crie um novo projeto de fluxo de trabalho de API

Selecione Criar novo a partir do seu espaço de trabalho no Cloud e escolha Fluxo de trabalho da API como o tipo de projeto.

Renomeie a solução e o fluxo de trabalho padrão. Abra o menu de contexto para cada nome no explorador de projetos e selecione Renomear:

• Nome da solução: Monster Query - 5e SRD
• Nome do fluxo de trabalho: API Query - 5e Monsters

Configurar entradas e saídas

Selecione o Data Manager (ícone da área de transferência ao longo do trilho esquerdo) para acessar as variáveis de dados para o fluxo de trabalho.

Adicione um argumento de entrada ao fluxo de trabalho:

Name	Tipo	Required	Description
searchName	String	Sim	O nome ou nome parcial do compatíveis a ser pesquisado

Adicione um argumento de saída:

Name	Tipo	Required	Description
monsterResults	Matriz	Sim	Lista de resultados mostrados

Adicionar a solicitação HTTP

1. Na tela do fluxo de trabalho, selecione + entre atividades para abrir o menu de atividades. Selecione Solicitação HTTP.
2. Abra o menu de contexto da atividade e selecione Renomear. Nomeie-o HTTP Request - Open5e Monster Query.
3. No painel Propriedades , defina Autenticação para Autenticação manual.
4. Defina Método como GET.
5. Defina URL como https://api.open5e.com/v1/monsters/.
6. Renomeie a saída da atividade para searchResults.

Defina a propriedade Parâmetros de consulta:

Abra a propriedade Parâmetros de Consulta e adicione os seguintes campos:

Chave	Valor
name__icontains	@searchName
document__slug	wotc-srd
limit	10
fields	slug,name,desc,type,size,cr,challenge_rating,alignment,v2_converted_path

O que cada parâmetro faz:

• name__icontains: correspondência parcial sem diferenciação entre maiúsculas e minúsculas; dragon retorna "Adult Red Robot", "Young Blue Robot" e outros
• document__slug: wotc-srd: filtra para o SRD oficial do D&D 5e; sem ele, os resultados incluem conteúdo página inicial de terceiros
• limit: 10: limita os candidatos em 10; o suficiente para o agente raciocinar sem confundir seu contexto
• fields: limita a resposta apenas aos campos de que o agente precisa; o objeto monitor completo do Open5e é muito maior e desperdiçaria o orçamento de tokens

Referência da propriedade da solicitação HTTP

A atividade expõe os blocos de construção HTTP padrão. O máximo que você configurará para cada API que chamar; algumas você ignorará para APIs públicas como esta:

• Autenticação: opções pré-criadas para OAuth 2.0, chave de API e autenticação básica. Defina como "Autenticação manual" aqui porque o Open5e não exige nenhuma. Para APIs autenticadas, escolha a opção apropriada e forneça as credenciais.
• Cabeçalhos: pares de chave/valor enviados com cada solicitação. Usos comuns: para APIs baseadas em token, Authorization: Bearer <token> para controlar Accept: application/json formato de resposta e cabeçalhos de versionamento de API.
• Corpo: usado com solicitações POST, PUT e PATCH para enviar JSON, dados do formulário ou conteúdo bruto. Não aplicável a solicitações GET, que carregam parâmetros no URL por meio de parâmetros de consulta.
• Parâmetros de consulta: pares de chave/valor anexados ao URL. A sintaxe @variableName faz referência aos argumentos do fluxo de trabalho por nome; @searchName extrai o argumento de entrada searchName definido no Gerenciador de dados. Consulte configuração de atividades para saber mais sobre variáveis e expressões no Studio Web.
• Saída (renomeada para searchResults): recebe a resposta HTTP completa, incluindo código de status, cabeçalhos e corpo. Renomear a partir do padrão mantém a expressão Definir resposta legível.

Adicionar a resposta

1. Na tela de fluxo de trabalho, selecione + após a Solicitação HTTP e selecione Definir resposta.

   Set Response define o que o fluxo de trabalho da API retorna ao seu chamador (neste caso, o que a ferramenta do agente recebe quando invoca o fluxo de trabalho). O que você colocar no corpo da resposta aqui, torna-se a saída da ferramenta sobre a qual o agente raciocina.

2. Defina o corpo da resposta como:

   {
     "monsterResults": $context.outputs.searchResults.content.results
   }
   

$context.outputs contém todas as saídas nomeadas das atividades nesse fluxo de trabalho. searchResults é a variável de saída que você renomeou na atividade HTTP Request; .content.results navega pelo envelope de resposta no qual o Open5e envolve seus dados, até a matriz real de entradas entrada "mostradas". Para obter mais informações, consulte a documentação da UiPath sobre o uso do Javascript para acessar dados do fluxo de trabalho.

Teste o fluxo de trabalho

1. Selecione Debug na barra de ferramentas.
2. No painel de entrada, defina searchName como dragon ou goblin e execute o fluxo de trabalho.
3. Verifique se a resposta inclui uma matriz monsterResults com entradas detalhadas antes de continuar.

Uma resposta bem-sucedida contém até 10 entradas, cada uma com campos como name, type, cr e slug. Se você vir uma matriz vazia, tente um termo de pesquisa diferente; nem todos os nomes de criação têm uma correspondência exata no SRD.

Publicar em seu feed

A publicação registra o fluxo de trabalho como um processo implantável no Orchestrator. É isso que o torna detectável na lista de recursos disponíveis do Agent Builder: o construtor revela fluxos de trabalho publicados a partir do seu espaço de trabalho, não rascunhos salvos localmente no Studio Web.

1. Selecione Publicar na barra de ferramentas.
2. Na caixa de diálogo de publicação, selecione Para eu publicar no feed do seu espaço de trabalho pessoal. Um feed de espaço de trabalho pessoal é um repositório de pacotes privado vinculado ao seu espaço de trabalho do Orchestrator; publicar "Para mim" torna esse fluxo de trabalho visível apenas para você, que é o escopo correto para desenvolvimento e testes. Consulte Espaços de trabalho pessoais nos documentos da UiPath para obter detalhes.
3. Selecione Publicar para confirmar.

Observação:

O fluxo de trabalho não aparece em Recursos disponíveis na etapa 3? O fluxo de trabalho deve ser publicado (não apenas salvo) antes de ficar visível como uma ferramenta. Se ele não aparecer, retorne aqui e confirme se a publicação foi concluída com sucesso e, em seguida, atualize o Agent Builder.

---

Com o fluxo de trabalho publicado, ele fica disponível no Agent Builder como uma ferramenta conectável na próxima seção.