文档

QueryStories - 查询故事

更新时间:

根据条件查询故事及其信息。

接口说明

调试

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

授权信息

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

请求参数

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

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

test-project
DatasetNamestring

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

test-dataset
ObjectIdstring

故事对象 ID。

id1
StoryNamestring

故事名称。

name1
StoryTypestring

故事类型。可取值请参见故事类型和子类型

TimeMemory
StorySubTypestring

故事子类型。可取值请参见故事类型和子类型

SeasonHighlights
FigureClusterIdsarray

人物聚类的 ID 列表。

string

人物聚类的 ID。

Cluster-773d9c7e-3fd4-480c-a24b-30a82****
CreateTimeRangeTimeRange

创建故事时间范围。

StoryStartTimeRangeTimeRange

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

StoryEndTimeRangeTimeRange

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

NextTokenstring

在查询结果过多需要翻页时使用,标记当前开始读取的位置,置空表示从头开始;翻页读取时,则需传入上次调用该接口返回的 NextToken 值。

MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****
MaxResultslong

本次读取的最大数据记录数量。取值范围为[1,100]。默认值为 100。

10
CustomLabelsstring

自定义标签键值对。查询满足此标签对的故事。

key=value
WithEmptyStoriesboolean

是否返回空故事。取值范围如下:

  • true(默认):返回空故事。

  • false:不返会空故事。

true
Sortstring

排序字段,取值范围如下:

  • CreateTime:按故事创建时间排序。

  • StoryName:按故事名称排序。

  • StoryStartTime:按故事开始时间排序

  • StoryEndTime:按故事结束时间排序。

CreateTime
Orderstring

排序方式。取值范围如下:

  • asc:升序。

  • desc:降序。

asc

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

当次请求的 Request ID。

2C5C1E0F-D8B8-4DA0-8127-EC32C771****
Storiesarray

查询的故事列表。

Story

故事详细信息。

NextTokenstring

表示当前调用返回读取到的位置,空代表数据已经读取完毕。

MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3Qx****

示例

正常返回示例

JSON格式

{
  "RequestId": "2C5C1E0F-D8B8-4DA0-8127-EC32C771****",
  "Stories": [
    {
      "OwnerId": "102321002****",
      "ProjectName": "immtest",
      "DatasetName": "dataset001",
      "ObjectId": "id1",
      "ObjectType": "story",
      "UpdateTime": "2022-01-14T10:17:18.102700407+08:00",
      "CreateTime": "2022-01-14T10:17:18.102700407+08:00",
      "StoryName": "name1",
      "StoryType": "PeopleMemory",
      "StorySubType": "ImportantPerson",
      "StoryStartTime": "2022-01-14T10:17:18.102700407+08:00",
      "StoryEndTime": "2022-01-14T10:17:18.102700407+08:00",
      "Files": [
        {
          "OwnerId": "102321002467****",
          "ProjectName": "test-project",
          "DatasetName": "test-dataset",
          "ObjectType": "file",
          "ObjectId": "75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7",
          "UpdateTime": "2021-06-29T14:50:13.011643661+08:00",
          "CreateTime": "2021-06-29T14:50:13.011643661+08:00",
          "URI": "oss://test-bucket/test-object.jpg",
          "OSSURI": "oss://examplebucket/sampleobject.jpg",
          "Filename": "sampleobject.jpg",
          "MediaType": "image",
          "ContentType": "image/jpeg",
          "Size": 1000,
          "FileHash": "1d9c280a7c4f67f7ef873e28449dbe17",
          "FileModifiedTime": "2021-06-29T14:50:13.011643661+08:00",
          "FileCreateTime": "2021-06-29T14:50:13.011643661+08:00",
          "FileAccessTime": "2021-06-29T14:50:13.011643661+08:00",
          "ProduceTime": "2021-06-29T14:50:13.011643661+08:00",
          "LatLong": "30.134390,120.074997",
          "Timezone": "",
          "Addresses": [
            {
              "Language": "zh-Hans",
              "AddressLine": "中国浙江省杭州市余杭区文一西路969号",
              "Country": "中国",
              "Province": "浙江省",
              "City": "杭州市",
              "District": "余杭区",
              "Township": "文一西路"
            }
          ],
          "TravelClusterId": "-",
          "Orientation": 0,
          "Figures": [
            {
              "FigureId": "868a9e74-cde5-4c7a-9013-28bb984****",
              "FigureConfidence": 1,
              "FigureClusterId": "Cluster-dbe72fec-b84c-4ab6-885b-3678e64****",
              "FigureClusterConfidence": 1,
              "FigureType": "face",
              "Age": 29,
              "AgeSD": 5,
              "Gender": "female",
              "GenderConfidence": 1,
              "Emotion": "happiness",
              "EmotionConfidence": 0.70784568786621,
              "FaceQuality": 0.960875928401947,
              "Boundary": {
                "Width": 200,
                "Height": 300,
                "Left": 10,
                "Top": 30,
                "Polygon": [
                  {
                    "X": 10,
                    "Y": 10
                  }
                ]
              },
              "Mouth": "close",
              "MouthConfidence": 1,
              "Beard": "none",
              "BeardConfidence": 1,
              "Hat": "none",
              "HatConfidence": 1,
              "Mask": "none",
              "MaskConfidence": 1,
              "Glasses": "none",
              "GlassesConfidence": 0.8,
              "Sharpness": 0.7,
              "Attractive": 0.96,
              "HeadPose": {
                "Pitch": 18.385589599609375,
                "Roll": 4.204030513763428,
                "Yaw": 2.4945924282073975
              }
            }
          ],
          "FigureCount": 10,
          "Labels": [
            {
              "Language": "zh-Hans",
              "LabelName": "人物特写",
              "LabelLevel": 1,
              "LabelConfidence": 1,
              "ParentLabelName": "人物",
              "CentricScore": 0.877
            }
          ],
          "Title": "test",
          "ImageWidth": 270,
          "ImageHeight": 500,
          "EXIF": "{\"Compression\":{\"value\":\"6\"},\"DateTime\":{\"value\":\"2020:08:19 17:11:11\"}}",
          "ImageScore": {
            "OverallQualityScore": 0.736
          },
          "CroppingSuggestions": [
            {
              "AspectRatio": "2:3",
              "Confidence": 0.742,
              "Boundary": {
                "Width": 200,
                "Height": 300,
                "Left": 10,
                "Top": 30,
                "Polygon": [
                  {
                    "X": 10,
                    "Y": 10
                  }
                ]
              }
            }
          ],
          "OCRContents": [
            {
              "Language": "zh-hans",
              "Contents": "欢迎使用智能媒体管理",
              "Confidence": 0.8254936695098877,
              "Boundary": {
                "Width": 200,
                "Height": 300,
                "Left": 10,
                "Top": 30,
                "Polygon": [
                  {
                    "X": 10,
                    "Y": 10
                  }
                ]
              }
            }
          ],
          "VideoWidth": 1080,
          "VideoHeight": 1920,
          "VideoStreams": [
            {
              "Index": 0,
              "Language": "en",
              "CodecName": "h264",
              "CodecLongName": "H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10",
              "Profile": "High",
              "CodecTimeBase": "1373627/83160000",
              "CodecTagString": "avc1",
              "CodecTag": "0x31637661",
              "Width": 1280,
              "Height": 720,
              "HasBFrames": 2,
              "SampleAspectRatio": "1:1",
              "DisplayAspectRatio": "16:9",
              "PixelFormat": "yuv420p",
              "Level": 40,
              "FrameRate": "25/1",
              "AverageFrameRate": "25/1",
              "TimeBase": "1/12800",
              "StartTime": 0,
              "Duration": 22.88,
              "Bitrate": 5407765,
              "FrameCount": 572,
              "Rotate": "90",
              "BitDepth": 8,
              "ColorSpace": "bt709",
              "ColorRange": "tv",
              "ColorTransfer": "bt709",
              "ColorPrimaries": "bt709"
            }
          ],
          "Subtitles": [
            {
              "Index": 2,
              "Language": "en",
              "CodecName": "mov_text",
              "CodecLongName": "MOV text",
              "CodecTagString": "tx3g",
              "CodecTag": "0x67337874",
              "StartTime": 0,
              "Duration": 71.378,
              "Bitrate": 74,
              "Content": "欢迎",
              "Width": 600,
              "Height": 30
            }
          ],
          "AudioStreams": [
            {
              "Index": 1,
              "Language": "en",
              "CodecName": "aac",
              "CodecLongName": "AAC (Advanced Audio Coding)",
              "CodecTimeBase": "1/44100",
              "CodecTagString": "mp4a",
              "CodecTag": "0x6134706d",
              "TimeBase": "1/48000",
              "StartTime": 0.0235,
              "Duration": 3.690667,
              "Bitrate": 320087,
              "FrameCount": 173,
              "Lyric": "test",
              "SampleFormat": "fltp",
              "SampleRate": 48000,
              "Channels": 2,
              "ChannelLayout": "stereo"
            }
          ],
          "Artist": "Jane",
          "AlbumArtist": "Jane",
          "AudioCovers": [
            {
              "ImageWidth": 500,
              "ImageHeight": 820,
              "EXIF": "{\"FileSize\":{\"value\":\"29304\"},\"Format\":{\"value\":\"jpg\"}}",
              "ImageScore": {
                "OverallQualityScore": 0.736
              },
              "CroppingSuggestions": [
                {
                  "AspectRatio": "2:3",
                  "Confidence": 0.742
                }
              ],
              "OCRContents": [
                {
                  "Language": "zh-hans",
                  "Contents": "欢迎使用智能媒体管理",
                  "Confidence": 0.8254936695098877
                }
              ]
            }
          ],
          "Composer": "Jane",
          "Performer": "Jane",
          "Language": "eng",
          "Album": "FirstAlbum",
          "PageCount": 5,
          "ETag": "\"1D9C280A7C4F67F7EF873E28449****\"",
          "CacheControl": "no-cache",
          "ContentDisposition": "attachment; filename =test.jpg",
          "ContentEncoding": "UTF-8",
          "ContentLanguage": "zh-CN",
          "AccessControlAllowOrigin": "https://aliyundoc.com",
          "AccessControlRequestMethod": "PUT",
          "ServerSideEncryptionCustomerAlgorithm": "SM4",
          "ServerSideEncryption": "AES256",
          "ServerSideDataEncryption": "SM4",
          "ServerSideEncryptionKeyId": "9468da86-3509-4f8d-a61e-6eab1eac****",
          "OSSStorageClass": "Standard",
          "OSSCRC64": "559890638950338001",
          "ObjectACL": "default",
          "ContentMd5": "HZwoCnxPZ/fvhz4oRJ2+Fw==",
          "OSSUserMeta": {
            "key": "val"
          },
          "OSSTaggingCount": 2,
          "OSSTagging": {
            "key": "val"
          },
          "OSSExpiration": "2120-01-01T12:00:00.000Z",
          "OSSVersionId": "CAEQNhiBgMDJgZCA0BYiIDc4MGZjZGI2OTBjOTRmNTE5NmU5NmFhZjhjYmY0****",
          "OSSDeleteMarker": "CAEQMhiBgIDXiaaB0BYiIGQzYmRkZGUxMTM1ZDRjOTZhNjk4YjRjMTAyZjhl****",
          "OSSObjectType": "Normal",
          "CustomId": "\t\nmember-image-id-0001",
          "CustomLabels": {
            "MemberName": "Tim",
            "Enabled": "True",
            "ItemCount": "10"
          },
          "StreamCount": 1,
          "ProgramCount": 1,
          "FormatName": "mov",
          "FormatLongName": "QuickTime / MOV",
          "StartTime": 0,
          "Bitrate": 13091201,
          "Duration": 15.263,
          "SemanticSimilarity": 0,
          "SemanticTypes": [
            ""
          ],
          "Elements": [
            {
              "ElementContents": [
                {
                  "Type": "",
                  "Content": "",
                  "URL": ""
                }
              ]
            }
          ],
          "OCRTexts": ""
        }
      ],
      "Cover": {
        "OwnerId": "102321002467****",
        "ProjectName": "test-project",
        "DatasetName": "test-dataset",
        "ObjectType": "file",
        "ObjectId": "75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7",
        "UpdateTime": "2021-06-29T14:50:13.011643661+08:00",
        "CreateTime": "2021-06-29T14:50:13.011643661+08:00",
        "URI": "oss://test-bucket/test-object.jpg",
        "OSSURI": "oss://examplebucket/sampleobject.jpg",
        "Filename": "sampleobject.jpg",
        "MediaType": "image",
        "ContentType": "image/jpeg",
        "Size": 1000,
        "FileHash": "1d9c280a7c4f67f7ef873e28449dbe17",
        "FileModifiedTime": "2021-06-29T14:50:13.011643661+08:00",
        "FileCreateTime": "2021-06-29T14:50:13.011643661+08:00",
        "FileAccessTime": "2021-06-29T14:50:13.011643661+08:00",
        "ProduceTime": "2021-06-29T14:50:13.011643661+08:00",
        "LatLong": "30.134390,120.074997",
        "Timezone": "",
        "Addresses": [
          {
            "Language": "zh-Hans",
            "AddressLine": "中国浙江省杭州市余杭区文一西路969号",
            "Country": "中国",
            "Province": "浙江省",
            "City": "杭州市",
            "District": "余杭区",
            "Township": "文一西路"
          }
        ],
        "TravelClusterId": "-",
        "Orientation": 0,
        "Figures": [
          {
            "FigureId": "868a9e74-cde5-4c7a-9013-28bb984****",
            "FigureConfidence": 1,
            "FigureClusterId": "Cluster-dbe72fec-b84c-4ab6-885b-3678e64****",
            "FigureClusterConfidence": 1,
            "FigureType": "face",
            "Age": 29,
            "AgeSD": 5,
            "Gender": "female",
            "GenderConfidence": 1,
            "Emotion": "happiness",
            "EmotionConfidence": 0.70784568786621,
            "FaceQuality": 0.960875928401947,
            "Mouth": "close",
            "MouthConfidence": 1,
            "Beard": "none",
            "BeardConfidence": 1,
            "Hat": "none",
            "HatConfidence": 1,
            "Mask": "none",
            "MaskConfidence": 1,
            "Glasses": "none",
            "GlassesConfidence": 0.8,
            "Sharpness": 0.7,
            "Attractive": 0.96,
            "HeadPose": {
              "Pitch": 18.385589599609375,
              "Roll": 4.204030513763428,
              "Yaw": 2.4945924282073975
            }
          }
        ],
        "FigureCount": 10,
        "Labels": [
          {
            "Language": "zh-Hans",
            "LabelName": "人物特写",
            "LabelLevel": 1,
            "LabelConfidence": 1,
            "ParentLabelName": "人物",
            "CentricScore": 0.877
          }
        ],
        "Title": "test",
        "ImageWidth": 270,
        "ImageHeight": 500,
        "EXIF": "{\"Compression\":{\"value\":\"6\"},\"DateTime\":{\"value\":\"2020:08:19 17:11:11\"}}",
        "ImageScore": {
          "OverallQualityScore": 0.736
        },
        "CroppingSuggestions": [
          {
            "AspectRatio": "2:3",
            "Confidence": 0.742
          }
        ],
        "OCRContents": [
          {
            "Language": "zh-hans",
            "Contents": "欢迎使用智能媒体管理",
            "Confidence": 0.8254936695098877
          }
        ],
        "VideoWidth": 1080,
        "VideoHeight": 1920,
        "VideoStreams": [
          {
            "Index": 0,
            "Language": "en",
            "CodecName": "h264",
            "CodecLongName": "H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10",
            "Profile": "High",
            "CodecTimeBase": "1373627/83160000",
            "CodecTagString": "avc1",
            "CodecTag": "0x31637661",
            "Width": 1280,
            "Height": 720,
            "HasBFrames": 2,
            "SampleAspectRatio": "1:1",
            "DisplayAspectRatio": "16:9",
            "PixelFormat": "yuv420p",
            "Level": 40,
            "FrameRate": "25/1",
            "AverageFrameRate": "25/1",
            "TimeBase": "1/12800",
            "StartTime": 0,
            "Duration": 22.88,
            "Bitrate": 5407765,
            "FrameCount": 572,
            "Rotate": "90",
            "BitDepth": 8,
            "ColorSpace": "bt709",
            "ColorRange": "tv",
            "ColorTransfer": "bt709",
            "ColorPrimaries": "bt709"
          }
        ],
        "Subtitles": [
          {
            "Index": 2,
            "Language": "en",
            "CodecName": "mov_text",
            "CodecLongName": "MOV text",
            "CodecTagString": "tx3g",
            "CodecTag": "0x67337874",
            "StartTime": 0,
            "Duration": 71.378,
            "Bitrate": 74,
            "Content": "欢迎",
            "Width": 600,
            "Height": 30
          }
        ],
        "AudioStreams": [
          {
            "Index": 1,
            "Language": "en",
            "CodecName": "aac",
            "CodecLongName": "AAC (Advanced Audio Coding)",
            "CodecTimeBase": "1/44100",
            "CodecTagString": "mp4a",
            "CodecTag": "0x6134706d",
            "TimeBase": "1/48000",
            "StartTime": 0.0235,
            "Duration": 3.690667,
            "Bitrate": 320087,
            "FrameCount": 173,
            "Lyric": "test",
            "SampleFormat": "fltp",
            "SampleRate": 48000,
            "Channels": 2,
            "ChannelLayout": "stereo"
          }
        ],
        "Artist": "Jane",
        "AlbumArtist": "Jane",
        "AudioCovers": [
          {
            "ImageWidth": 500,
            "ImageHeight": 820,
            "EXIF": "{\"FileSize\":{\"value\":\"29304\"},\"Format\":{\"value\":\"jpg\"}}",
            "CroppingSuggestions": [],
            "OCRContents": []
          }
        ],
        "Composer": "Jane",
        "Performer": "Jane",
        "Language": "eng",
        "Album": "FirstAlbum",
        "PageCount": 5,
        "ETag": "\"1D9C280A7C4F67F7EF873E28449****\"",
        "CacheControl": "no-cache",
        "ContentDisposition": "attachment; filename =test.jpg",
        "ContentEncoding": "UTF-8",
        "ContentLanguage": "zh-CN",
        "AccessControlAllowOrigin": "https://aliyundoc.com",
        "AccessControlRequestMethod": "PUT",
        "ServerSideEncryptionCustomerAlgorithm": "SM4",
        "ServerSideEncryption": "AES256",
        "ServerSideDataEncryption": "SM4",
        "ServerSideEncryptionKeyId": "9468da86-3509-4f8d-a61e-6eab1eac****",
        "OSSStorageClass": "Standard",
        "OSSCRC64": "559890638950338001",
        "ObjectACL": "default",
        "ContentMd5": "HZwoCnxPZ/fvhz4oRJ2+Fw==",
        "OSSUserMeta": {
          "key": "val"
        },
        "OSSTaggingCount": 2,
        "OSSTagging": {
          "key": "val"
        },
        "OSSExpiration": "2120-01-01T12:00:00.000Z",
        "OSSVersionId": "CAEQNhiBgMDJgZCA0BYiIDc4MGZjZGI2OTBjOTRmNTE5NmU5NmFhZjhjYmY0****",
        "OSSDeleteMarker": "CAEQMhiBgIDXiaaB0BYiIGQzYmRkZGUxMTM1ZDRjOTZhNjk4YjRjMTAyZjhl****",
        "OSSObjectType": "Normal",
        "CustomId": "\t\nmember-image-id-0001",
        "CustomLabels": {
          "MemberName": "Tim",
          "Enabled": "True",
          "ItemCount": "10"
        },
        "StreamCount": 1,
        "ProgramCount": 1,
        "FormatName": "mov",
        "FormatLongName": "QuickTime / MOV",
        "StartTime": 0,
        "Bitrate": 13091201,
        "Duration": 15.263,
        "SemanticSimilarity": 0,
        "SemanticTypes": [
          ""
        ],
        "Elements": [
          {
            "ElementContents": [
              {
                "Type": "",
                "Content": "",
                "URL": ""
              }
            ]
          }
        ],
        "OCRTexts": ""
      },
      "FigureClusterIds": [
        "2cb3c51e-b406-4b0c-af1b-897d88e1****"
      ],
      "CustomId": "test",
      "CustomLabels": {
        "key": "val"
      },
      "Addresses": [
        {
          "Language": "zh-Hans",
          "AddressLine": "中国浙江省杭州市余杭区文一西路969号",
          "Country": "中国",
          "Province": "浙江省",
          "City": "杭州市",
          "District": "余杭区",
          "Township": "文一西路"
        }
      ]
    }
  ],
  "NextToken": "MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3Qx****"
}

错误码

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

  • 本页导读 (1)
文档反馈