Document Scanner

document-scanner

Use Document Scanner through the Zavilo SDK. Check input limits, parameters, output and supported modes below.

H · HeadlessI · InteractiveE · Embedded

Tool-IDdocument-scanner

Version1

AusführungCLIENT

ModiHeadless, Interactive, Embedded

Schnellzugriff

Eingabedateien 1Ausgabedateien 1

Ergebnisverarbeitung → Rezepte → Integrationsbeispiele → Playground →

Eingabe

Zulässige Eingabeformate und Dateianzahl für dieses Tool.

Eingabetyp	file
Dateianzahl	1 – 1
Zulässige MIME-Typen	image/jpeg, image/png, image/webp

Parameter

Diese Werte über request.options übergeben.

Parameter	Typ	Erforderlich	Standard	Zulässig / Bereich	Beschreibung
`mode`	enum	Optional	`enhanced-color`	enhanced-color \| original-color \| grayscale \| black-white	Document scan style.
`deskew`	boolean	Optional	`true`	—	Automatically correct small residual document tilt.
`format`	enum	Optional	`jpg`	jpg \| png	Output image format.

Ausgabe

Nach erfolgreicher Verarbeitung zurückgegebenes Ergebnisformat.

Typ	files
Dateianzahl	1 – 1
Ausgabe-MIME	image/jpeg, image/png
Metadata	width, height, inputBytes, outputBytes, deskewAngle
ZIP-Archiv	Nicht unterstützt

Grundlegende Verwendung

Unterstützten Integrationsmodus wählen und den erzeugten Starter-Code kopieren.

Headless

const result = await client.run("document-scanner", {
  file,
  options: { mode: "enhanced-color", deskew: true, format: "jpg" }
});
console.log(result.files, result.data, result.metadata);

Interactive

await client.open({
  tool: "document-scanner",
  input: { file },
  options: { mode: "enhanced-color", deskew: true, format: "jpg" },
  onComplete(result) { console.log(result.files, result.data, result.metadata); }
});

Embedded

await client.mount({ tool: "document-scanner", target: "#zavilo-tool", mode: "embedded" });

This page is generated from the SDK Tool Definition used by the runtime.