Convertir documentos a distintos formatos

🤖/document/convert convierte documentos a diferentes formatos.

Ejemplo de uso

{
  "steps": {
    "converted": {
      "format": "pdf",
      "robot": "/document/convert",
      "use": ":original"
    }
  }
}

Parámetros

• interpolate

  boolean | Record<string, boolean>

  Controla si las Assembly Variables se interpolan en campos de instrucciones individuales.

  De forma predeterminada, la mayoría de los campos de instrucciones de los Robots interpolan Assembly Variables. Establece esta opción en false para tratar todos los campos de instrucciones como texto literal, o establece la ruta de un campo individual en false para tratar únicamente ese campo como texto literal. En el caso de los campos específicos de un Robot que son literales de forma predeterminada, establece esta opción en true o la ruta de ese campo en true para volver a habilitar la interpolación.

  Usa nombres de campos como path o rutas con puntos como ffmpeg.vf para los objetos anidados.

• output_meta

  Record<string, boolean> | boolean | Array<string>

  Te permite especificar un conjunto de metadatos cuyo cálculo requiere más recursos de CPU y que, por lo tanto, está desactivado de forma predeterminada para mantener el procesamiento de tus Assemblies rápido.

  Para imágenes, puedes añadir "has_transparency": true en este objeto para extraer si la imagen contiene partes transparentes y "dominant_colors": true para extraer un array de códigos de color hexadecimales de la imagen.

  Para imágenes, también puedes añadir "blurhash": true para extraer una cadena BlurHash⁠, una representación compacta de un marcador de posición para la imagen que resulta útil para mostrar una vista previa desenfocada mientras se carga la imagen completa.

  Para imágenes, "thumbhash": true extrae en su lugar un ThumbHash⁠ codificado en base64 en meta.thumbhash, junto con meta.has_alpha (si existe un canal alfa, incluso cuando es totalmente opaco). Describe píxeles orientados según EXIF y usa el primer fotograma en el caso de imágenes animadas. La extracción se realiza según el mejor esfuerzo posible: las imágenes de más de 40 megapíxeles, los formatos no compatibles o una decodificación fallida o limitada no generan ningún marcador de posición. Una extracción exitosa añade un cargo de metadatos equivalente al 20 % de los bytes de ese archivo. No se aplica ningún recargo por ThumbHash cuando está desactivado o cuando no se genera ningún hash.

  Configura esta opción en el Step que genera la imagen, como /upload/handle para los originales subidos o /image/resize para las salidas procesadas. Configurarla únicamente en /transloadit/store no solicita la extracción: el almacenamiento conserva los metadatos del origen. Transloadit Storage conserva un hash generado junto con su versión inmutable y lo devuelve en los resultados almacenados y en las lecturas nativas de activos. Las subidas directas a S3 no generan marcadores de posición. Un marcador de posición contiene información de la imagen, por lo que debes protegerlo con los mismos controles de acceso que la imagen completa.

  Para videos, puedes añadir el parámetro "colorspace": true para extraer el espacio de color del video de salida.

  Para videos, también puedes añadir "interlaced": true para detectar si el video está entrelazado. Esto combina el indicador field_order de ffprobe, cuyo costo computacional es bajo, con una pasada de muestreo limitada mediante idet sobre los primeros fotogramas de la fuente, y expone interlaced, field_order y un objeto de diagnóstico interlace_detection en file.meta. Esto requiere muchos recursos computacionales y se factura en consecuencia.

  Para audio, puedes añadir "mean_volume": true para obtener un único valor que represente el volumen promedio del archivo de audio.

  También puedes establecer esto en false para omitir la extracción de metadatos y acelerar la transcodificación.

• user_meta

  Record<string, any>(valor predeterminado: {})

  Añade metadatos JSON personalizados a cada archivo emitido sin modificar su contenido. Se admiten objetos y arrays anidados.

  La herencia depende del Robot. Los valores se combinan con los user_meta existentes en el archivo de salida; el Step actual reemplaza las claves coincidentes de nivel superior. Asigna explícitamente las claves necesarias cuando un Robot cree nuevos archivos de salida.

  En los Steps de procesamiento, ${file.*} hace referencia a la primera entrada y ${result.*} al archivo emitido. Los valores se evalúan para cada salida después de ejecutarse el Robot, antes de la posterior extracción de metadatos y del almacenamiento temporal. En :original, los valores se evalúan para cada subida antes de la extracción de metadatos.

  Los Steps posteriores leen ${file.user_meta.key}. Consulta Metadatos personalizados para ver un ejemplo completo y las reglas de herencia.

• result

  boolean(valor predeterminado: false)

  Indica si los resultados de este Step deben aparecer en el Assembly Status JSON

• queue

  batch

  Establecer la cola en «batch» reduce manualmente la prioridad de los Jobs de este Step para evitar consumir cupos prioritarios con Jobs que no necesitan un tiempo de espera cero en la cola

• force_accept

  boolean(valor predeterminado: false)

  Forzar a un Robot a aceptar un tipo de archivo que habría ignorado.

  De forma predeterminada, los Robots ignoran los archivos que no reconocen. 🤖/video/encode, por ejemplo, ignorará sin problemas las imágenes de entrada.

  Si configuras el parámetro force_accept como true, puedes forzar a los Robots a aceptar todos los archivos que reciban. Esto normalmente provocará errores y solo debe usarse para depuración o para abordar casos extremos.

• ignore_errors

  boolean | Array<meta | execute>(valor predeterminado: [])

  Ignorar errores durante fases específicas del procesamiento.

  Establecer este parámetro en ["meta"] hará que el Robot ignore los errores durante la extracción de metadatos.

  Establecer este parámetro en ["execute"] hará que el Robot ignore los errores durante la fase principal de ejecución.

  Configurar este parámetro como true equivale a ["meta", "execute"] y hará que se ignoren los errores en ambas fases.

• use

  string | Array<string> | Array<object> | object

  Especifica qué Step o Steps se usarán como entrada.

  • Puedes elegir cualquier nombre para los Steps, excepto ":original" (reservado para las subidas de usuarios gestionadas por Transloadit)
  • Puedes proporcionar varios Steps como entrada mediante arrays:

    {
      "use": [
        ":original",
        "encoded",
        "resized"
      ]
    }
    

  • También puedes etiquetar los Steps de entrada con as para comunicar la intención semántica a los Robots:

    {
      "use": [
        {
          "name": ":original",
          "as": "image"
        },
        {
          "name": ":original",
          "as": "mask"
        }
      ]
    }
    

  Consejo

  Probablemente eso sea todo lo que necesitas saber sobre use, pero puedes consultar los casos de uso avanzados.

• format — obligatorio

  ai | csv | doc | docx | eps | gif | html | 28 más ↓

  El formato deseado para la conversión del documento.

• markdown_format

  commonmark | gfm(valor predeterminado: "gfm")

  Markdown puede representarse mediante diversas variantes⁠, así que, cuando uses este Robot para transformar Markdown en HTML, especifica qué revisión se utiliza.

• markdown_theme

  bare | github(valor predeterminado: "github")

  Este parámetro modifica por completo el estilo de tus archivos Markdown según varios ajustes preestablecidos incluidos.

• pdf_margin

  string(valor predeterminado: "6.25mm,6.25mm,14.11mm,6.25mm")

  Márgenes del papel del PDF, separados por , y expresados con unidades.

  Se admiten los siguientes valores de unidad: px, in, cm, mm.

  Actualmente, este parámetro solo es compatible con conversiones desde html.

• pdf_print_background

  boolean(valor predeterminado: true)

  Imprime los gráficos de fondo del PDF.

  Actualmente, este parámetro solo es compatible con conversiones desde html.

• pdf_format

  A0 | A1 | A2 | A3 | A4 | A5 | A6 | 4 más ↓(valor predeterminado: "Letter")

  Formato del papel del PDF.

  Actualmente, este parámetro solo es compatible con conversiones desde html.

• pdf_display_header_footer

  boolean(valor predeterminado: false)

  Muestra el encabezado y el pie de página del PDF.

  Actualmente, este parámetro solo es compatible con conversiones desde html.

• pdf_header_template

  string

  Plantilla HTML para el encabezado de impresión del PDF.

  Debe ser código HTML válido y usar las siguientes clases para insertar en ellas los valores de impresión:

  • date fecha de impresión con formato
  • title título del documento
  • url ubicación del documento
  • pageNumber número de la página actual
  • totalPages total de páginas del documento

  Actualmente, este parámetro solo es compatible al convertir desde html y requiere que pdf_display_header_footer esté habilitado.

  Para cambiar el formato del elemento HTML, debes especificar font-size en un contenedor. Por ejemplo, para centrar el número de página en la parte superior, usarías el siguiente HTML para la plantilla del encabezado:

  <div style="font-size: 15px; width: 100%; text-align: center;"><span class="pageNumber"></span></div>
  

• pdf_footer_template

  string

  Plantilla HTML para el pie de página de impresión del PDF.

  Debe usar el mismo formato que pdf_header_template.

  Actualmente, este parámetro solo es compatible al convertir desde html y requiere que pdf_display_header_footer esté habilitado.

  Para cambiar el formato del elemento HTML, debes especificar font-size en un contenedor. Por ejemplo, para centrar el número de página en el pie de página, usarías el siguiente HTML para la plantilla del pie de página:

  <div style="font-size: 15px; width: 100%; text-align: center;"><span class="pageNumber"></span></div>
  

Demos

Publicaciones relacionadas del blog