Saltearse al contenido
Nappai Documentation

Azure OpenAI Embeddings

El componente Azure OpenAI Embeddings permite convertir textos en vectores numéricos (embeddings) utilizando los modelos de Azure OpenAI. Estos vectores son útiles para tareas como búsqueda semántica, clustering o clasificación de documentos dentro de Nappai.

¿Cómo funciona?

Cuando configuras el componente, Nappai envía una solicitud a la API de Azure OpenAI con los parámetros que has especificado (endpoint, despliegue, versión de API y, opcionalmente, número de dimensiones). La respuesta de la API es un vector de números que representa el contenido semántico del texto. Este vector se devuelve como salida y puede ser usado por otros componentes del flujo, por ejemplo, para comparar similitud entre textos o para alimentar modelos de clasificación.

Entradas

Antes de usar el componente, asegúrate de haber configurado una credencial Azure OpenAI API en la sección de credenciales de Nappai y seleccionarla en el campo Credential del componente.

Modo de Mapeo (Mapping Mode)

Este componente cuenta con un modo especial llamado “Mapping Mode” (Modo de Mapeo). Cuando activas este modo mediante el interruptor, se habilita una entrada adicional llamada Mapping Data y cada campo de entrada te ofrece tres formas diferentes de proporcionar datos:

  • Fixed (Fijo): Escribes el valor directamente en el campo.
  • Mapped (Mapeado): Conectas la salida de otro componente para usar su resultado como valor.
  • Javascript: Escribes código Javascript para calcular el valor dinámicamente.

Esta flexibilidad te permite crear flujos de trabajo más dinámicos y conectados.

Campos de Entrada

  • API Version: Selecciona la versión de la API de Azure OpenAI que quieres usar. Las opciones disponibles son: 2022-12-01, 2023-03-15-preview, 2023-05-15, 2023-06-01-preview, 2023-07-01-preview, 2023-08-01-preview.
  • Deployment Name: El nombre del despliegue (deployment) del modelo que quieres usar.
  • Azure Endpoint: La URL de tu recurso de Azure OpenAI, por ejemplo https://example-resource.azure.openai.com/.
  • Dimensions: (Opcional) El número de dimensiones que quieres que tengan los embeddings resultantes. Solo algunos modelos lo soportan.
  • Mapping Mode: Interruptor que habilita el modo de mapeo para procesar múltiples registros en lote.

Salidas

  • Embeddings: Un vector de números que representa el texto de entrada. Este valor se puede pasar a componentes posteriores como búsqueda semántica, clustering o clasificación.

Ejemplo de Uso

  1. Configura la credencial: En la sección de credenciales de Nappai, crea una credencial de tipo Azure OpenAI API y guarda tu Azure OpenAI Api Key.
  2. Añade el componente: Arrastra el componente Azure OpenAI Embeddings al flujo.
  3. Selecciona la credencial: En el campo Credential, elige la credencial que acabas de crear.
  4. Completa los campos:
    • Azure Endpoint: https://mi-recurso.azure.openai.com/
    • Deployment Name: text-embedding-ada-002
    • API Version: 2023-08-01-preview
    • Dimensions: (opcional) 1536
  5. Conecta la salida: Conecta la salida Embeddings a un componente de búsqueda semántica o a un modelo de clasificación.
  6. Ejecuta el flujo: Nappai enviará los textos a Azure OpenAI y devolverá los embeddings que podrás usar en tu aplicación.

Componentes Relacionados

  • Azure OpenAI Text Generation – Genera texto a partir de un prompt.
  • Azure OpenAI Chat – Interactúa con modelos de chat de Azure OpenAI.
  • Similarity Search – Busca documentos similares usando embeddings.
  • Clustering – Agrupa documentos basados en embeddings.

Consejos y Mejores Prácticas

  • Usa la versión de API más reciente: Asegúrate de seleccionar la última versión disponible para aprovechar mejoras y correcciones.
  • Comprueba la compatibilidad de dimensiones: No todos los modelos soportan la opción de especificar dimensiones; verifica la documentación del modelo antes de usarla.
  • Activa Mapping Mode para grandes volúmenes: Si necesitas procesar cientos o miles de textos, activa el modo de mapeo y conecta la entrada a un flujo de datos en lote.
  • Revisa los límites de uso: Azure OpenAI impone límites de tokens y llamadas por minuto; monitorea tu consumo para evitar interrupciones.
  • Mantén la credencial segura: No compartas la clave API en el flujo; utiliza la gestión de credenciales de Nappai para mantenerla oculta.

Consideraciones de Seguridad

  • Clave API: La clave de Azure OpenAI se almacena en la credencial y no aparece en el flujo. Asegúrate de que solo usuarios autorizados tengan acceso a la sección de credenciales.
  • Endpoint seguro: Usa siempre la URL HTTPS proporcionada por Azure.
  • Control de acceso: Limita quién puede editar el flujo para evitar cambios no autorizados en la configuración del endpoint o la credencial.