Transloadit

Dokumente in einer Datei zusammenführen

🤖/document/merge führt mehrere PDF-Dokumente zu einer einzigen Datei zusammen.

/document/merge Robot

Anwendungsbeispiel

Alle hochgeladenen PDF-Dokumente in einer Datei zusammenführen:

{
  "steps": {
    "merged": {
      "robot": "/document/merge",
      "use": {
        "steps": [
          ":original"
        ],
        "bundle_steps": true
      }
    }
  }
}

Parameter

  • interpolate

    boolean | Record<string, boolean>

    Steuert, ob einzelne Robot-Anweisungsfelder Assembly Variables interpolieren.

    Standardmäßig interpolieren die meisten Robot-Anweisungsfelder Assembly Variables. Mit dem Wert false behandeln Sie alle Anweisungsfelder als Literaltext. Wenn Sie stattdessen einen einzelnen Feldpfad auf false setzen, wird nur dieses Feld als Literaltext behandelt. Bei Feldern eines bestimmten Robots, die standardmäßig als Literaltext behandelt werden, aktivieren Sie die Interpolation wieder, indem Sie hierfür true festlegen oder für den jeweiligen Feldpfad den Wert true verwenden.

    Verwenden Sie Feldnamen wie path oder für verschachtelte Objekte Punktpfade wie ffmpeg.vf als Pfadangabe.

  • output_meta

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

    Damit können Sie eine Reihe von Metadaten festlegen, deren Berechnung mehr CPU-Ressourcen beansprucht. Sie sind daher standardmäßig deaktiviert, damit Ihre Assemblies schnell verarbeitet werden.

    Für Bilder können Sie diesem Objekt den Eintrag "has_transparency": true hinzufügen, um zu ermitteln, ob das Bild transparente Bereiche enthält. Mit dem Eintrag "dominant_colors": true können Sie außerdem ein Array mit hexadezimalen Farbcodes aus dem Bild extrahieren.

    Für Bilder können Sie auch den Eintrag "blurhash": true hinzufügen, um einen BlurHash zu extrahieren – eine kompakte Darstellung eines Platzhalters für das Bild, mit der Sie eine unscharfe Vorschau anzeigen können, während das vollständige Bild geladen wird.

    Für Videos können Sie den Parameter "colorspace": true hinzufügen, um den Farbraum des Ausgabevideos zu extrahieren.

    Für Videos können Sie außerdem den Eintrag "interlaced": true hinzufügen, um zu erkennen, ob das Video im Zeilensprungverfahren vorliegt. Dazu wird die ressourcenschonende ffprobe-Option field_order mit einem begrenzten Stichprobendurchlauf mithilfe von idet über die ersten Frames der Quelle kombiniert. Die Ergebnisse interlaced und field_order sowie das Diagnoseobjekt interlace_detection werden dabei unter file.meta ausgegeben. Dies ist rechenintensiv und wird entsprechend abgerechnet.

    Für Audio können Sie den Eintrag "mean_volume": true hinzufügen, um einen einzelnen Wert für die durchschnittliche Lautstärke der Audiodatei zu erhalten.

    Sie können diesen Parameter auch auf false setzen, um die Metadatenextraktion zu überspringen und das Transcoding zu beschleunigen.

  • user_meta

    Record<string, any>(Standard: {})

    Fügt jeder von diesem Robot ausgegebenen Datei benutzerdefinierte Metadaten hinzu, ohne den Dateiinhalt zu verändern.

    Die Werte werden mit allen bereits in der Eingabedatei enthaltenen user_meta zusammengeführt. Wenn beide Objekte denselben Schlüssel enthalten, hat der Wert dieses Robots Vorrang. Assembly Variables werden unterstützt, zum Beispiel { "internal_file_id": "${file.id}" }.

  • result

    boolean(Standard: false)

    Ob die Ergebnisse dieses Steps im Assembly Status JSON enthalten sein sollen

  • queue

    batch

    Wenn Sie die Queue auf „batch“ setzen, wird die Priorität der Jobs für diesen Step manuell herabgestuft. So vermeiden Sie, Priority Job Slots für Jobs zu belegen, die keine Wartezeit von null in der Queue benötigen.

  • force_accept

    boolean(Standard: false)

    Erzwingt, dass ein Robot einen Dateityp akzeptiert, den er sonst ignorieren würde.

    Standardmäßig ignorieren Robots Dateien, deren Typ sie nicht kennen. 🤖/video/encode ignoriert beispielsweise problemlos Eingabebilder.

    Wenn Sie den Parameter force_accept auf true setzen, können Sie erzwingen, dass Robots alle übergebenen Dateien akzeptieren. Dies führt in der Regel zu Fehlern und sollte nur zur Fehlersuche oder zur Behandlung von Grenzfällen verwendet werden.

  • ignore_errors

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

    Fehler in bestimmten Verarbeitungsphasen ignorieren.

    Wenn Sie hierfür ["meta"] festlegen, ignoriert der Robot Fehler bei der Metadatenextraktion.

    Wenn Sie hierfür ["execute"] festlegen, ignoriert der Robot Fehler während der Hauptausführungsphase.

    Wenn Sie hierfür true festlegen, entspricht dies ["meta", "execute"] und Fehler in beiden Phasen werden ignoriert.

  • use

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

    Gibt an, welche Steps als Eingabe verwendet werden sollen.

    • Sie können beliebige Namen für Steps wählen, außer ":original" (reserviert für von Transloadit verarbeitete Benutzer-Uploads)
    • Sie können mehrere Steps mithilfe von Arrays als Eingabe angeben: 
      {
  "use": [
    ":original",
    "encoded",
    "resized"
  ]
}
    • Sie können Eingabe-Steps außerdem mit as kennzeichnen, um Robots die semantische Funktion zu übermitteln: 
      {
  "use": [
    {
      "name": ":original",
      "as": "image"
    },
    {
      "name": ":original",
      "as": "mask"
    }
  ]
}

  • input_passwords

    Array<string>(Standard: [])

    Ein Array mit Passwörtern für die Eingabedokumente, falls diese verschlüsselt sind. Die Reihenfolge der Passwörter muss der Reihenfolge entsprechen, in der die Dokumente an den Step /document/merge übergeben werden.

    Dies lässt sich über unsere as-Syntax erreichen, indem Sie gegebenenfalls „document_1“, „document_2“ usw. verwenden. Sehen Sie sich die folgenden Demos an.

    Wenn die as-Syntax im Parameter „use“ nicht verwendet wird, werden die Dokumente anhand ihrer Dateinamen alphanumerisch sortiert. Die Eingabepasswörter müssen in derselben Reihenfolge angegeben werden.

  • output_password

    string

    Wenn dieser Wert nicht leer ist, wird die Ausgabedatei verschlüsselt und ist nur nach Eingabe dieses Passworts zugänglich.

  • sort_by

    auto | basename | import_order(Standard: "basename")

    Steuert die Reihenfolge gebündelter Eingaben, wenn für den Eingabetyp kein explizit angegebener nummerierter Alias verwendet wird. Nummerierte Aliasse enden mit einem numerischen Suffix wie _1.

    Der Standardwert "basename" behält das natürliche Legacy-Sortierverhalten nach Basisdateinamen bei.

    Legen Sie hierfür "import_order" fest, um die Reihenfolge arraybasierter Import-Steps beizubehalten, wenn alle Eingabedateien vollständige Metadaten zur Importreihenfolge enthalten. "auto" bevorzugt ebenfalls die Importreihenfolge und verwendet als Fallback die natürliche Sortierung nach Basisdateinamen.

Demos

Verwandte Blogbeiträge