docs: 完善虚拟人API文档 - 补充sections 6/8/9的curl示例和请求示例 - 新增section 10/11: 同步虚拟人素材组合和素材接口 - 更新业务流程说明增加同步步骤
This commit is contained in:
parent
4893cf3f9a
commit
5e4f7f9a98
@ -313,6 +313,7 @@ curl -X POST 'https://token.opencomputing.cn/reallife_asset/api/rl_assets.dspy'
|
|||||||
3. **上传素材**:调用 `rl_virtual_upload.dspy` 上传虚拟人素材到指定组合。
|
3. **上传素材**:调用 `rl_virtual_upload.dspy` 上传虚拟人素材到指定组合。
|
||||||
4. **查询素材列表**:调用 `rl_virtual_assets.dspy` 获取组合下的素材。
|
4. **查询素材列表**:调用 `rl_virtual_assets.dspy` 获取组合下的素材。
|
||||||
5. **状态同步**:调用 `rl_virtual_status.dspy` 查询素材处理状态。
|
5. **状态同步**:调用 `rl_virtual_status.dspy` 查询素材处理状态。
|
||||||
|
6. **从供应商同步**:调用 `sync_from_vendor.dspy` 同步组合、`sync_assets.dspy` 同步素材(当供应商端有新增数据但本地未记录时使用)。
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -366,6 +367,9 @@ curl -X POST 'https://token.opencomputing.cn/reallife_asset/api/rl_virtual_creat
|
|||||||
|
|
||||||
自动从 Bearer Token 获取 `org_id`,返回当前机构下所有虚拟人素材组合。
|
自动从 Bearer Token 获取 `org_id`,返回当前机构下所有虚拟人素材组合。
|
||||||
|
|
||||||
|
### 请求参数
|
||||||
|
无需参数,系统自动从 Bearer Token 获取 `org_id`。
|
||||||
|
|
||||||
### 请求示例
|
### 请求示例
|
||||||
```http
|
```http
|
||||||
POST /reallife_asset/api/rl_virtual_groups.dspy
|
POST /reallife_asset/api/rl_virtual_groups.dspy
|
||||||
@ -390,6 +394,12 @@ Authorization: Bearer ***
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### curl 示例
|
||||||
|
```bash
|
||||||
|
curl -X POST 'https://token.opencomputing.cn/reallife_asset/api/rl_virtual_groups.dspy' \
|
||||||
|
-H 'Authorization: Bearer ***
|
||||||
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 7. 上传虚拟人素材
|
## 7. 上传虚拟人素材
|
||||||
@ -447,6 +457,19 @@ curl -X POST 'https://token.opencomputing.cn/reallife_asset/api/rl_virtual_uploa
|
|||||||
|------|------|------|
|
|------|------|------|
|
||||||
| `vendor_group_id` | 是 | 素材组合 ID |
|
| `vendor_group_id` | 是 | 素材组合 ID |
|
||||||
|
|
||||||
|
> `org_id` 由 Bearer Token 自动获取,无需传递。
|
||||||
|
|
||||||
|
### 请求示例
|
||||||
|
```http
|
||||||
|
POST /reallife_asset/api/rl_virtual_assets.dspy
|
||||||
|
Authorization: Bearer ***
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
{
|
||||||
|
"vendor_group_id": "volc-group-xxx"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
### 返回示例
|
### 返回示例
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@ -468,15 +491,38 @@ curl -X POST 'https://token.opencomputing.cn/reallife_asset/api/rl_virtual_uploa
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### curl 示例
|
||||||
|
```bash
|
||||||
|
curl -X POST 'https://token.opencomputing.cn/reallife_asset/api/rl_virtual_assets.dspy' \
|
||||||
|
-H 'Authorization: Bearer *** \
|
||||||
|
-H 'Content-Type: application/json' \
|
||||||
|
-d '{"vendor_group_id":"volc-group-xxx"}'
|
||||||
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 9. 查询虚拟人素材处理状态
|
## 9. 查询虚拟人素材处理状态
|
||||||
**Endpoint**: `/reallife_asset/api/rl_virtual_status.dspy`
|
**Endpoint**: `/reallife_asset/api/rl_virtual_status.dspy`
|
||||||
|
|
||||||
|
查询虚拟人素材的处理状态(Processing / Active / Failed)。
|
||||||
|
|
||||||
### 请求参数
|
### 请求参数
|
||||||
| 参数 | 必填 | 说明 |
|
| 参数 | 必填 | 说明 |
|
||||||
|------|------|------|
|
|------|------|------|
|
||||||
| `asset_id` | 是 | 素材 ID |
|
| `asset_id` | 是 | 上传素材时返回的本地记录 ID |
|
||||||
|
|
||||||
|
> `org_id` 由 Bearer Token 自动获取,无需传递。
|
||||||
|
|
||||||
|
### 请求示例
|
||||||
|
```http
|
||||||
|
POST /reallife_asset/api/rl_virtual_status.dspy
|
||||||
|
Authorization: Bearer ***
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
{
|
||||||
|
"asset_id": "asset-local-xxx"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
### 返回示例
|
### 返回示例
|
||||||
```json
|
```json
|
||||||
@ -489,10 +535,109 @@ curl -X POST 'https://token.opencomputing.cn/reallife_asset/api/rl_virtual_uploa
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
> **说明**:虚拟人素材的处理状态与真人素材相同(Processing / Active / Failed)。`url` 为临时签名下载链接,过期后可再次调用本接口获取新链接。
|
||||||
|
|
||||||
|
### curl 示例
|
||||||
|
```bash
|
||||||
|
curl -X POST 'https://token.opencomputing.cn/reallife_asset/api/rl_virtual_status.dspy' \
|
||||||
|
-H 'Authorization: Bearer *** \
|
||||||
|
-H 'Content-Type: application/json' \
|
||||||
|
-d '{"asset_id":"asset-local-xxx"}'
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 10. 同步虚拟人素材组合
|
||||||
|
**Endpoint**: `/reallife_asset/api/sync_from_vendor.dspy`
|
||||||
|
|
||||||
|
从供应商同步素材组合到本地数据库。当供应商端有新增组合但本地未记录时使用。
|
||||||
|
|
||||||
|
### 请求参数
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `vendor` | 是 | 供应商标识,如 `volcengine` |
|
||||||
|
| `project_name` | 否 | 项目名称,默认 `default` |
|
||||||
|
|
||||||
|
> `org_id` 由 Bearer Token 自动获取,无需传递。
|
||||||
|
|
||||||
|
### 请求示例
|
||||||
|
```http
|
||||||
|
POST /reallife_asset/api/sync_from_vendor.dspy
|
||||||
|
Authorization: Bearer ***
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
{
|
||||||
|
"vendor": "volcengine",
|
||||||
|
"project_name": "default"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 返回示例
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"widgettype": "Message",
|
||||||
|
"options": {
|
||||||
|
"message": "同步完成,共 3 条记录",
|
||||||
|
"type": "success"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### curl 示例
|
||||||
|
```bash
|
||||||
|
curl -X POST 'https://token.opencomputing.cn/reallife_asset/api/sync_from_vendor.dspy' \
|
||||||
|
-H 'Authorization: Bearer *** \
|
||||||
|
-H 'Content-Type: application/json' \
|
||||||
|
-d '{"vendor":"volcengine","project_name":"default"}'
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 11. 同步虚拟人素材
|
||||||
|
**Endpoint**: `/reallife_asset/api/sync_assets.dspy`
|
||||||
|
|
||||||
|
从供应商同步指定素材组合下的素材到本地数据库。当供应商端有新增素材但本地未记录时使用。
|
||||||
|
|
||||||
|
### 请求参数
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `group_id` | 是 | 本地素材组合 ID(`rl_asset_group.id`,通过查询组合列表获取) |
|
||||||
|
|
||||||
|
> `org_id` 由 Bearer Token 自动获取,无需传递。
|
||||||
|
|
||||||
|
### 请求示例
|
||||||
|
```http
|
||||||
|
POST /reallife_asset/api/sync_assets.dspy
|
||||||
|
Authorization: Bearer ***
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
{
|
||||||
|
"group_id": "local-group-id-xxx"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 返回示例
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"widgettype": "Message",
|
||||||
|
"options": {
|
||||||
|
"message": "素材同步完成,共 5 条记录",
|
||||||
|
"type": "success"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### curl 示例
|
||||||
|
```bash
|
||||||
|
curl -X POST 'https://token.opencomputing.cn/reallife_asset/api/sync_assets.dspy' \
|
||||||
|
-H 'Authorization: Bearer *** \
|
||||||
|
-H 'Content-Type: application/json' \
|
||||||
|
-d '{"group_id":"local-group-id-xxx"}'
|
||||||
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 错误代码说明
|
## 错误代码说明
|
||||||
|
|
||||||
| 错误信息 | 原因 | 解决方案 |
|
| 错误信息 | 原因 | 解决方案 |
|
||||||
|----------|------|----------|
|
|----------|------|----------|
|
||||||
| `供应商配置不存在` | 营运人员未配置 AK/SK | 联系管理员配置 `rl_vendor_config` |
|
| `供应商配置不存在` | 营运人员未配置 AK/SK | 联系管理员配置 `rl_vendor_config` |
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user