Text und eingebettete Bilder extrahieren

🤖/document/extract extrahiert Text und eingebettete Bilder aus PDF-Dokumenten.

Anwendungsbeispiel

{
  "steps": {
    "extracted": {
      "robot": "/document/extract",
      "use": ":original",
      "extract": [
        "text",
        "images"
      ],
      "text_method": "native"
    }
  }
}

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"
        }
      ]
    }
    

  Tipp

  Das ist wahrscheinlich alles, was Sie über use wissen müssen. Sie können sich jedoch auch die erweiterten Anwendungsfälle ansehen.

• extract

  text | images | Array<text | images>(Standard: ["text","images"])

  Legt fest, welche Assets extrahiert werden. Verwenden Sie ["text"], ["images"] oder ["text", "images"].

• page_range

  string

  Optionale, kommagetrennte Seitenauswahl, etwa "1", "1-3" oder "1,3-5". Die Seitennummerierung beginnt bei 1. Bereiche werden auf die erkannte Seitenzahl begrenzt.

  Pro Job sind höchstens 1.000 ausgewählte Seiten zulässig.

  Dies wird für die native Textextraktion und die Extraktion eingebetteter Bilder unterstützt. Die OCR-Extraktion arbeitet derzeit auf dem vollständigen Dokument.

• password

  string

  Passwort, mit dem verschlüsselte PDFs für die native Textextraktion und die Extraktion eingebetteter Bilder entsperrt werden. Die OCR-Extraktion unterstützt derzeit keine verschlüsselten PDFs; kombinieren Sie dies daher nicht mit text_method: "ocr" oder text_method: "auto".

• text_method

  native | ocr | auto(Standard: "native")

  Steuert, wie Text extrahiert wird.

  • "native" extrahiert auswählbaren PDF-Text lokal mit Poppler. Das ist schnell, liefert bei gescannten PDFs aber wenig oder gar keinen Text.
  • "ocr" delegiert an /document/ocr und erfordert ocr_provider.
  • "auto" versucht zuerst die native Extraktion und weicht auf OCR aus, wenn kein nativer Text gefunden wird. Dies erfordert ebenfalls ocr_provider.

  OCR-Modi können derzeit nicht mit password kombiniert werden.

• ocr_provider

  aws | gcp

  Zu verwendender OCR-Anbieter, wenn text_method "ocr" oder "auto" ist. Gültige Werte sind "aws" und "gcp".

• text_format

  txt | json(Standard: "txt")

  Ausgabeformat für den extrahierten Text. Verwenden Sie "txt" für reinen Text oder "json" für strukturierte Ausgabe.

• text_granularity

  document | page(Standard: "document")

  Steuert die Gruppierung der Textausgabe bei der nativen Extraktion.

  • "document" erzeugt ein Textergebnis für die ausgewählten Seiten.
  • "page" erzeugt ein Textergebnis pro ausgewählter Seite.

  Seitengranularität wird derzeit nur mit text_method: "native" unterstützt.

• image_format

  auto | original | png | jpg(Standard: "auto")

  Ausgabeformat für extrahierte eingebettete Rasterbilder.

  • "auto" und "original" behalten das eingebettete Bildformat nach Möglichkeit bei.
  • "png" weist Poppler an, Bilder als PNG zu decodieren.
  • "jpg" konvertiert extrahierte Bilder, die nicht im JPEG-Format vorliegen, mit /image/resize.

• min_image_width

  string | number(Standard: 0)

  Mindestbreite in Pixeln für extrahierte Bilder. Kleinere Bilder werden ignoriert. Setzen Sie diesen Wert auf 0, um diesen Filter zu deaktivieren.

• min_image_height

  string | number(Standard: 0)

  Mindesthöhe in Pixeln für extrahierte Bilder. Kleinere Bilder werden ignoriert. Setzen Sie diesen Wert auf 0, um diesen Filter zu deaktivieren.

• min_image_bytes

  string | number(Standard: 0)

  Mindestdateigröße in Bytes für extrahierte Bilder. Kleinere Bilder werden ignoriert.

• dedupe_images

  boolean(Standard: true)

  Wenn aktiviert, werden identische extrahierte Bilddateien nur einmal ausgegeben.

• include_image_masks

  boolean(Standard: false)

  Wenn aktiviert, behält der Robot auch Bildmaskendateien, sofern Poppler sie als separate Dateien bereitstellt.