이미지 도구
문서 스캐너
document-scanner
Document Scanner 기능을 Zavilo SDK에서 사용하는 방법입니다. 아래에서 입력 제한, 파라미터, 출력 형식과 지원 모드를 확인할 수 있습니다.
H · HeadlessI · Interactive
빠른 이동
입력 파일 1출력 파일 1
입력
이 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 | 출력 파일 형식을 설정합니다. |
출력
처리가 완료되면 반환되는 결과 형식입니다.
| 출력 종류 | 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" });
이 명세는 실제 SDK 런타임이 사용하는 Tool Definition을 기준으로 자동 생성됩니다.