SnapOtter/apps/docs/ja/api/ai.md

description, i18n_source_hash, i18n_provenance, i18n_output_hash

description	i18n_source_hash	i18n_provenance	i18n_output_hash
すべてのローカル ML ツールを網羅した AI エンジンリファレンス。背景除去、アップスケーリング、OCR、顔検出、写真復元など。	14728c1dcd05	machine	721e8f11de40

AI エンジンリファレンス

@snapotter/ai パッケージは、すべての ML 処理のために Node.js を永続的な Python サイドカーへ橋渡しします。ディスパッチャープロセスはリクエスト間で稼働し続けるため、高速なウォームスタート性能が得られます。NVIDIA CUDA は起動時に自動検出され、利用可能な場合に使用されます。それ以外の場合、AI ツールは CPU 上で動作します。

VA-API、Quick Sync、OpenCL を介した Intel/AMD の iGPU アクセラレーションは、現時点では AI 推論に対応していません。/dev/dri をコンテナにマッピングしても、CUDA 対応の NVIDIA GPU が利用できない限り、これらの Python サイドカーツールは高速化されません。

4 つのモダリティ（画像、音声、動画、ドキュメント）にわたる 19 個の Python サイドカー AI ツールに加え、AI 機能をオプションで備えた 2 個のツールがあります。すべてのモデルはローカルで動作します。初回のモデルダウンロード後はインターネットは不要です。

アーキテクチャ

Node.js Tool Route
      |
      v
 @snapotter/ai bridge.ts
      | (stdin/stdout JSON + stderr progress events)
      v
 Python dispatcher (persistent process, "ai" profile)
      |
      |-- remove_bg.py        (rembg / BiRefNet)
      |-- upscale.py          (RealESRGAN)
      |-- inpaint.py          (LaMa ONNX)
      |-- outpaint.py         (LaMa canvas expansion)
      |-- ocr.py              (PaddleOCR / Tesseract)
      |-- ocr_pdf.py          (page-by-page document OCR)
      |-- ocr_preprocess.py   (image enhancement for OCR)
      |-- detect_faces.py     (MediaPipe)
      |-- face_landmarks.py   (MediaPipe landmarks)
      |-- enhance_faces.py    (GFPGAN / CodeFormer)
      |-- colorize.py         (DDColor)
      |-- noise_removal.py    (SCUNet / tiered denoising)
      |-- red_eye_removal.py  (landmark + color analysis)
      |-- restore.py          (scratch repair + enhancement + denoising)
      |-- transcribe.py       (faster-whisper speech-to-text)
      +-- install_feature.py  (on-demand bundle installer)

別の「docs」ディスパッチャープロファイルは、AI 許可リストをドキュメント処理スクリプト（doc_pagecount、doc_health、doc_flatten、doc_redact、doc_text、doc_to_word、doc_metadata、doc_html_pdf）に置き換え、重い ML インポートをスキップします。

タイムアウト: デフォルトは 300 秒。OCR と BiRefNet 背景除去は 600 秒です。

フィーチャーバンドル

AI モデルは、ツールごとに 1 つのアーカイブとしてではなく、共有される依存関係スタックによってパッケージ化されています。フィーチャーバンドルは、同じモデルファミリー、Python ホイール、またはネイティブライブラリを使用するツールをまとめて有効化できます。これにより、リリース用の Docker イメージが小さく保たれ、同じ背景マッティング、顔検出、OCR、復元、音声モデルの重複コピーの保存を避けられます。

Docker イメージには、アプリケーションと共通ランタイムが同梱されています。大きなモデルアーカイブはオンデマンドで永続的な /data/ai ボリュームにダウンロードされ、それを必要とするすべてのツールで再利用されます。別のツールがすでに必要としたためにバンドルがインストール済みの場合、新たに依存するツールを有効化してもそのバンドルは再ダウンロードされません。

各 AI ツールは、実行前に 1 つ以上のフィーチャーバンドルを必要とします。管理 UI は POST /api/v1/admin/tools/:toolId/features/install を通じてツール単位でインストールを行い、必要なバンドルの全リストを解決し、すでにインストール済みのバンドルをスキップして、不足しているダウンロードのみをキューに入れます。たとえば、新規インスタンスでパスポート写真を有効化すると background-removal と face-detection がキューに入りますが、背景除去がすでにインストールされた後に有効化すると face-detection のみがキューに入ります。

バンドル	サイズ	共有依存関係グループ	使用するツール
background-removal	4-5 GB	rembg / BiRefNet 背景マッティング	remove-background, passport-photo, transparency-fixer, background-replace, blur-background
face-detection	200-300 MB	MediaPipe 顔検出とランドマーク	blur-faces, red-eye-removal, smart-crop
object-eraser-colorize	1-2 GB	LaMa インペインティング/アウトペインティングと DDColor	erase-object, colorize, ai-canvas-expand
upscale-enhance	5-6 GB	RealESRGAN、GFPGAN / CodeFormer、ノイズ除去	upscale, enhance-faces, noise-removal
photo-restoration	4-5 GB	傷の修復と復元パイプライン	restore-photo
ocr	5-6 GB	PaddleOCR / Tesseract OCR スタック	ocr, ocr-pdf
transcription	~600 MB	faster-whisper 音声認識モデル	transcribe-audio, auto-subtitles

複数バンドルにまたがる依存関係を持つツール:

ツール	必要なバンドル	理由
passport-photo	background-removal, face-detection	背景を除去した後、顔のランドマークを使って、パスポートや ID 写真の規則に合わせてクロップを構図します。
enhance-faces	upscale-enhance, face-detection	選択した顔の領域で GFPGAN または CodeFormer による補正を実行する前に、顔を検出します。

ツールは、必要なすべてのバンドルがインストールされている場合にのみ利用可能になります。部分的なインストールは有効であり、段階的に処理されます。インストール済みのバンドルは再利用され、不足しているバンドルはダウンロードとして表示され、キューに入れられたインストールは共有 Python 環境が同時に変更されないよう 1 つずつ実行されます。

---

背景除去

ツールルート: remove-background
モデル: BiRefNet（デフォルト）または U2-Net バリアントを用いた rembg

パラメータ	型	デフォルト	説明
model	string	-	モデルバリアント（任意の上書き）
backgroundType	string	"transparent"	次のいずれか: transparent, color, gradient, blur, image
backgroundColor	string	-	単色背景の 16 進カラー
gradientColor1	string	-	グラデーションの 1 色目
gradientColor2	string	-	グラデーションの 2 色目
gradientAngle	number	-	グラデーションの角度（度）
blurEnabled	boolean	-	背景ぼかし効果を有効化
blurIntensity	number (0-100)	-	ぼかしの強度
shadowEnabled	boolean	-	被写体にドロップシャドウを有効化
shadowOpacity	number (0-100)	-	シャドウの不透明度
outputFormat	string	-	出力形式: png, webp, または avif
edgeRefine	integer (0-3)	-	エッジ精細化レベル
decontaminate	boolean	-	エッジからの色にじみを除去

背景の置き換え

ツールルート: background-replace
モデル: rembg / BiRefNet（remove-background と共有）

背景を除去し、単色またはグラデーションに置き換えます。

パラメータ	型	デフォルト	説明
backgroundType	"color" | "gradient"	"color"	背景モード
color	string	"#ffffff"	背景の 16 進カラー（backgroundType が color の場合）
gradientColor1	string	-	グラデーションの 1 色目（16 進）
gradientColor2	string	-	グラデーションの 2 色目（16 進）
gradientAngle	integer (0-360)	180	グラデーションの角度（度）
feather	integer (0-20)	0	エッジのぼかし半径
format	"png" | "webp"	"png"	出力形式

背景をぼかす

ツールルート: blur-background
モデル: rembg / BiRefNet（remove-background と共有）

被写体をシャープに保ちながら背景をぼかします。

パラメータ	型	デフォルト	説明
intensity	integer (1-100)	50	ぼかしの強度
feather	integer (0-20)	0	エッジのぼかし半径
format	"png" | "webp"	"png"	出力形式

画像のアップスケーリング

ツールルート: upscale
モデル: RealESRGAN（利用できない場合は Lanczos にフォールバック）

パラメータ	型	デフォルト	説明
scale	number	2	アップスケール倍率
model	string	"auto"	モデルバリアント
faceEnhance	boolean	false	GFPGAN による顔補正パスを適用
denoise	number	0	ノイズ除去の強度
format	string	"auto"	出力形式の上書き
quality	number	95	出力品質（1-100）

OCR / テキスト抽出

ツールルート: ocr
モデル: Tesseract（高速）、PaddleOCR PP-OCRv5（バランス）、PaddleOCR-VL 1.5（最高精度）

パラメータ	型	デフォルト	説明
quality	"fast" | "balanced" | "best"	"balanced"	処理ティア
language	string	"auto"	言語: auto, en, de, fr, es, zh, ja, ko
enhance	boolean	true	OCR 精度を高めるために画像を前処理
engine	string	-	非推奨。tesseract を fast に、paddleocr を balanced にマッピングします

バウンディングボックス、信頼度スコア、抽出されたテキストブロックを含む構造化された結果を返します。

PDF OCR

ツールルート: ocr-pdf
モデル: 画像 OCR と同じティアシステム

AI ベースの OCR を使用して、スキャンされた PDF ドキュメントからページごとにテキストを抽出します。

パラメータ	型	デフォルト	説明
quality	"fast" | "balanced" | "best"	"balanced"	処理ティア
language	string	"auto"	言語: auto, en, de, fr, es, zh, ja, ko
pages	string	"all"	ページ選択: "all", "1-3", "1,3,5"

顔 / 個人情報のぼかし

ツールルート: blur-faces
モデル: MediaPipe 顔検出

パラメータ	型	デフォルト	説明
blurRadius	number (1-100)	30	ガウスぼかしの半径
sensitivity	number (0-1)	0.5	検出信頼度のしきい値

顔補正

ツールルート: enhance-faces
モデル: GFPGAN, CodeFormer

パラメータ	型	デフォルト	説明
model	"auto" | "gfpgan" | "codeformer"	"auto"	補正モデル
strength	number (0-1)	0.8	補正の強度
sensitivity	number (0-1)	0.5	顔検出のしきい値
onlyCenterFace	boolean	false	最も中央にある顔のみを補正

AI カラー化

ツールルート: colorize
モデル: DDColor（OpenCV DNN にフォールバック）

白黒またはグレースケールの写真をフルカラーに変換します。

パラメータ	型	デフォルト	説明
intensity	number (0-1)	1.0	色の彩度の強さ
model	"auto" | "ddcolor" | "opencv"	"auto"	モデルバリアント

ノイズ除去

ツールルート: noise-removal
モデル: SCUNet（ティア方式のノイズ除去パイプライン）

パラメータ	型	デフォルト	説明
tier	"quick" | "balanced" | "quality" | "maximum"	"balanced"	処理ティア
strength	number (0-100)	50	ノイズ除去の強度
detailPreservation	number (0-100)	50	保持するディテール量。高いほどテクスチャがより多く残ります
colorNoise	number (0-100)	30	カラーノイズ低減の強度
format	string	"original"	出力形式: original, png, jpeg, webp, avif, jxl
quality	number (1-100)	90	出力エンコード品質

赤目除去

ツールルート: red-eye-removal

顔のランドマークを検出し、目の領域を特定して、赤チャンネルの過飽和を補正します。

パラメータ	型	デフォルト	説明
sensitivity	number (0-100)	50	赤ピクセル検出のしきい値
strength	number (0-100)	70	補正の強度
format	string	-	出力形式の上書き（任意）
quality	number (1-100)	90	出力品質

写真復元

ツールルート: restore-photo

古い写真や損傷した写真のためのマルチステップパイプライン: 傷やちぎれの検出と修復、顔補正、ノイズ除去、任意のカラー化。

パラメータ	型	デフォルト	説明
scratchRemoval	boolean	true	傷やちぎれを検出して修復
faceEnhancement	boolean	true	顔補正パスを適用
fidelity	number (0-1)	0.7	顔補正の強度（高いほど控えめ）
denoise	boolean	true	ノイズ除去パスを適用
denoiseStrength	number (0-100)	25	ノイズ除去の強度
colorize	boolean	false	復元後にカラー化
colorizeStrength	number (0-100)	85	カラー化の強度

パスポート写真

ツールルート: passport-photo
モデル: MediaPipe 顔ランドマーク + BiRefNet 背景除去

2 フェーズのワークフロー: 分析（顔を検出 + 背景を除去）してから生成（クロップ、リサイズ、タイル配置）します。6 地域にわたる 37 か国以上に対応しています。

フェーズ 1: 分析

POST /api/v1/tools/image/passport-photo/analyze

画像ファイル（マルチパート）を受け付けます。顔のランドマークデータ、base64 のプレビュー、画像の寸法を返します。

フェーズ 2: 生成

POST /api/v1/tools/image/passport-photo/generate

フェーズ 1 の結果に加えて生成設定を含む JSON ボディを受け付けます:

パラメータ	型	デフォルト	説明
jobId	string	（必須）	フェーズ 1 のジョブ ID
filename	string	（必須）	フェーズ 1 の元のファイル名
countryCode	string	（必須）	ISO 国コード（例: US, GB, IN）
documentType	string	"passport"	ドキュメントの種類
bgColor	string	"#FFFFFF"	背景色の 16 進
printLayout	string	"none"	印刷レイアウト: none, 4x6, a4, letter
maxFileSizeKb	number	0	最大ファイルサイズ（KB、0 = 制限なし）
dpi	number (72-1200)	300	出力 DPI
customWidthMm	number	-	カスタム幅（mm、国別仕様を上書き）
customHeightMm	number	-	カスタム高さ（mm、国別仕様を上書き）
zoom	number (0.5-3)	1	ズーム倍率
adjustX	number	0	水平方向の位置調整
adjustY	number	0	垂直方向の位置調整
landmarks	object	（必須）	フェーズ 1 のランドマーク
imageWidth	number	（必須）	フェーズ 1 の画像幅
imageHeight	number	（必須）	フェーズ 1 の画像高さ

オブジェクト消去（インペインティング）

ツールルート: erase-object
モデル: ONNX Runtime を介した LaMa

マスクは base64 ではなく、2 つ目のファイルパート（フィールド名 mask）として送信されます。マスク内の白いピクセルが消去する領域を示します。format と quality の設定はトップレベルのフォームフィールドとして送信されます。

パラメータ	型	デフォルト	説明
file	file	（必須）	ソース画像（マルチパート）
mask	file	（必須）	マスク画像（マルチパート、フィールド名 mask、白 = 消去）
format	string	"auto"	出力形式: auto, png, jpg, jpeg, webp, tiff, gif, avif, heic, heif, jxl
quality	integer (1-100)	95	出力品質

NVIDIA GPU が利用可能な場合は CUDA で高速化されます。

AI キャンバス拡張

ツールルート: ai-canvas-expand
モデル: LaMa ベースのアウトペインティング

画像のキャンバスを任意の方向に拡張し、新しい領域を既存の画像に合わせた AI 生成コンテンツで埋めます。

パラメータ	型	デフォルト	説明
extendTop	integer	0	上方向に拡張するピクセル数
extendRight	integer	0	右方向に拡張するピクセル数
extendBottom	integer	0	下方向に拡張するピクセル数
extendLeft	integer	0	左方向に拡張するピクセル数
tier	"fast" | "balanced" | "high"	"balanced"	品質ティア
format	string	"auto"	出力形式: auto, png, jpg, jpeg, webp, tiff, gif, avif, heic, heif, jxl
quality	integer (1-100)	95	出力品質

少なくとも 1 つの拡張方向が 0 より大きくなければなりません。

スマートクロップ

ツールルート: smart-crop
モデル: MediaPipe 顔検出（face モードのみ）

パラメータ	型	デフォルト	説明
mode	string	"subject"	クロップ戦略: subject, face, trim
strategy	"attention" | "entropy"	"attention"	subject モードの戦略
width	integer	-	出力幅
height	integer	-	出力高さ
padding	integer (0-50)	0	被写体周りのパディング割合
facePreset	string	"head-shoulders"	mode=face の場合のプリセット構図
sensitivity	number (0-1)	0.5	顔検出のしきい値
threshold	integer (0-255)	30	背景検出のしきい値（trim モード）
padToSquare	boolean	false	トリミング結果を正方形にパディング
padColor	string	"#ffffff"	正方形パディングの背景色
targetSize	integer	-	パディング後の出力の目標サイズ（ピクセル）
quality	integer (1-100)	-	出力品質

レガシーの mode 値 attention と content は受け付けられ、それぞれ subject と trim にマッピングされます。

顔プリセット:

プリセット	最適な用途
closeup	ヘッドショット
head-shoulders	プロフィール写真
upper-body	LinkedIn / フォーマル
half-body	上半身全体

音声の文字起こし

ツールルート: transcribe-audio
モデル: faster-whisper

音声をテキストに変換します。プレーンテキスト、SRT、VTT の出力形式に対応しています。

パラメータ	型	デフォルト	説明
language	string	"auto"	言語: auto, en, de, fr, es, zh, ja, ko, id, th, vi
outputFormat	"txt" | "srt" | "vtt"	"txt"	出力形式

自動字幕

ツールルート: auto-subtitles
モデル: faster-whisper（動画から音声を抽出してから文字起こし）

動画の音声トラックから字幕ファイルを生成します。

パラメータ	型	デフォルト	説明
language	string	"auto"	言語: auto, en, de, fr, es, zh, ja, ko, id, th, vi
format	"srt" | "vtt"	"srt"	出力字幕形式

PNG 透過修正

ツールルート: transparency-fixer
モデル: BiRefNet HR マッティング（2048x2048 解像度）

背景が除去されたものの、フリンジ、ハロー、半透明のアーティファクトが残った「見せかけの透過」PNG を修正します。BiRefNet の高解像度マッティングモデルを使用してクリーンなアルファチャンネルを生成し、その後、設定可能なデフリンジ処理を適用してエッジに沿った色の混入を除去します。

OOM フォールバックチェーン: BiRefNet HR マッティングが利用可能なメモリを超過した場合、ツールは自動的に birefnet-general にフォールバックし、さらに u2net にフォールバックします。

パラメータ	型	デフォルト	説明
defringe	number (0-100)	30	色の混入を除去するエッジデフリンジの強度
outputFormat	"png" | "webp"	"png"	出力画像形式
removeWatermark	boolean	false	ウォーターマーク除去の前処理（メディアンフィルター）を適用

curl -X POST http://localhost:1349/api/v1/tools/image/transparency-fixer \
  -H "Authorization: Bearer <token>" \
  -F "file=@fake-transparent.png" \
  -F 'settings={"defringe":30,"outputFormat":"png"}'

---

AI 機能をオプションで備えたツール

以下のツールは Python サイドカーツールではありませんが、特定のオプションが有効な場合に AI 機能を使用します。

画像補正

ツールルート: image-enhancement
エンジン: 解析ベース（Sharp のヒストグラムと統計）

画像を解析し、露出、コントラスト、ホワイトバランス、彩度、シャープネス、ノイズに対して自動補正を適用します。シーン別のモードに対応しています。

パラメータ	型	デフォルト	説明
mode	"auto" | "portrait" | "landscape" | "low-light" | "food" | "document"	"auto"	補正を調整するシーンモード
intensity	number (0-100)	50	全体的な補正の強度
corrections.exposure	boolean	true	露出補正を適用
corrections.contrast	boolean	true	コントラスト補正を適用
corrections.whiteBalance	boolean	true	ホワイトバランス補正を適用
corrections.saturation	boolean	true	彩度補正を適用
corrections.sharpness	boolean	true	シャープネス補正を適用
corrections.denoise	boolean	true	ノイズ除去を適用
deepEnhance	boolean	false	SCUNet による AI ノイズ除去を有効化（upscale-enhance バンドルが必要）

適用せずに検出された補正内容を返す追加の解析エンドポイントが POST /api/v1/tools/image/image-enhancement/analyze で利用できます。

コンテンツを考慮したリサイズ（シームカービング）

ツールルート: content-aware-resize
エンジン: Go の caire バイナリ（Python ではないため GPU の恩恵なし）

低エネルギーのシームを除去することで画像をインテリジェントにリサイズし、重要なコンテンツを保持します。

パラメータ	型	デフォルト	説明
width	number	-	目標幅
height	number	-	目標高さ
protectFaces	boolean	false	検出された顔の領域を保護（face-detection バンドルが必要）
blurRadius	number (0-20)	4	エネルギー計算のための事前ぼかし
sobelThreshold	number (1-20)	2	エッジ感度のしきい値
square	boolean	false	正方形出力を強制