Saltearse al contenido

JSON Document Builder

El JSON Document Builder convierte el contenido de una página de documento en un objeto JSON.
Solo necesitas indicar la clave que quieres usar y pasarle el documento (o una lista de documentos).
El resultado es un nuevo documento cuyo contenido es una cadena JSON con la clave y el texto original.

¿Cómo funciona?

El componente recibe el contenido de uno o varios documentos y lo envuelve dentro de un objeto JSON.
Internamente:

  1. Lee el texto de cada documento que se le pasa.
  2. Crea un diccionario con la clave proporcionada y el texto como valor.
  3. Serializa ese diccionario a JSON usando orjson_dumps.
  4. Devuelve un nuevo documento (o una lista de documentos) cuyo page_content es la cadena JSON resultante.

No se llama a ninguna API externa; todo el procesamiento ocurre localmente dentro del flujo de trabajo.

Entradas

Document

El documento o la lista de documentos que quieres convertir en JSON.

  • Se conecta a la salida de otro componente que genere documentos (por ejemplo, un cargador de archivos o un extractor de texto).

Key

La clave que aparecerá en el objeto JSON.

  • Puedes escribirla directamente o usarla como variable de flujo.

Salidas

Documents

Un documento (o lista de documentos) cuyo contenido es una cadena JSON.

  • Se puede usar como entrada para componentes que requieran datos estructurados, como un cargador de bases de datos, un API de envío, o un visualizador de JSON.

Ejemplo de Uso

Supongamos que tienes un documento que contiene la descripción de un producto y quieres enviarlo a un servicio que espera un JSON con la clave product_description.

  1. Carga el documento con un componente Document Loader.
  2. Conecta la salida Document a la entrada Document del JSON Document Builder.
  3. Escribe product_description en la entrada Key.
  4. Toma la salida Documents y pásala a un componente API Caller que envíe el JSON a tu servicio.

El flujo quedaría así:

Document Loader → JSON Document Builder → API Caller

Componentes Relacionados

  • Document Loader – Para leer archivos y generar documentos.
  • API Caller – Para enviar el JSON resultante a un endpoint externo.
  • JSON Parser – Para convertir el JSON de vuelta a texto o extraer campos específicos.

Consejos y Mejores Prácticas

  • Usa claves descriptivas: Elige nombres de clave que reflejen el contenido (ej. customer_info, order_details).
  • Valida el contenido: Si el documento puede contener caracteres especiales, verifica que el JSON sea válido antes de usarlo.
  • Maneja listas: Si pasas varios documentos, el componente devolverá una lista de documentos JSON; asegúrate de que el siguiente componente pueda procesar listas.
  • Revisa el tamaño: Los documentos muy grandes pueden generar JSON muy extensos; considera dividirlos si el servicio receptor tiene límites de tamaño.

Consideraciones de Seguridad

  • Datos sensibles: Si el documento contiene información confidencial, asegúrate de que el flujo de trabajo esté protegido y que el JSON no se exponga a usuarios no autorizados.
  • Control de acceso: Limita quién puede conectar la salida Documents a componentes que envíen datos a sistemas externos.
  • Validación de entrada: Evita inyecciones de JSON malicioso verificando que la clave y el contenido no contengan caracteres que puedan romper la estructura JSON.