Ejemplo A: crear un conector a partir de un lienzo en blanco con autenticación de token de acceso personal

En el siguiente ejemplo, creamos un conector para OpenAI DALL-E a partir de un lienzo en blanco, utilizando la autenticación de token de acceso personal.

Crear el nuevo conector

Este ejemplo muestra cómo utilizar el modelo DALL-E de OpenAI para generar una imagen basada en una solicitud de texto.

1. Ve a Integration Service.
2. En la página del catálogo de conectores, selecciona Crea tu conector o Generador de conectores.
3. A continuación, selecciona Crear nuevo conector.
4. Selecciona Comenzar desde cero.
5. Añade un Nombre para tu conector y, opcionalmente, una descripción y un icono.
6. Selecciona Crear.
   
   

   

   
   

Configurar el recurso de la API

Cómo funciona

Primero, veamos cómo funciona la generación de una imagen a través de la API.

Con DALL-E, proporcionas una solicitud, el modelo la reescribe automáticamente por razones de seguridad y añade más detalles. Las solicitudes detalladas suelen dar como resultado una salida de mayor calidad. A continuación, el modelo genera la imagen generada a través de un enlace ("responseformat": "URL") o una cadena Base64 ("responseformat": "b64_json"). La URL es el valor predeterminado, según la especificación de la API. Para obtener más información sobre los parámetros de la API, consulta Referencia de la API: API de OpenAI.

Aquí hay un ejemplo de cURL para generar una imagen utilizando esta 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" 

  }'

Configurar el mecanismo de autenticación y los recursos

Hay tres cosas clave que debes tener en cuenta al crear el primer recurso API para tu conector:

• URL base
• Tipo de Autenticación
• Operación y recurso de API (a veces llamados rutas)

Al diseccionar el cURL anterior, puedes observar los siguientes componentes:

• URL base: https://api.openai.com/images
• Tipo de autenticación: Authorization: Bearer $OPENAIAPIKEY
• Operación y recurso de la API: post /generations

La URL base proporciona la ubicación o el punto final del recurso de la API para el que se van a realizar las llamadas.

El tipo de autenticación le dice al conector cómo se autentica el usuario antes de que se le permita utilizar el recurso de la API. En este ejemplo, estamos utilizando el token de acceso personal como token de portador en el encabezado de autorización, utilizando la clave API de OpenAI.

Las rutas de la API (la operación y el recurso) proporcionan la ruta a un recurso específico disponible en la API, por ejemplo /generations. El recurso se anexa a la URL base, en la que ese recurso se puede obtener/enumerar (GET), añadir/insertar (POST ), actualizar/upserted (PATCH/PUT) o eliminar (DELETE).

Puedes añadir tantos recursos y operaciones de la API como quieras, en función de las actividades que necesites para tu flujo de trabajo. Por ejemplo, puedes generar imágenes (POST /generations), enumerar todas las imágenes generadas con GET /generations (si la operación GET está disponible para el recurso) o editar una imagen existente (POST /edits).

Nota: el Creador de conectores actualmente admite application/json como tipo de contenido de carga útil y no como datos de formulario. La funcionalidad de edición de imágenes del modelo DALL-E puede no ser posible con Connector Builder en este momento.

Probar la salida del recurso API

Antes de publicar y utilizar el conector en tu flujo de trabajo, pruébalo primero.

1. Asegúrate de que tu conector está en estado Conectado . Selecciona Añadir conexión en la esquina superior derecha de la ventana y configura una conexión a través del mecanismo de autenticación seleccionado.
   
   

   

   
   
2. Navega hasta tu primer recurso API y selecciona Enviar solicitud.
3. Proporciona el cuerpo o la carga útil para la API, como se indica en el siguiente script cURL:

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

   
   

   

   
   

   
   

   

   
   

   
   

   

   
   

Configurar las actividades

Ahora que puedes probar tu conector, puedes configurar el diseño del componente de flujo de trabajo para esta actividad específica, a través del Diseñador de actividades.

El Diseñador de actividades ayuda a seleccionar los campos de entrada y salida que quieres exponer a los usuarios para esta actividad. Esto representa la "apariencia" cuando el conector API se utiliza en UiPath Studio o Studio Web. Para obtener más información, consulta Diseñador de actividades.

Puedes cambiar el nombre para mostrar de los campos, marcar los campos de entrada como obligatorios o no, si son un parámetro principal o secundario, etc. Los campos de entrada se generan automáticamente a partir de los campos o el cuerpo de la solicitud una vez que realizas una acción Enviar solicitud .

En cuanto a los campos de respuesta o salida, puedes actualizar la clave raíz de la respuesta para seleccionar atributos de salida específicos de la respuesta de la API, como revised_prompt o URL, como se muestra en la siguiente imagen.

Publicar el conector

A continuación, publica tu conector en el tenant de tu elección. Para obtener más información, consulta Publicar tu conector. A continuación, puedes utilizarlo en tus flujos de trabajo de Studio Desktop o Studio Web.

Studio Web

1. En Studio Web, crea un nuevo proyecto. En el panel de búsqueda de actividades, busca tu actividad personalizada y añádela a tu flujo de trabajo.
   
   

   

   
   
2. Desde la actividad personalizada, crea la conexión y comienza a configurar los parámetros.
3. Pruebe su flujo de trabajo.

EscritorioStudio

Nota:

Necesita Studio Desktop 2023.10 o posterior.

1. Asegúrate de que Studio Desktop está conectado al mismo tenant donde se publicó el conector.
2. En el panel Actividades , asegúrate de que el filtro Disponible está habilitado.
3. En el panel Actividades , en la sección Disponible , busca el nombre de tu conector. Arrastra y suelta cualquier actividad en tu flujo de trabajo. Esto instala el paquete unificado UiPath.IntegrationService.Activities , que contiene todas las actividades basadas en Integration Service, incluidas las personalizadas.
4. Como alternativa, puedes utilizar el panel Gestionar paquetes para buscar e instalar el paquete UiPath.IntegrationService.Activities .