docs: add chunk API usage, playback format, and API examples

This commit is contained in:
Warren
2026-03-25 16:06:11 +08:00
parent f8925ab994
commit 17cab667f9
3 changed files with 231 additions and 41 deletions

View File

@@ -76,13 +76,21 @@ curl -s -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b6
### 3.2 搜尋與分段查詢
#### POST /api/v1/search
向量搜尋,查詢分段詳情
向量搜尋,查詢分段Chunk詳情
**請求參數**:
| 參數 | 類型 | 必填 | 說明 |
|------|------|------|------|
| `query` | string | 是 | 搜尋關鍵字 |
| `limit` | number | 否 | 回傳數量(預設 10 |
| `uuid` | string | 否 | 只搜尋指定影片 |
**請求範例**:
```json
{
"query": "關鍵字",
"limit": 10
"query": "天氣",
"limit": 10,
"uuid": "5dea6618a606e7c7"
}
```
@@ -91,49 +99,77 @@ curl -s -H "X-API-Key: muser_68600856036340bcafc01930eb4bd839_1774418104_97221b6
{
"results": [
{
"uuid": "5dea6618a606e7c7",
"chunk_id": "time_00001",
"chunk_type": "time",
"start_time": 0.0,
"end_time": 10.0,
"text": "分段內容文字",
"score": 0.95
"uuid": "39567a0eb16f39fd",
"chunk_id": "sentence_1471",
"chunk_type": "sentence",
"start_time": 5309.08,
"end_time": 5311.08,
"text": "influenced by a vital way,",
"score": 0.68
}
]
],
"query": "天氣"
}
```
**Chunk 欄位說明**:
| 欄位 | 說明 | 範例 |
|------|------|------|
| `uuid` | 影片唯一識別碼 | `39567a0eb16f39fd` |
| `chunk_id` | 分段識別碼 | `sentence_1471` |
| `chunk_type` | 分段類型 | `sentence` / `cut` / `time` / `trace` / `story` |
| `start_time` | 開始時間(秒) | `5309.08` |
| `end_time` | 結束時間(秒) | `5311.08` |
| `text` | 內容文字 | `influenced by a vital way` |
| `score` | 相似度分數0-1 | `0.68` |
**Chunk 類型說明**:
| 類型 | 說明 | 來源 |
|------|------|------|
| `sentence` | 語音轉文字片段 | ASR 處理 |
| `cut` | 場景變化片段 | CUT 處理 |
| `time` | 固定時間分段 | 系統自動切割 |
| `trace` | 軌跡追蹤片段 | YOLO 追蹤 |
| `story` | 故事線片段(父子關係) | Story 分析 |
#### POST /api/v1/n8n/search
n8n 專用搜尋(包含縮圖網址)
n8n 專用搜尋(包含影片網址)
**請求範例**:
```json
{
"query": "關鍵字",
"limit": 10
}
```
**請求參數**:`/search` 相同
**回應範例**:
```json
{
"query": "天氣",
"count": 2,
"hits": [
{
"uuid": "5dea6618a606e7c7",
"chunk_id": "time_00001",
"chunk_type": "time",
"start_time": 0.0,
"end_time": 10.0,
"text": "分段內容文字",
"score": 0.95,
"thumbnail_url": "https://..."
"id": "sentence_1471",
"vid": "39567a0eb16f39fd",
"start": 5309.08,
"end": 5311.08,
"title": "Chunk sentence_1471",
"text": "influenced by a vital way,",
"score": 0.68,
"media_url": "https://wp.momentry.ddns.net/video.mp4"
}
]
}
```
**與 /search 的差異**:
| 欄位 | `/search` | `/n8n/search` |
|------|-----------|----------------|
| 影片 UUID | `uuid` | `vid` |
| Chunk ID | `chunk_id` | `id` |
| 開始時間 | `start_time` | `start` |
| 結束時間 | `end_time` | `end` |
| 影片網址 | ❌ | ✅ `media_url` |
### 3.3 任務相關
### 3.4 任務相關
#### GET /api/v1/jobs/:uuid
查詢處理任務狀態
@@ -164,7 +200,7 @@ curl -s -H "X-API-Key: ..." \
"https://api.momentry.ddns.net/api/v1/jobs?status=completed&limit=5"
```
### 3.3 系統管理
### 3.5 系統管理
#### POST /api/v1/config/cache
切換快取功能(管理員專用)
@@ -205,7 +241,7 @@ curl -s -H "X-API-Key: ..." \
**注意**: 此操作會刪除影片及其所有分段、處理結果、縮圖等關聯資料,**無法復原**。
### 3.5 健康檢查
### 3.6 健康檢查
#### GET /health
服務健康狀態(**無需認證**
@@ -330,3 +366,4 @@ GET /api/v1/jobs/{uuid}
|------|------|------|--------|
| V1.0 | 2026-03-25 | 初版建立 | OpenCode |
| V1.1 | 2026-03-25 | 新增快取/刪除 API、搜尋端點文件 | OpenCode |
| V1.2 | 2026-03-25 | 新增 Chunk 欄位說明、類型、播放方式 | OpenCode |