Transloadit

Dateien aus Tigris importieren

🤖/tigris/import importiert ganze Verzeichnisse mit Dateien aus Ihrem Tigris-Bucket.

/tigris/import Robot

Anwendungsbeispiel

Dateien aus dem Verzeichnis path/to/files und seinen Unterverzeichnissen importieren:

{
  "steps": {
    "imported": {
      "credentials": "YOUR_TIGRIS_CREDENTIALS",
      "path": "path/to/files/",
      "recursive": true,
      "robot": "/tigris/import"
    }
  }
}

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 als String 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 Bilder extrahiert der Eintrag "thumbhash": true stattdessen einen base64-codierten ThumbHash nach meta.thumbhash, zusammen mit meta.has_alpha (gibt an, ob ein Alphakanal vorhanden ist, auch wenn das Bild vollständig deckend ist). Der Hash beschreibt die Pixel gemäß EXIF-Ausrichtung und verwendet bei animierten Bildern das erste Frame. Die Extraktion erfolgt nach dem Best-Effort-Prinzip: Bilder über 40 Megapixeln, nicht unterstützte Formate oder ein fehlgeschlagener bzw. durch Grenzwerte beschränkter Decodiervorgang erzeugen keinen Platzhalter. Eine erfolgreiche Extraktion verursacht eine zusätzliche Metadatengebühr in Höhe von 20 % der Bytes dieser Datei. Ist die Option deaktiviert oder wird kein Hash erzeugt, fällt kein ThumbHash-Aufschlag an.

    Setzen Sie diese Option für den Step, der das Bild erzeugt, etwa /upload/handle für hochgeladene Originale oder /image/resize für verarbeitete Ausgaben. Wird sie nur für /transloadit/store gesetzt, wird keine Extraktion angefordert: Die Speicherung behält die Metadaten des erzeugenden Steps bei. Transloadit Storage speichert einen erzeugten Hash dauerhaft zusammen mit seiner unveränderlichen Version und gibt ihn in gespeicherten Ergebnissen sowie beim nativen Lesen von Assets zurück. Direkte S3-Uploads erzeugen keine Platzhalter. Ein Platzhalter enthält Bildinformationen; schützen Sie ihn daher mit denselben Zugriffskontrollen wie das vollständige Bild.

    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 Transkodieren zu beschleunigen.

  • user_meta

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

    Fügt jeder ausgegebenen Datei benutzerdefinierte JSON-Metadaten hinzu, ohne den Dateiinhalt zu verändern. Verschachtelte Objekte und Arrays werden unterstützt.

    Die Vererbung hängt vom Robot ab. Die Werte werden mit vorhandenen user_meta der Ausgabedatei zusammengeführt; der aktuelle Step ersetzt übereinstimmende Schlüssel auf oberster Ebene. Weisen Sie erforderliche Schlüssel explizit zu, wenn ein Robot neue Ausgabedateien erstellt.

    In Steps zur Verarbeitung bezieht sich ${file.*} auf die erste Eingabe und ${result.*} auf die ausgegebene Datei. Die Werte werden nach der Ausführung des Robots für jede Ausgabedatei ausgewertet, bevor die anschließende Metadatenextraktion und temporäre Speicherung erfolgen. Bei :original werden die Werte für jeden Upload vor der Metadatenextraktion ausgewertet.

    Nachfolgende Steps lesen ${file.user_meta.key}. Ein vollständiges Beispiel und die Vererbungsregeln finden Sie unter Benutzerdefinierte Metadaten.

  • 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 | import | 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 ["import"] festlegen, ignoriert der Robot Fehler beim Importieren der Quelldatei. Die Phase "import" ist nur für Import-Robots verfügbar.

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

  • force_name

    string | Array<string> | null(Standard: null)

    Benutzerdefinierter Name für die importierte Datei bzw. die importierten Dateien. Standardmäßig werden die Dateinamen von der Quelle abgeleitet.

  • import_on_errors

    Array<meta>(Standard: [])

    Wenn Sie dies auf ["meta"] setzen, wird die Datei auch bei Fehlern während der Metadatenextraktion importiert. Ähnlich verhält es sich mit dem Parameter ignore_errors: Der Fehler wird ebenfalls ignoriert und der Robot wird nicht angehalten, die Datei wird jedoch nicht importiert.

  • credentials

    string

    Bitte erstellen Sie die zugehörigen Template-Zugangsdaten in Ihrem Transloadit-Konto und verwenden Sie den Namen Ihrer Template-Zugangsdaten als Wert dieses Parameters. Sie enthalten die Werte für Ihren Tigris-Bucket, Key, Secret und die Bucket-Region.

    Wir empfehlen zwar, durchgehend Template-Zugangsdaten zu verwenden, doch manche Anwendungsfälle erfordern dynamische Zugangsdaten, für die Template-Zugangsdaten aufgrund ihrer statischen Natur zu unhandlich sind. Falls Sie diese Anforderung haben, können Sie stattdessen gerne die folgenden Parameter verwenden: "bucket", "host", "key", "secret".

  • bucket_region

    string

    Die Region Ihres Tigris-Buckets. Diese Angabe ist optional, da sie sich häufig ableiten lässt.

  • path — erforderlich

    string | Array<string>

    Der Pfad in Ihrem Bucket zur jeweiligen Datei oder zum jeweiligen Verzeichnis. Wenn der Pfad auf eine Datei verweist, wird nur diese Datei importiert. Beispiel: images/avatar.jpg.

    Wenn er auf ein Verzeichnis zeigt, erkennbar an einem abschließenden Schrägstrich (/), werden alle Dateien importiert, die direkte Nachfahren dieses Verzeichnisses sind. Zum Beispiel: images/.

    Verzeichnisse werden nicht rekursiv importiert. Wenn Sie Dateien aus Unterverzeichnissen und tiefer verschachtelten Unterverzeichnissen importieren möchten, aktivieren Sie den Parameter recursive.

    Wenn Sie alle Dateien aus dem Stammverzeichnis importieren möchten, verwenden Sie hier bitte / als Wert. Stellen Sie in diesem Fall sicher, dass alle Ihre Objekte zu einem Pfad gehören. Wenn sich im Stammverzeichnis Ihres Buckets Objekte befinden, denen / nicht vorangestellt ist, erhalten Sie folgenden Fehler: A client error (NoSuchKey) occurred when calling the GetObject operation: The specified key does not exist.

    Sie können hier auch ein Array aus Pfad-Strings verwenden, um mehrere Pfade in einem Step zu importieren, der zu demselben Robot gehört.

  • recursive

    boolean(Standard: false)

    Wenn Sie dies auf true setzen, können Dateien aus Unterverzeichnissen und weiteren darunterliegenden Verzeichnissen (usw.) des angegebenen Pfads importiert werden.

    Verwenden Sie hierbei die Paginierungsparameter page_number und files_per_page mit Bedacht.

  • page_number

    string | number(Standard: 1)

    Die Seitennummer der Paginierung. Um die Abwärtskompatibilität bei nicht rekursiven Importen nicht zu beeinträchtigen, funktioniert dies derzeit nur, wenn für recursive der Wert true gesetzt ist.

    Stellen Sie bei umfangreichen Importen sicher, dass keine anderen Skripte Dateien innerhalb Ihres Speicherorts hinzufügen oder entfernen. Andernfalls kann die Paginierung unerwartete Ergebnisse liefern.

  • files_per_page

    string | number(Standard: 1000)

    Die Seitengröße der Paginierung. Dies funktioniert derzeit nur, wenn recursive den Wert true hat, um die Abwärtskompatibilität bei nicht rekursiven Importen nicht zu beeinträchtigen.

  • return_file_stubs

    boolean(Standard: false)

    Wenn Sie dies auf true setzen, importiert der Robot die eigentlichen Dateien noch nicht, sondern gibt stattdessen einen leeren Datei-Stub mit einer URL zurück, über die nachfolgende Robots die Datei importieren können. Dies ist nützlich, wenn nachfolgende Steps mehr Kontrolle über den Importvorgang benötigen, beispielsweise wenn 🤖/video/ondemand zum Einsatz kommt. Dieser Parameter sollte nur festgelegt werden, wenn alle nachfolgenden Steps Robots verwenden, die Datei-Stubs unterstützen.