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

バージョン1

実行方式CLIENT

対応モードHeadless, Interactive, Embedded

クイック操作

入力ファイル 1出力ファイル 1

結果処理ガイド → レシピ → 統合サンプル → Playground →

入力

この Tool が受け付ける入力形式とファイル数です。

入力種類	file
ファイル数	1 – 1
対応 MIME	image/jpeg, image/png, image/webp

パラメータ

これらの値は request.options で渡します。

パラメータ	型	必須	既定値	許可値 / 範囲	説明
`mode`	enum	任意	`enhanced-color`	enhanced-color \| original-color \| grayscale \| black-white	Document scan style.
`deskew`	boolean	任意	`true`	—	Automatically correct small residual document tilt.
`format`	enum	任意	`jpg`	jpg \| png	Output image format.

出力

処理完了後に返される結果形式です。

型	files
ファイル数	1 – 1
出力 MIME	image/jpeg, image/png
Metadata	width, height, inputBytes, outputBytes, deskewAngle
ZIP アーカイブ	非対応

基本例

対応する統合モードを確認し、生成された開始コードをコピーできます。

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.