You need to enable JavaScript to run this app.
导航
ListItems - 获取数据集中的数据列表
最近更新时间:2025.10.31 17:46:29首次发布时间:2025.08.11 23:11:46
复制全文
我的收藏
有用
有用
无用
无用

指定数据集获取已导入的数据列表,支持分页查询。

说明

仅支持对物品数据集的列表查询,暂不支持行为数据集的查询

注意事项

  • 使用限制:
    • 受到HTTP Body大小限制,单次请求的包体大小最大不超过10MB。

请求说明


{dataset_id}:在控制台创建数据集后,系统指定的数据集唯一标识,可在控制台数据集详情中查看并复制
Image

请求参数

请求体

参数名

类型

是否必选

示例值

描述

filter

Filter 结构

带查询批量记录的筛选条件

max_results

Int

10

每页获取结果的数量。未填写则为默认值。取值: - 最小值:1 - 最大值:100 - 默认值:10

output_fields

Array

["title", "price", "category"]

对查询的目标数据集,指定返回物品数据的字段。指定返回字段后,接口返回的raw_data字段中仅出现指定的字段。

如果数据集中存在嵌套的对象(Object),则只支持传入上层的字段名。
传入不存在的字段或Object内层的字段会被忽略。

next_token

String

MHwxMDY4MzAzMDNfOTM4Njk4NDM4NTAyMzEwNDkx

用于翻页时候获取下一页内容,字符串

Filter

参数名

类型

是否必选

示例值

描述

_id

String

"test_id"

数据条目主键。筛选项,默认不筛选

  • 图文数据集:您指定的物品ID属性对应的字段
  • 视频数据集:content_id字段对应的ID

process_status

Array<String>

["success", "processing", "failed"]

数据条目处理状态:success数据正常,processing处理中,failed数据异常。默认返回全部状态。

响应体

参数名

参数类型

举例

说明

next_token

String

MHwxMDY4MzAzMDNfOTM4Njk4NDM4NTAyMzEwNDkx

用于翻页时候获取下一页内容,字符串。如果为空,表示是最后一条数据

items

Array 结构

查询到的数据条目列表,每条数据条目中包含物品ID对应的数据字段和处理详情。

DataItem

参数名

参数类型

举例

说明

_id

String

"test_itemid"

数据记录主键,数据集内唯一

raw_data

String

导入的原始数据所有字段内容

meta

DataItemMeta结构

对于视频数据集,返回数据的处理和状态信息

process_status

String

"success"

数据处理状态,success, processing, failed

check_status

String

"normal"

数据检查状态,normal, warning, error

data_status_details

Array

数据质量校验和处理状态列表,包含数据首次导入、最近更新的状态说明。

create_time

String

"2025-03-12T15:01:07+08:00"

创建时间,RFC3339格式

update_time

String

"2025-03-12T15:01:07+08:00"

更新时间,RFC3339格式

DataItem中视频数据集返回:
DataItemMeta

参数名

参数类型

举例

说明

video_meta

VideoMeta

视频数据的处理和状态信息

VideoMeta

参数名

参数类型

举例

说明

content_type

String

video

内容类型: video, collection

video_urls

Array

["https://domain.com/file_path.format"]

视频URL列表

parent_content_id

String

父内容ID

sequence_index

Int

序列索引

video_content

VideoContent

视频处理和理解的内容

collection_content

CollectionContent

视频合集的处理和理解内容

duration

Int

视频时长(秒),不足 1 秒向上取整

VideoContent

参数名

参数类型

举例

说明

Title

String

"视频标题"

生成的视频标题

Summary

String

"内容总结"

生成的视频总结

Insight

String

视频故事线理解返回的全部内容,将json marshal 为string格式。

CollectionContent

参数名

参数类型

举例

说明

summary

String

对系列合集下的每个视频处理完成后,将合集整体内容进行总结得到的视频摘要

DataStatusDetail

参数名

参数类型

举例

说明

update_type

String

FIRST_UPDATE_SUCCESS

更新类型:

  • FIRST_UPDATE_SUCCESS:首次导入和处理成功
  • LATEST_UPDATE_SUCCESS:最新一次更新和处理成功
  • UPDATE_FAILED:最近一次更新数据遭遇异常

timestamp

String

2025-03-12T15:01:07+08:00

更新时间,RFC3339格式

warning_info

Map[String]String

数据质量异常信息,格式为"状态码": "异常详情"
出现数据质量异常不影响数据的处理和入库索引,但建议后续修复以提升检索效果

error_info

Map[String]String

数据校验和处理异常信息,格式为"状态码": "异常详情"
出现校验和处理异常表示数据被阻断在校验阶段,无法正常处理入库索引,建议查看异常信息并重传修复。

数据状态说明

数据导入后会进行数据的质量校验和处理,校验和处理过程中会产生数据状态,数据状态会影响数据的索引和使用,以下介绍数据的过程定义和状态定义。

数据过程状态

数据过程状态在DataItem中返回,分为2个状态:

  • process_status:数据的处理状态,包含
    • "success":表示数据正常处理入库完成,对应控制台展示“数据正常”
    • "failed":表示数据有阻断性的异常,导致入库失败,对应控制台展示“数据异常”
    • "processing":表示数据正在处理中,图文数据因处理较快一般不会出现处理中状态,视频文件处理时间较长,会出现处理中状态,对应控制台展示“数据处理中”。
  • check_status:数据的质量验证状态,包含:
    • "normal":数据校验一切正常,各字段没有格式、类型、文件的异常
    • "warning":数据存在质量问题,如非预置字段的类型异常,或图片的链接异常,不影响整条数据的入库处理,但建议收到质量问题状态时修复和重新传输数据
    • "error":数据存在严重质量问题,如预置字段的类型异常,视频文件链接异常,影响整条数据的入库处理,建议收到质量问题状态时修复和重新传输数据

状态详情

DataStatusDetail 结构中返回状态码和状态信息详情,分别展示首次导入、最近一次更新的处理状态详情:

状态码

说明

Finished

数据处理完成

Running

数据正常处理中

InternalError

内部错误处理失败

InvalidJsonLineError

JSON数据格式异常

DataPrimaryKeyNotFoundError

必须包含主键字段,且有值

DataContentTypeNotFoundError

(视频数据)必须包含content_type字段,且有值

UnsupportedContentTypeError

(视频数据)不支持的content_type枚举值,仅支持“video”和“collection”

DuplicateMediaSequenceIndexError

(视频数据)媒体序号重复

MediaCannotBeSetAsParentError

(视频数据)媒体内容不支持设置为父层级

ParentContentMustBeCollectionError

(视频数据)父内容只能为系列

ParentContentNotUploadedError

(视频数据)父内容未上传

InvalidVideoUrlError

(视频数据)视频链接无法访问

InvalidImageUrlError

(视频数据)图片链接无法访问

VideoUrlNotUploadedError

(视频数据)视频url没有上传

InvalidMediaSequenceIndexError

(视频数据)媒体序号值无效,存在重复序号

InvalidMediaCoverUrlError

(视频数据)媒体封面链接无法访问

RequiredFieldTypeMismatchError

(视频数据)预置字段类型错误

NonRequiredFieldTypeMismatchError

自定义字段类型错误

ContentTypeNotModifiableError

(视频数据)content_type不允许修改

VideoProcessError

(视频数据)视频处理异常

VideoDurationExceedsLimitError

(视频数据)视频时长超过限制,最长3.5小时

VideoSizeExceedsLimitError

(视频数据)视频大小超过限制,最大10GB

错误码

错误码

HTTP 状态码

错误信息

说明

DatasetNotFound

404

The dataset not found %s

数据集不存在

InvalidParameter

400

A parameter in the request is not valid: %s

参数不符合格式要求

ErrCodeInvalidRequestBody

400

The request cannot be parsed in JSON format: %s

请求反序列化失败

ErrCodeInternalServiceError

500

Service has some internal Error. Pls Contact With Admin.

请求处理过程中出现了未知错误,例如后端服务超时、出现网络波动等,与可靠性相关

请求示例

请求示例代码

curl -X POST https://aisearch.cn-beijing.volces.com/api/v1/dataset/{dataset_id}/list_items   -H 'Content-Type: application/json'   -H 'Authorization: <火山鉴权的一系列相关header>'   -d '{
    "max_results": 2
  }'

响应示例

{
  "request_id": "0cbab6b2-b17e-4ef6-885b-ed9b9099569a",
  "result": {
    "next_token": "MTc1NDQ4MTQ0MTkyM3wxMDcxNTEwNDdfNTc3MzE4NDA0NDcwNTQ5NjIzfDEwNzE1MTA0Nw\u003d\u003d",
    "items": [
      {
        "_id": "30",
        "raw_data": "{\"duration\":\"\",\"video_url\":[\"http://domain.com/path\"],\"language\":\"汉语普通话\",\"content_id\":\"30\",\"sequence_index\":30,\"title\":\"三体\",\"media_link\":\"https://example.com/tv_series/67890/episode_1/\",\"parent_content_id\":\"三体\",\"release_date\":\"\",\"image\":\"https://domain.com/filename.jpg\",\"content_type\":\"video\",\"genres\":\"剧情/科幻\"}",
        "meta": {
          "video_meta": {
            "content_type": "video",
            "video_urls": [
              "http://domain.com/path"
            ],
            "parent_content_id": "三体",
            "sequence_index": 30,
            "video_content": {
              "title": "智子封锁下的科技困局:微观粒子操控与文明存亡博弈",
              "summary": "三体文明通过智子工程展开质子维度操控,将二维平面包裹星球进行集成电路蚀刻,制造出能干扰地球高能加速器的超能计算机。地球科学家发现基础物理停滞源于智子对撞击实验的破坏,科技发展被彻底锁死。三体世界为此承受极寒黑夜,全民脱水贮存以应对漫长工程。人类科学家在绝望中探讨文明对抗本质,以虫子的生存韧性类比人类与三体文明的科技差距,寻找突破封锁的可能性。",
              "insight": "{\"Summaries\":[\"三体文明通过智子工程展开质子维度操控,将二维平面包裹星球进行集成电路蚀刻,制造出能干扰地球高能加速器的超能计算机。地球科学家发现基础物理停滞源于智子对撞击实验的破坏,科技发展被彻底锁死。三体世界为此承受极寒黑夜,全民脱水贮存以应对漫长工程。人类科学家在绝望中探讨文明对抗本质,以虫子的生存韧性类比人类与三体文明的科技差距,寻找突破封锁的可能性。\"],\"Titles\":[\"智子封锁下的科技困局:微观粒子操控与文明存亡博弈\"],\"Clips\":[{\"Title\":\"《三体》开场,宇宙探秘之旅开启\",\"Summary\":\"视频开场展示了出品人、总制片人等信息,随后画面切换到一艘在迷雾中航行的船,标注着林奇、孙忠怀等名字。接着,画面呈现出神秘的宇宙景象,包括悬浮的星球和复杂的机械装置,显示出科幻氛围。最后,镜头转到户外,有几个人在草地上活动,似乎在进行某种探索或讨论,为后续剧情埋下伏笔。\",\"Score\":3.5,\"Dialogue\":\"沪剧审字2023第001号。林奇、孙忠怀,出品人何嵩、白一骢、卢歧、马延琨、中积军、纪敬、胡进、黄杰、夏晓辉、王寒英。李尔云、白一骢、杨星阳、伊简梅、朱智涵、纪毅、朱绍超、黄橙、王宁、刘焱、田咏力、胡海波、徐丹、桑俊、康歆、李潇、闫豪利、吴洋、刘羽丹、章炜、尹秀杰、刘浮、海霞程、王涛、蔡天君、陈正纲、陈晨、刘勇奇、刘屹、周炜强、姜涛、刘屹、灯伟、周炜强、姜涛、男津语、路迪、音乐总监陈雪燃。\",\"Start\":0,\"End\":66.5}... ...]}"
            },
            "collection_content": {},
            "duration": 3288
          }
        },
        "process_status": "success",
        "check_status": "warning",
        "data_status_details": [
          {
            "update_type": "FIRST_UPDATE_SUCCESS",
            "timestamp": "2025-08-06T19:57:23+08:00",
            "warning_info": {
              "ParentContentNotUploadedError": ""
            }
          }
        ],
        "update_time": "2025-08-06T19:57:22+08:00"
      },
      {
        "_id": "29",
        "raw_data": "{\"image\":\"https://domain.com/filename.jpg\",\"title\":\"三体\",\"director\":\"杨磊\",\"video_url\":[\"http://domain.com/filename.mp4\"],\"content_type\":\"video\",\"sequence_index\":29,\"language\":\"汉语普通话\",\"release_date\":\"\",\"content_id\":\"29\",\"parent_content_id\":\"三体\",\"screenwriter\":[\"田良良\",\"陈晨\"],\"alias\":\"三体/Three-Body\",\"genres\":\"剧情/科幻\",\"douban_rating\":\"7.0\",\"first_air_date\":\"2023-01-15(中国大陆)\",\"media_link\":\"https://example.com/tv_series/67890/episode_1/\"}",
        "meta": {
          "video_meta": {
            "content_type": "video",
            "video_urls": [
              "http://domain.com/filename.mp4\"            
              ],
            "parent_content_id": "三体",
            "sequence_index": 29,
            "video_content": {
              "title": "纳米丝弦锁运河,星际谍影现杀机",
              "summary": "多国部队联合执行古筝行动,在巴拿马运河布设纳米丝切割网。审判日号载着穷凶极恶的船员驶入死亡之网,船体被精密切割解体。行动同时揭示三体监听站秘密,监听员冒死向地球发出警告,暴露三体文明占领太阳系的阴谋。全球战区协同完成信息截获,废墟中展开三体数据搜索,人类首次直面星际威胁。",
              "insight": "{\"Summaries\":[\"多国部队联合执行古筝行动,在巴拿马运河布设纳米丝切割网。审判日号载着穷凶极恶的船员驶入死亡之网,船体被精密切割解体。行动同时揭示三体监听站秘密,监听员冒死向地球发出警告,暴露三体文明占领太阳系的阴谋。全球战区协同完成信息截获,废墟中展开三体数据搜索,人类首次直面星际威胁。\"],\"Titles\":[\"纳米丝弦锁运河,星际谍影现杀机\"],\"Clips\":[{\"Title\":\"《三体》开场,宇宙探秘之旅开启\",\"Summary\":\"视频开场展示了国产电视剧发行许可证,随后是出品人、制片人等众多主创人员名单。画面中出现了神秘的宇宙景象,包括星空、星球以及一些高科技装置,营造出神秘而宏大的氛围。最后,镜头切换到户外,几个人在草地上似乎在进行某种活动,为故事的展开埋下伏笔。\",\"Score\":3.5,\"Dialogue\":\"沪剧审字2023第001号。林奇、孙忠怀,出品人何嵩、白一、卢歧、马延琨、中积军、纪敬、胡进、黄杰、夏晓辉、王寒英、李尔云、白一骢、杨星阳、伊简梅、A李尔云白,制A人黄星、汪悍贤、马骏、赵小波、朱智涵、纪毅、朱绍超、黄橙、王宁、刘田、水力胡、彭好、李盐、赵菁菁、事李、闫豪利、吴洋、刘羽丹、章炜、尹秀杰、王禹、齐昱、杨舒童、尹铁钢、刘淳、孙宏志、张曙光、陈晨、国剧陈晨、刘勇奇、刘屹、\",\"Start\":0,\"End\":67.5},{\"Title\":\"众人商讨过运河计划\",\"Summary\":\"在一间高科技感十足的会议室里,众人围坐在长桌旁,正在紧张地讨论着。其中一位戴眼镜的男子提出,船必须在白天过运河,其他人则认真倾听并思考着这一计划的可行性,整个场景充满了紧张和严肃的氛围。\",\"Score\":3,\"Dialogue\":\"也就是说,这船,得在白天过运河。\",\"Start\":67.5,\"End\":126},{\"Title\":\"众人商讨纳米丝布置方案\",\"Summary\":\"在一个指挥室内,众人正在讨论纳米丝的布置方案。有人提出,考虑到夜间船上人员的睡觉姿势,五十厘米的空档太大,而白天则足够。另一人提出疑问,如何确保其他船只的通行安全。随后,有人建议每根纳米丝在岸上连接一段普通钢丝,每根柱子一端连接活动绞机,通过坠在上面的重物使纳米丝沉入河底。\",\"Score\":3.5,\"Dialogue\":\"为什么?夜里船上的人得睡觉啊,他躺下或者趴下,那五十厘米空档太大了。白天不管他是站着,还是蹲着还是坐着,也都够了吧。你真是个魔鬼。我有一个问题,五十根一百六十米的、超强度纳米丝,按五十公分的间距,连接在两根钢柱上,可我们如何确保,其它船只的通行安全?所以我建议,每一根纳米丝,在岸上连接一段普通的钢丝,每一根柱子的一端,和活动的绞机连接,这样,纳米丝可以通过坠在上面的重物,沉入到河底。\",\"Start\":126,\"End\":179}... ....]}"
            },
            "collection_content": {},
            "duration": 2991
          }
        },
        "process_status": "success",
        "check_status": "warning",
        "data_status_details": [
          {
            "update_type": "FIRST_UPDATE_SUCCESS",
            "timestamp": "2025-08-06T19:57:22+08:00",
            "warning_info": {
              "ParentContentNotUploadedError": ""
            }
          }
        ],
        "update_time": "2025-08-06T19:57:22+08:00"
      }
 }