mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
SnapOtterandGitHub
4963ab3bbd
All 181 docs markdown files translated into 20 languages (apps/docs/<locale>/**). Companion to the i18n code PR; admin-merged because the file count exceeds GitHub's per-PR CI trigger limit. Validated by pnpm i18n:check (all surfaces, 0 stale/missing) and a clean all-locale docs build.
137 lines
4.9 KiB
Markdown
137 lines
4.9 KiB
Markdown
---
|
||
description: "AI 驅動的背景移除，並可選用效果（模糊、陰影、漸層、自訂背景）。"
|
||
i18n_source_hash: 326a91284529
|
||
i18n_provenance: human
|
||
i18n_output_hash: 01085f3605f4
|
||
---
|
||
|
||
# 移除背景 {#remove-background}
|
||
|
||
AI 驅動的背景移除，並可選用效果（模糊、陰影、漸層、自訂背景）。
|
||
|
||
## API 端點 {#api-endpoint}
|
||
|
||
`POST /api/v1/tools/image/remove-background`
|
||
|
||
**處理方式：** 非同步（傳回 202，透過 SSE 輪詢 `/api/v1/jobs/{jobId}/progress` 以取得狀態）
|
||
|
||
**模型套件包：** `background-removal`（4-5 GB）
|
||
|
||
## 參數 {#parameters}
|
||
|
||
| 參數 | 類型 | 必填 | 預設值 | 說明 |
|
||
|-----------|------|----------|---------|-------------|
|
||
| file | file | 是 | - | 圖片檔案（multipart） |
|
||
| model | string | 否 | - | 要使用的 AI 模型變體 |
|
||
| backgroundType | string | 否 | `"transparent"` | 下列其中之一：`transparent`、`color`、`gradient`、`blur`、`image` |
|
||
| backgroundColor | string | 否 | - | 純色背景的十六進位顏色 |
|
||
| gradientColor1 | string | 否 | - | 第一個漸層顏色 |
|
||
| gradientColor2 | string | 否 | - | 第二個漸層顏色 |
|
||
| 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 | 否 | - | 移除邊緣的色彩滲透 |
|
||
|
||
## 範例請求 {#example-request}
|
||
|
||
```bash
|
||
curl -X POST http://localhost:1349/api/v1/tools/image/remove-background \
|
||
-F "file=@photo.jpg" \
|
||
-F 'settings={"backgroundType":"transparent","edgeRefine":2,"outputFormat":"png"}'
|
||
```
|
||
|
||
## 回應 {#response}
|
||
|
||
### 初始回應（202 Accepted） {#initial-response-202-accepted}
|
||
|
||
```json
|
||
{
|
||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||
"async": true
|
||
}
|
||
```
|
||
|
||
### 進度（SSE 於 `/api/v1/jobs/{jobId}/progress`） {#progress-sse-at-api-v1-jobs-jobid-progress}
|
||
|
||
```
|
||
event: progress
|
||
data: {"phase":"processing","stage":"Removing background...","percent":50}
|
||
```
|
||
|
||
### 最終結果（透過 SSE） {#final-result-via-sse}
|
||
|
||
```json
|
||
{
|
||
"phase": "complete",
|
||
"percent": 100,
|
||
"result": {
|
||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||
"downloadUrl": "/api/v1/download/{jobId}/photo_mask.png",
|
||
"maskUrl": "/api/v1/download/{jobId}/photo_mask.png",
|
||
"originalUrl": "/api/v1/download/{jobId}/photo_original.png",
|
||
"originalSize": 245000,
|
||
"processedSize": 180000,
|
||
"filename": "photo.jpg",
|
||
"model": "rembg"
|
||
}
|
||
}
|
||
```
|
||
|
||
## 效果端點（階段 2） {#effects-endpoint-phase-2}
|
||
|
||
`POST /api/v1/tools/image/remove-background/effects`
|
||
|
||
重新套用背景效果，而不重新執行 AI 模型。使用階段 1 的快取遮罩與原圖。
|
||
|
||
### 參數 {#parameters-1}
|
||
|
||
| 參數 | 類型 | 必填 | 預設值 | 說明 |
|
||
|-----------|------|----------|---------|-------------|
|
||
| settings | JSON | 是 | - | 包含效果設定的 JSON（見下方） |
|
||
| backgroundImage | file | 否 | - | 自訂背景圖片（當 backgroundType 為 `image` 時） |
|
||
|
||
#### Settings JSON 欄位 {#settings-json-fields}
|
||
|
||
| 欄位 | 類型 | 必填 | 說明 |
|
||
|-------|------|----------|-------------|
|
||
| jobId | string | 是 | 來自階段 1 的作業 ID |
|
||
| filename | string | 是 | 來自階段 1 的原始檔名 |
|
||
| backgroundType | string | 否 | `transparent`、`color`、`gradient`、`blur`、`image` |
|
||
| backgroundColor | string | 否 | 純色背景的十六進位顏色 |
|
||
| gradientColor1 | string | 否 | 第一個漸層顏色 |
|
||
| gradientColor2 | string | 否 | 第二個漸層顏色 |
|
||
| gradientAngle | number | 否 | 漸層角度（度） |
|
||
| blurEnabled | boolean | 否 | 啟用背景模糊 |
|
||
| blurIntensity | number | 否 | 模糊強度（0-100） |
|
||
| shadowEnabled | boolean | 否 | 啟用投影 |
|
||
| shadowOpacity | number | 否 | 陰影不透明度（0-100） |
|
||
| outputFormat | string | 否 | `png`、`webp` 或 `avif` |
|
||
|
||
### 範例請求 {#example-request-1}
|
||
|
||
```bash
|
||
curl -X POST http://localhost:1349/api/v1/tools/image/remove-background/effects \
|
||
-F 'settings={"jobId":"a1b2c3d4-...","filename":"photo.jpg","backgroundType":"color","backgroundColor":"#FF5500","outputFormat":"png"}'
|
||
```
|
||
|
||
### 回應（200 OK） {#response-200-ok}
|
||
|
||
```json
|
||
{
|
||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||
"downloadUrl": "/api/v1/download/{jobId}/photo_nobg.png",
|
||
"processedSize": 195000
|
||
}
|
||
```
|
||
|
||
## 注意事項 {#notes}
|
||
|
||
- 需要安裝 `background-removal` 模型套件包（4-5 GB）。
|
||
- 階段 1 會快取透明遮罩與原始圖片，讓階段 2（效果）可以立即重新套用不同背景，而不重新執行 AI 模型。
|
||
- 透過自動解碼支援 HEIC/HEIF、RAW、TGA、PSD、EXR 與 HDR 輸入格式。
|
||
- 處理前會自動更正 EXIF 旋轉。
|