CreateStory - 创建推荐故事

更新时间:
复制 MD 格式

创建推荐故事。 PDS 会根据请求参数中的故事类型和时间范围筛选 drive 空间下的图片和视频,将符合条件的图片、视频加入该故事的文件列表。 若没有符合条件的图片、视频,则会创建空故事。

接口说明

请确保在使用该接口前,已充分了解 PDS 的收费方式和价格

使用此功能须开通增值服务图片处理功能。故事相关接口限时免费。

用户创建故事时可自己指定故事 id:

  • 若指定故事 id:
    • 若故事 id 不存在,则使用该 id 创建新故事;

    • 若故事 id 存在,则会根据新条件生成故事并覆盖更新该故事;

  • 若不指定 id,则会由 PDS 生成故事 id。

说明
  • 该接口为异步接口,用户创建推荐故事后需要等待一定时间生成该故事。用户可以通过 GetStory 接口或者 FindStories 接口去查询创建故事的进度。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

POST /v2/image/create_story HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

domain_id

string

body

object

请求体

drive_id

string

空间 id

1

story_id

string

故事 id。由用户指定。

9132e0d8-fe92-4e56-86c3-f5f112308003

story_type

string

故事类型

枚举值:

  • PeopleMemory :

    人物故事

  • TagMemory :

    标签故事

  • TimeMemory :

    时光故事

  • TravelMemory :

    旅行故事

TagMemory

story_sub_type

string

故事子类型。其值取决于故事类型,详情可见请求参数补充说明。

Food

story_name

string

故事名称。 长度不超过 1024 个字节。

美食

story_start_time

string

创建故事照片或视频的开始时间。RFC3339。

2016-12-30T16:00:00Z

story_end_time

string

创建故事照片或视频的结束时间。RFC3339。

2022-12-30T16:00:00Z

min_image_count

integer

创建故事照片或视频文件最小个数。 须大于 0,小于等于 max_image_count,空值默认为 1。

1

max_image_count

integer

创建故事照片或视频文件最大个数。 须小于等于 100,大于等于 min_image_count,空值默认 30。

30

custom_labels deprecated

object

自定义标签。 标签数量不能超过 20 个。

string

自定义标签

label_value

address Address

地址信息

故事类型

  • TimeMemory:时光故事

  • PeopleMemory:人物故事

  • TagMemory:标签故事

  • TravelMemory:旅行故事

故事子类型

TimeMemory:空

PeopleMemory:

  • Solo:人物故事,单人故事。搜索数据集里人脸数目最多的人物,根据已做过的人脸聚类的结果生成人物故事,可支持通过时间参数 StoryStartTime 和 StoryEndTime 传入时间间隔,即在某段时间间隔内,照片数量最多的人物为候选人物,不会关注是否已有该人物的故事生成

TagMemory:

  • Food:美食标签故事

  • Pet:宠物标签故事

  • PetDog:宠物狗标签故事

  • PetCat:宠物猫标签故事

  • Scenery:风景标签故事

TravelMemory:空

返回参数

名称

类型

描述

示例值

object

返回参数

drive_id

string

空间 id

1

示例

正常返回示例

JSON格式

{
  "drive_id": "1"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情