接口说明
- 请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和价格。
- 调用该接口前，请确保您已通过绑定方式（ CreateBinding ）或者主动索引（ IndexFileMeta 或者 BatchIndexFileMeta ）方式将文件索引到数据集（Dataset）中。
- 该接口为异步接口，任务开始执行后，任务信息只保存 7 天，超过 7 天则无法再获取。调用 GetTask 或者 ListTasks 接口获取返回的 TaskId，查看任务信息。也可以通过设置 Notification 消息通知参数，通过消息通知获取任务信息。
流控信息
请求参数
| 字段名称 | 字段详情 |
|---|---|
ProjectNamestring | 项目名称。获取方式请参见创建项目。 示例值:test-project参考取值来源: CreateProject UpdateProject ListProjects |
DatasetNamestring | 数据集名称。获取方式请参见创建数据集。 示例值:test-dataset参考取值来源: CreateDataset UpdateDataset ListDatasets |
ObjectIdstring | 故事对象 ID。该参数不是必填参数。如果为空，IMM 会为生成的故事创建一个 ID，该 ID 是故事的唯一标识符，可用于对该故事的查询、更新等操作。ID 也可由用户生成，生成之后通过该参数传入，IMM 可记录下用户传入的 ID 作为该故事的唯一标识。如果传入已存在的 ID，则会更新该 ID 对应的故事。 示例值:id1 |
StoryTypestring | 故事类型，指定需要生成相册故事的类型。具体类型描述和可取值请参见故事类型和子类型。 示例值:PeopleMemory参考取值来源: GetStory |
StorySubTypestring | 故事子类型，指定需要生成的相册故事的子类型，具体类型描述和可取值请参见故事类型和子类型。 示例值:Solo参考取值来源: GetStory CreateCustomizedStory |
StoryStartTimestring | 待创建故事的照片集合的开始时间。与 StoryEndTime 共同组成时间区间，IMM 会根据该时间区间来筛选候选照片生成故事。该参数是一个 RFC3339 时间格式的字符串。 示例值:2016-12-30T16:00:00Z |
StoryEndTimestring | 待创建故事的照片集合的结束时间。与 StoryStartTime 共同组成时间区间，IMM 会根据该时间区间来筛选候选照片生成故事。该参数是一个 RFC3339 时间格式的字符串。 示例值:2021-12-30T16:00:00Z |
StoryNamestring | 故事名称。 示例值:name1参考取值来源: GetStory CreateCustomizedStory |
MinFileCountinteger<int64> | 生成的故事中包含的照片文件最小个数，实际生成的故事照片数量会在 MinFileCount 和 MaxFileCount 之间。该参数取值为大于 1 的整数，若待生成故事的候选照片集中的可用照片张数小于该参数，则会返回空故事。 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:1 |
MaxFileCountinteger<int64> | 生成的故事中包含的照片文件最大个数，生成的故事照片数量会在 MinFileCount 和 MaxFileCount 之间。该参数取值范围为大于 MinFileCount 的整数。（为保证故事生成的效果，算法内部会将最大数量限制在 1500，当 MaxFileCount 大于 1500 时，该参数没有效果） 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:3 |
NotifyTopicNamestring | 异步反向通知的 TopicName。 示例值:test-topic |
CustomLabelsobject | 自定义标签。该标签标记了用户对该故事自定义的信息，可作检索使用。 示例值:{"Bucket": "examplebucket"} |
CustomIdstring | 自定义 ID。用户自定义的生成故事的标识（可与 ObjectID 不相同），可供用户后期对故事进行检索、排序等。 示例值:test |
用于故事的地址对象。 | |
Tagsobject | 此参数提供一种标签机制，可在以下场景中使用：展开详情 示例值:{"key":"val"} |
UserDatastring | 用户自定义信息，在异步消息通知中会为您返回，用于方便您系统内对消息通知进行关联处理。最大长度为 2048 字节。 示例值:{"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"} |
返回参数
| 字段名称 | 字段详情 |
|---|---|
RequestIdstring | 当次请求的 Request ID。 示例值:1B3D5E0A-D8B8-4DA0-8127-ED32C851**** |
TaskIdstring | 任务 ID。 示例值:CreateStory-4ef6ff43-edf3-4612-9cc4-0c7f9e19**** |
EventIdstring | 事件 ID。 示例值:392-1CqzvESGTEeNZ2OWFbRKIM**** |
返回示例
变更历史
| 变更时间 | 变更内容概要 | 操作 | |
|---|---|---|---|
| 2023-03-09 | |||
| 2022-11-15 | |||
| 2022-08-16 | |||
| 2022-02-24 | |||
| 2021-12-31 |