向量数据库 delete-SDK 参考-文档中心-腾讯云

功能介绍
/document/delete 接口用于删除指定  id（Document ID）的文档，且支持设置 Filter 表达式，删除满足 Filter 表达式的数据。
接口约束
索引类型为 FLAT，不支持删除。
请求示例
注意：
如下示例可直接复制，在 CVM 运行之前，您需在文本编辑器将 api_key=A5VOgsMpGWJhUI0WmUbY******************** 与 10.0.X.X 依据实际情况进行替换。 
如下示例，删除 book-emb 集合中， id（Document ID）为 0001、0002、0003，且满足 bookName?in?(\\"三国演义\\",\\"西游记\\") 的数据。
curl -i -X POST \\
  -H 'Content-Type: application/json' \\
  -H 'Authorization: Bearer account=root&api_key=A5VOgsMpGWJhUI0WmUbY********************' \\
  http://10.0.X.X:80/document/delete \\
  -d '{
    "database": "db-test",
    "collection": "book-emb",
    "query": {
        "documentIds": [
            "0001",
            "0002",
            "0003"
        ],
        "filter": "bookName in (\\"三国演义\\",\\"西游记\\")"
    }
}'
请求参数
参数名称
参数含义
子参数
是否必选
配置方法及要求
database
指定需删除文档的Database 名称。
-
是
使用 /database/list 获取集群中的数据库列表，复制需删除数据的集合所属的数据库名。
collection
指定需删除文档的Collection 名称。
-
是
使用 /collection/list 获取指定数据库名下的 Collection 列表，复制需删除数据的集合名。
query

设置查询条件。

documentIds
否
表示要删除的 Document 的 ID，可以批量删除，数据元素最大值为20。
说明：
同时配置 documentIds 与 filter 参数，删除数据将会取二者的并集。
?
?
?
filter
否
使用创建 Collection 指定的 Filter 索引的字段设置查询过滤表达式。Filter 的表达式格式为 '<field_name><operator><value>'，多个表达式之间支持 and（与）、or（或）、not（非）关系。具体信息，请参见 Filter 条件表达式。其中 
<field_name>：表示要过滤的字段名。
<operator>：表示要使用的运算符。
string ：匹配单个字符串值（=）、排除单个字符串值（!=）、匹配任意一个字符串值（in）、排除所有字符串值（not in）。其对应的 Value 必须使用英文双引号括起来。
unit64：大于（>）、大于等于（>=）、等于（==）、小于（<）、小于等于（<=）。例如：expired_time > 1623388524。
array：数组类型，包含数组元素之一（include）、排除数组元素之一（exclude）、全包含数组元素（include all）。例如，name include (\\"Bob\\", \\"Jack\\")。
<value>：表示要匹配的值。
示例：Filter('author="jerry"').And('page>20')。
响应消息
HTTP 响应消息体是服务器返回给客户端的数据，通常包含了请求的结果或者所请求的资源。/document/delete 接口返回的状态码以及相关信息，如下所示。
状态码
含义
响应消息
200
删除 Document 成功
{
    "code": 0,
    "msg": "operation success",
    "affectedCount": 2
}
说明：
删除操作执行成功，可使用 /document/query 查询该数据确认结果。示例中删除 book-emb 集合中，id 为 0001与0002 的数据，分别使用  /document/query 查询 id 为0001与0002的数据，显示 documents 为空值。结果如下所示。
{
    "code": 0,
    "msg": "operation success",
    "count": 0,
    "documents": []
}
?
400
删除 Document 失败
{
  "code": 400,
  "msg": "operation failed, reason...."
}
返回参数
参数名
参数含义
affectedCount
删除文档数量。
?

参数名称	参数含义	子参数	是否必选	配置方法及要求
database	指定需删除文档的Database 名称。	-	是	使用 /database/list 获取集群中的数据库列表，复制需删除数据的集合所属的数据库名。
collection	指定需删除文档的Collection 名称。	-	是	使用 /collection/list 获取指定数据库名下的 Collection 列表，复制需删除数据的集合名。
query	设置查询条件。	documentIds	否	表示要删除的 Document 的 ID，可以批量删除，数据元素最大值为20。说明：同时配置 documentIds 与 filter 参数，删除数据将会取二者的并集。 ?
query	设置查询条件。	?	?	filter	否	使用创建 Collection 指定的 Filter 索引的字段设置查询过滤表达式。Filter 的表达式格式为 '<field_name><operator><value>'，多个表达式之间支持 and（与）、or（或）、not（非）关系。具体信息，请参见 Filter 条件表达式。其中 <field_name>：表示要过滤的字段名。 <operator>：表示要使用的运算符。 string ：匹配单个字符串值（=）、排除单个字符串值（!=）、匹配任意一个字符串值（in）、排除所有字符串值（not in）。其对应的 Value 必须使用英文双引号括起来。 unit64：大于（>）、大于等于（>=）、等于（==）、小于（<）、小于等于（<=）。例如：expired_time > 1623388524。 array：数组类型，包含数组元素之一（include）、排除数组元素之一（exclude）、全包含数组元素（include all）。例如，name include (\\"Bob\\", \\"Jack\\")。 <value>：表示要匹配的值。示例：`Filter('author="jerry"').And('page>20')。`

参数名	参数含义
affectedCount	删除文档数量。

状态码	含义	响应消息
200	删除 Document 成功	{ "code": 0, "msg": "operation success", "affectedCount": 2 } 说明：删除操作执行成功，可使用 /document/query 查询该数据确认结果。示例中删除 book-emb 集合中，id 为 0001与0002 的数据，分别使用 /document/query 查询 id 为0001与0002的数据，显示 documents 为空值。结果如下所示。 { "code": 0, "msg": "operation success", "count": 0, "documents": [] } ?
400	删除 Document 失败	{ "code": 400, "msg": "operation failed, reason...." }

delete

本页目录：

功能介绍

接口约束

请求示例

请求参数

响应消息

返回参数