Viking AI 搜索
服务 | 区域 | URL |
服务 | 区域 | URL |
火山引擎 | 华北(北京) | https://aisearch.cn-beijing.volces.com/api/v1/dataset/{dataset_id}/list_items |
火山引擎 | 东南亚(柔佛) | https://aisearch.ap-southeast-1.volces.com/api/v1/dataset/{dataset_id}/list_items |
BytePlus | 东南亚(柔佛) | https://aisearch.ap-southeast-1.bytepluses.com/api/v1/dataset/{dataset_id}/list_items |
参数名 | 类型 | 是否必选 | 示例值 | 描述 |
参数名 | 类型 | 是否必选 | 示例值 | 描述 |
filter | Filter 结构 | 否 | | 带查询批量记录的筛选条件 |
max_results | Int | 否 | 10 | 每页获取结果的数量。未填写则为默认值。取值: - 最小值:1 - 最大值:100 - 默认值:10 |
output_fields | Array<String> | 否 | ["title", "price", "category"] | 对查询的目标数据集,指定返回物品数据的字段。指定返回字段后,接口返回的raw_data字段中仅出现指定的字段。 如果数据集中存在嵌套的对象(Object),则只支持传入上层的字段名。 传入不存在的字段或Object内层的字段会被忽略。 |
next_token | String | 否 | MHwxMDY4MzAzMDNfOTM4Njk4NDM4NTAyMzEwNDkx | 用于翻页时候获取下一页内容,字符串 |
参数名 | 类型 | 是否必选 | 示例值 | 描述 |
参数名 | 类型 | 是否必选 | 示例值 | 描述 |
_id | String | 否 | "test_id" | 数据条目主键。筛选项,默认不筛选
|
process_status | Array<String> | 否 | ["success", "processing", "failed"] | 数据条目处理状态:success数据正常,processing处理中,failed数据异常。默认返回全部状态。 |
参数名 | 参数类型 | 举例 | 说明 |
参数名 | 参数类型 | 举例 | 说明 |
next_token | String | MHwxMDY4MzAzMDNfOTM4Njk4NDM4NTAyMzEwNDkx | 用于翻页时候获取下一页内容,字符串。如果为空,表示是最后一条数据 |
items | Array<DataItem> 结构 | | 查询到的数据条目列表,每条数据条目中包含物品ID对应的数据字段和处理详情。 |
参数名 | 参数类型 | 举例 | 说明 |
参数名 | 参数类型 | 举例 | 说明 |
_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<DataStatusDetail> | | 数据质量校验和处理状态列表,包含数据首次导入、最近更新的状态说明。 |
create_time | String | "2025-03-12T15:01:07+08:00" | 创建时间,RFC3339格式 |
update_time | String | "2025-03-12T15:01:07+08:00" | 更新时间,RFC3339格式 |
参数名 | 参数类型 | 举例 | 说明 |
参数名 | 参数类型 | 举例 | 说明 |
video_meta | VideoMeta | | 视频数据的处理和状态信息 |
参数名 | 参数类型 | 举例 | 说明 |
参数名 | 参数类型 | 举例 | 说明 |
content_type | String | video | 内容类型: video, collection |
video_urls | Array<String> | ["https://domain.com/file_path.format"] | 视频URL列表 |
parent_content_id | String | | 父内容ID |
sequence_index | Int | | 序列索引 |
video_content | VideoContent | | 视频处理和理解的内容 |
collection_content | CollectionContent | | 视频合集的处理和理解内容 |
duration | Int | | 视频时长(秒),不足 1 秒向上取整 |
参数名 | 参数类型 | 举例 | 说明 |
参数名 | 参数类型 | 举例 | 说明 |
Title | String | "视频标题" | 生成的视频标题 |
Summary | String | "内容总结" | 生成的视频总结 |
Insight | String | | 视频故事线理解返回的全部内容,将json marshal 为string格式。 |
参数名 | 参数类型 | 举例 | 说明 |
参数名 | 参数类型 | 举例 | 说明 |
summary | String | | 对系列合集下的每个视频处理完成后,将合集整体内容进行总结得到的视频摘要 |
参数名 | 参数类型 | 举例 | 说明 |
参数名 | 参数类型 | 举例 | 说明 |
update_type | String | FIRST_UPDATE_SUCCESS | 更新类型:
|
timestamp | String | 2025-03-12T15:01:07+08:00 | 更新时间,RFC3339格式 |
warning_info | Map[String]String | | 数据质量异常信息,格式为"状态码": "异常详情" 出现数据质量异常不影响数据的处理和入库索引,但建议后续修复以提升检索效果 |
error_info | Map[String]String | | 数据校验和处理异常信息,格式为"状态码": "异常详情" 出现校验和处理异常表示数据被阻断在校验阶段,无法正常处理入库索引,建议查看异常信息并重传修复。 |
状态码 | 说明 |
状态码 | 说明 |
Finished | 数据处理完成 |
Running | 数据正常处理中 |
InternalError | 内部错误处理失败 |
InvalidJsonLineError | JSON数据格式异常 |
DataPrimaryKeyNotFoundError | 必须包含主键字段,且有值 |
InvalidImageUrlError | 图片链接无法访问 |
ImageDownloadTimeout | 图片获取超时 |
ImageUnsupportedFileFormat | 不支持的图片文件格式 |
ImageSizeTooSmall | 图片尺寸过小,无法处理 |
ExtremeImageProportion | 图片长短边比例超过100:1,无法处理 |
ImageFileTooLarge | 图片文件过大 |
ImageBase64UriInvalid | 图片base64编码格式异常 |
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 状态码 | 错误信息 | 说明 |
错误码 | 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. | 请求处理过程中出现了未知错误,例如后端服务超时、出现网络波动等,与可靠性相关 |