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

@@ -236,7 +236,33 @@ Chunk片段是影片處理後的最小單位。當影片上傳後系統
## 6. 如何使用 Chunk
### 6.1 搜尋相關片段
### 6.1 API 取得 Chunk
使用搜尋 API 取得 Chunk
```bash
curl -X POST "https://api.momentry.ddns.net/api/v1/search" \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "關鍵字",
"limit": 10
}'
```
**指定影片搜尋**
```bash
curl -X POST "https://api.momentry.ddns.net/api/v1/search" \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "關鍵字",
"uuid": "39567a0eb16f39fd",
"limit": 5
}'
```
### 6.2 搜尋相關片段
當使用者搜尋「天氣」時,系統會:
@@ -245,22 +271,88 @@ Chunk片段是影片處理後的最小單位。當影片上傳後系統
3. 找到相關的 Chunk
4. 返回時間軸和內容
### 6.2 播放指定片段
### 6.3 播放指定片段
取得 Chunk 後可播放:
```
開始時間: 12.5 秒
結束時間: 18.3 秒
影片 UUID: 39567a0eb16f39fd
```
### 6.3 組合多個 Chunk
**播放器連結格式**
```
/player?uuid={uuid}&start={start_time}&end={end_time}
```
### 6.4 組合多個 Chunk
多個相關 Chunk 可以組合成一個章節或故事線。
### 6.5 Story Chunk父子關係
Story Chunk 可包含多個子 Chunk
```json
{
"chunk_id": "story_001",
"chunk_type": "story",
"content": {
"story_id": "story_001",
"title": "開場介紹",
"child_chunk_ids": ["sentence_00001", "sentence_00002", "cut_00001"]
}
}
```
---
## 7. 快速參考
## 7. API 回應格式
### /search 回應
```json
{
"results": [
{
"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": "關鍵字"
}
```
### /n8n/search 回應
```json
{
"query": "關鍵字",
"count": 1,
"hits": [
{
"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"
}
]
}
```
---
## 8. 快速參考
| 項目 | 說明 |
|------|------|
@@ -273,7 +365,7 @@ Chunk片段是影片處理後的最小單位。當影片上傳後系統
| content | 詳細 JSON 結構 |
| metadata | 人臉、OCR、姿態等偵測結果 |
| parent_chunk_id | 父區塊 ID用於 story 區塊) |
| child_chunk_ids | 子區塊 ID 列表story 區塊專用) |
| child_chunk_ids | 子區塊 ID 列表story 區塊專用) | |
---
@@ -282,3 +374,4 @@ Chunk片段是影片處理後的最小單位。當影片上傳後系統
| 版本 | 日期 | 內容 | 操作人 |
|------|------|------|--------|
| V1.0 | 2026-03-25 | 初版建立 | OpenCode |
| V1.1 | 2026-03-25 | 新增 API 取得 Chunk 方式、播放連結格式 | OpenCode |