文档

CreateStory - 创建故事

更新时间:

创建一个故事。

接口说明

  • 请确保在使用该接口前,已充分了解智能媒体管理产品的收费方式和价格
  • 调用该接口前,请确保您已通过绑定方式( CreateBinding )或者主动索引( IndexFileMeta 或者 BatchIndexFileMeta )方式将文件索引到数据集(Dataset)中。
  • 该接口为异步接口,任务开始执行后,任务信息只保存 7 天,超过 7 天则无法再获取。调用 GetTask 或者 ListTasks 接口获取返回的 TaskId,查看任务信息。也可以通过设置 Notification 消息通知参数,通过消息通知获取任务信息。

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
ProjectNamestring

项目名称。获取方式请参见创建项目

test-project
DatasetNamestring

数据集名称。获取方式请参见创建数据集

test-dataset
ObjectIdstring

故事对象 ID。该参数不是必填参数。如果为空,IMM 会为生成的故事创建一个 ID,该 ID 是故事的唯一标识符,可用于对该故事的查询、更新等操作。ID 也可由用户生成,生成之后通过该参数传入,IMM 可记录下用户传入的 ID 作为该故事的唯一标识。如果传入已存在的 ID,则会更新该 ID 对应的故事。

id1
StoryTypestring

故事类型,指定需要生成相册故事的类型。具体类型描述和可取值请参见故事类型和子类型

PeopleMemory
StorySubTypestring

故事子类型,指定需要生成的相册故事的子类型,具体类型描述和可取值请参见故事类型和子类型

Solo
StoryStartTimestring

待创建故事的照片集合的开始时间。与 StoryEndTime 共同组成时间区间,IMM 会根据该时间区间来筛选候选照片生成故事。该参数是一个 RFC3339 时间格式的字符串。

2016-12-30T16:00:00Z
StoryEndTimestring

待创建故事的照片集合的结束时间。与 StoryStartTime 共同组成时间区间,IMM 会根据该时间区间来筛选候选照片生成故事。该参数是一个 RFC3339 时间格式的字符串。

2021-12-30T16:00:00Z
StoryNamestring

故事名称。

name1
MinFileCountlong

生成的故事中包含的照片文件最小个数,实际生成的故事照片数量会在 MinFileCount 和 MaxFileCount 之间。该参数取值为大于 1 的整数,若待生成故事的候选照片集中的可用照片张数小于该参数,则会返回空故事。

1
MaxFileCountlong

生成的故事中包含的照片文件最大个数,生成的故事照片数量会在 MinFileCount 和 MaxFileCount 之间。该参数取值范围为大于 MinFileCount 的整数。(为保证故事生成的效果,算法内部会将最大数量限制在 1500,当 MaxFileCount 大于 1500 时,该参数没有效果)

3
NotifyTopicNamestring

异步反向通知的 TopicName。

test-topic
CustomLabelsobject

自定义标签。该标签标记了用户对该故事自定义的信息,可作检索使用。

{"Bucket": "examplebucket"}
CustomIdstring

自定义 ID。用户自定义的生成故事的标识(可与 ObjectID 不相同),可供用户后期对故事进行检索、排序等。

test
AddressAddressForStory

待生成故事的地址信息。IMM 会根据该参数标识出的地址位置信息,筛选拍摄地符合该地址信息的照片生成故事,该参数在故事类型为旅行故事(TravelMemory)时生效。

说明 根据相关规定,无法在中国香港、中国澳门、中国台湾及海外提供将中国内地的 GPS 信息解析为地址的能力。
Tagsobject

此参数提供一种标签机制,可在以下场景中使用:

  • 设置自定义数据,这些数据会在 MNS 消息中返回。

  • 作为搜索条件搜索任务。

  • 作为变量在 TargetURI 中使用。

{"key":"val"}
UserDatastring

用户自定义信息,在异步消息通知中会为您返回,用于方便您系统内对消息通知进行关联处理。最大长度为 2048 字节。

{"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"}
NotificationNotification

消息通知配置,详细内容请单击 Notification 查看,异步通知消息格式请参见异步通知消息格式

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

当次请求的 Request ID。

1B3D5E0A-D8B8-4DA0-8127-ED32C851****
TaskIdstring

任务 ID。

CreateStory-4ef6ff43-edf3-4612-9cc4-0c7f9e19****
EventIdstring

事件 ID。

392-1CqzvESGTEeNZ2OWFbRKIM****

示例

正常返回示例

JSON格式

{
  "RequestId": "1B3D5E0A-D8B8-4DA0-8127-ED32C851****",
  "TaskId": "CreateStory-4ef6ff43-edf3-4612-9cc4-0c7f9e19****",
  "EventId": "392-1CqzvESGTEeNZ2OWFbRKIM****"
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-03-09OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Notification
2022-08-16OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    删除入参:NotifyEndpoint
2022-08-16OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    删除入参:NotifyEndpoint
  • 本页导读 (1)