Exemplo A: criar um conector a partir de uma tela em branco com autenticação do Token de Acesso Pessoal

No exemplo a seguir, construímos um conector para o OpenAI DALL-E a partir de uma tela em branco, usando a autenticação do Token de Acesso Pessoal.

Criar novo conector

Este exemplo mostra como usar o modelo DALL-E da OpenAI para gerar uma imagem com base em um prompt de texto.

1. No Automation Suite, navegue até o Integration Service.
2. Na página Catálogo de conectores, selecione Crie seu conector ou Construtor de conectores.
3. Em seguida, selecione Criar novo conector.
4. Selecione Iniciar em branco.
5. Adicione um Nome para seu conector e, opcionalmente, uma descrição e um ícone.
6. Selecione Criar.
   
   

   

   
   

Configure o recurso de API

Como funciona

Primeiro, vamos ver como funciona a geração de uma imagem por meio da API.

Com o DALL-E, você fornece um prompt, o modelo o reescreve automaticamente por razões de segurança e adiciona mais detalhes. Prompts detalhados geralmente resultam em saída de maior qualidade. Em seguida, o modelo gera a imagem gerada por meio de um link ("responseformat": "URL") ou de uma string Base64 ("responseformat": "b64_json"). O URL é o valor padrão de acordo com a especificação da API. Para obter mais detalhes sobre os parâmetros da API, consulte a Referência de API - API OpenAI.

Aqui está um exemplo de cURL para gerar uma imagem usando essa API:

cURL https://api.openai.com/v1/images/generations \ 

  -H "Content-Type: application/json" \ 

  -H "Authorization: Bearer $OPENAIAPIKEY" \ 

  -d '{ 

    "model": "dall-e-3,""prompt": "A robot automating human task in computer,""n": 1, 

    "size": "1024x1024" 

  }'

Configure o mecanismo e os recursos de autenticação

Há três coisas principais que você precisa estar ciente ao criar o primeiro recurso de API para seu conector:

• URL base
• Tipo de Autenticação
• Operação e Recurso de API (às vezes chamados de rotas)

Analisando o cURL anterior, é possível observar os seguintes componentes:

• URL base: https://api.openai.com/images
• Tipo de autenticação: Authorization: Bearer $OPENAIAPIKEY
• Operação e Recurso de API: post /generations

A URL base fornece o local ou o endpoint do recurso de API para o qual as chamadas serão feitas.

O tipo de autenticação informa ao conector como o usuário foi autenticado antes de ter permissão para usar o recurso de API. Neste exemplo, estamos usando o token de acesso pessoal como um token de portador no cabeçalho de autorização, usando a chave da API OpenAI.

As rotas de API – a operação e o recurso – fornecem o caminho para um recurso específico disponível na API, por exemplo, /generations. O recurso é anexado ao URL base, no qual esse recurso pode ser buscado/listado (GET), adicionado ou inserido (POST ), atualizado/upserted (PATCH/PUT) ou excluído (DELETE).

Você pode adicionar quantos recursos de API e operações desejar, com base nas atividades necessárias para seu fluxo de trabalho. Por exemplo, você pode gerar imagens (POST /generations), listar todas as imagens geradas com GET /generations (se a operação GET estiver disponível para o recurso) ou editar uma imagem existente (POST /edits).

Observação: o Construtor de Conector atualmente suporta application/json como tipo de conteúdo de carga e não dados de formulário. A funcionalidade Edição de Imagem do modelo DALL-E pode não estar disponível com o Connector Builder no momento.

Teste a saída do recurso da API

Antes de publicar e usar o conector em seu fluxo de trabalho, teste-o primeiro.

1. Certifique-se de que seu conector esteja com o status Conectado . Selecione Adicionar conexão no canto superior direito da janela e configure uma conexão por meio do mecanismo de autenticação selecionado.
   
   

   

   
   
2. Navegue até seu primeiro recurso de API e selecione Enviar solicitação.
3. Forneça o corpo ou a carga útil para a API, conforme indicado no seguinte script cURL:

   { 
       "model": "dall-e-3", 
       "prompt": "A robot automating human task in computer", 
       "n": 1, 
       "size": "1024x1024" 
     }

   
   

   

   
   

   
   

   

   
   

   
   

   

   
   

Configure as atividades

Agora que pode testar seu conector, você pode configurar o design do componente de fluxo de trabalho para essa atividade específica, por meio do Designer de atividades.

O Activity Designer ajuda a selecionar os campos de entrada e saída que você deseja expor aos usuários para essa atividade. Isso representa a "aparência" quando o conector de API é usado no UiPath Studio ou no Studio Web. Para obter mais informações, consulte Designer de atividades.

Você pode alterar o nome de exibição dos campos, marcar os campos de entrada como necessários ou não, sejam eles um parâmetro principal ou secundário, etc. Os campos de entrada são gerados automaticamente a partir dos campos ou corpo da solicitação depois que você realiza uma ação Enviar Solicitação .

Já para os campos de resposta ou saída, você pode atualizar a chave raiz da resposta para poder selecionar atributos de saída específicos da resposta da API, como revised_prompt ou URL, conforme capturado na imagem a seguir.

Publicar o conector

Em seguida, publique seu conector no tenant de sua escolha. Para obter mais informações, consulte Publicação do seu conector. Então você pode usá-lo em seus fluxos de trabalho do Studio Desktop ou Studio Web.

Studio Web

1. No Studio Web, crie um novo projeto. No painel de pesquisa de atividades, pesquise sua atividade personalizada e adicione-a ao seu fluxo de trabalho.
   
   

   

   
   
2. A partir da atividade personalizada, crie a conexão e comece a configurar os parâmetros.
3. Teste seu fluxo de trabalho.

StudioDesktop

Observação:

Você precisa do Studio Desktop 2023.10 ou mais recente.

1. Certifique-se de que o Studio Desktop esteja conectado ao mesmo tenant no qual o conector foi publicado.
2. No painel Atividades , certifique-se de que o filtro Disponível esteja habilitado.
3. No painel Atividades , na seção Disponível , procure o nome do seu conector. Arraste e solte qualquer atividade no seu fluxo de trabalho. Isso instala o pacote unificado UiPath.IntegrationService.Activities , que contém todas as atividades baseadas no Integration Service, incluindo suas personalizadas.
4. Como alternativa, você pode usar o painel Gerenciar Pacotes para pesquisar e instalar o pacote UiPath.IntegrationService.Activities .