文档中心

向量数据库VikingDB

请输入

任务创建

Collection 数据过滤更新任务

概述

按特定条件批量更新数据，不支持vector、sparse_vector、text 类型字段的更新

请求参数

参数名	类型	必须	说明	子字段	类型	必选	说明
task_type	string	是	任务类型，填入 filter_update
task_params	map	是	任务参数	collection_name	string	是	Collection 名称，必填
				filter_conds	array	是	过滤条件，支持 must 、must_not、range、range_out 算子，使用参考标量过滤过滤更新 city 为 beijing 且 user_id (0, 4) 之间的数据 `JSON <br> [ <br> { <br> "op": "must", <br> "field": "city", <br> "conds": ["beijing"] <br> }, <br> { <br> "op": "range", <br> "field": "user_id", <br> "gt": 0, <br> "lt": 4 <br> }, <br> <br> ] <br>`
				update_fields	map	是	需要更新的字段值，必须是标量字段，不支持vector、sparse_vector、text 类型字段的更新 `JSON <br> { <br> "user_name":"xxx" <br> } <br>`

示例

请求参数

curl -i -X POST \
  -H 'Content-Type: application/json' \
  -H 'Authorization: HMAC-SHA256 ***' \
  https://api-vikingdb.volces.com/api/task/create \
  -d '{
    "task_type": "filter_update",
    "task_params": {
        "collection_name": "example",
        "filter_conds": [
            {
                "op": "must",
                "field": "city",
                "conds": ["beijing"]
            },
            {
                "op": "range",
                "field": "user_id",
                "gt": 0,
                "lt": 4
            }
        ],
        "update_fields": {
            "city": "shanghai"
        }
    }
}'

返回值

属性	说明
task_id	uuid

返回说明补充

返回参数补充

字段	类型	含义
`code`	int	业务状态码；成功时为 0。
`message`	string	状态说明。
`request_id`	string	请求唯一标识。
`task_id`	string	创建成功的离线任务唯一标识，后续用于查询、更新或删除任务。

返回说明补充

返回参数补充

字段	类型	含义
`code`	int	业务状态码；成功时为 0。
`message`	string	状态说明。
`request_id`	string	请求唯一标识。
`task_id`	string	创建成功的离线任务唯一标识，后续用于查询、更新或删除任务。

鉴权说明补充

鉴权说明

示例中的 Authorization: HMAC-SHA256 *** 不是固定 Token。请从火山引擎控制台“密钥管理”获取 AK/SK，并根据 HTTP 方法、URI、查询参数、规范化请求头和请求体摘要生成 HMAC-SHA256 签名。完整步骤参见API 签名调用指南。使用官方 SDK 时由 SDK 自动完成签名，不要在代码或文档中写入真实密钥。

错误处理补充

返回结构补充

字段	类型	含义
`code`	int	业务状态码；成功时为 0。
`message`	string	状态说明或错误信息。
`request_id`	string	请求唯一标识，用于问题排查。
`data`	object / array	接口业务数据；没有业务数据时可为空。

错误码

本接口的业务错误码、触发条件和处理建议统一参见向量库 V1 错误码。排查时请保留响应中的 request_id。

最近更新时间：2026.09.08 15:30:03

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

请求参数 #

返回值 #

返回说明补充 #

返回参数补充 #

返回说明补充 #

返回参数补充 #

鉴权说明补充 #

鉴权说明 #

错误处理补充 #

返回结构补充 #

错误码 #

请求参数

返回值

返回说明补充

返回参数补充

返回说明补充

返回参数补充

鉴权说明补充

鉴权说明

错误处理补充

返回结构补充

错误码