文档首页/ 数据工坊 DWR/ LMS API参考/ API/ 向量entity接口/ 更新向量
更新时间：2025-09-12 GMT+08:00
查看PDF
分享

更新向量

功能介绍

在指定collection中更新Entity。如果pk列中值存在，则更新Entity，如果不存在，则插入Entity。

URI

POST /v1/entities/upsert

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

store_name

是

String

参数解释：

知识仓实例名称，region内唯一。

约束限制：

长度范围为3到63个字符，支持小写字母、数字、中划线（-），第一个字符只能够是小写字母，中划线(-)不得出现在字符串末尾。

取值范围：

不涉及

默认取值：

不涉及

collection_name

是

String

参数解释：

collection名称，知识仓内唯一。

约束限制：

长度范围为1到255个字符，支持字母、数字、中划线（-）和下划线（_），大小写敏感。第一个字符只能够是下划线（_）和字母，中划线(-)不得出现在字符串末尾。

取值范围：

不涉及。

默认取值：

不涉及。

data

是

Array of entity objects

参数解释：

更新插入collection的entity数据。

约束限制：

满足插入collection的field schema。

取值范围：

不涉及。

默认取值：

不涉及。
表2 entity

参数

是否必选

参数类型

描述

{自定义key}

否

Map<String,Object>

参数解释：

collection中的一个基本结构化数据实体，包含向量和标量等字段数据。

约束限制：

必须满足目标collection field schema。

取值范围：

不涉及。

默认取值:

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

code

String

参数解释：

返回码。参见错误码章节。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值:

不涉及。

message

String

参数解释：

描述信息

约束限制：

不涉及。

取值范围：

不涉及。

默认取值:

不涉及。

data

upsert_entities_data object

参数解释：

响应数据。

约束限制：

不涉及。
表4 upsert_entities_data

参数

参数类型

描述

upsert_count

Integer

参数解释：

更新的entity数量。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值:

不涉及。

upsert_ids

Array of objects

参数解释：

更新的entity数量。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值:

不涉及。

状态码：400

表5 响应Body参数

参数

参数类型

描述

code

String

参数解释：

返回码。参见错误码章节。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值:

不涉及。

message

String

参数解释：

描述信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值:

不涉及。

请求示例

/v1/entities/upsert

{
  "store_name" : "test-storename",
  "collection_name" : "test-collection",
  "data" : [ {
    "vector" : [ 0.324, 0.21, 0.2456 ],
    "scalar" : "文档3",
    "pk" : 3
  }, {
    "vector" : [ 0.333, 0.222, 0.1116 ],
    "scalar" : "文档4",
    "pk" : 2
  } ]
}

响应示例

状态码：200

更新entity成功

{
  "code" : "LMS.00000000",
  "data" : {
    "upsert_count" : 2,
    "upsert_ids" : [ 3, 2 ]
  },
  "message" : "upsert entities success"
}

状态码：400

entity更新失败

{
  "code" : "LMS.00001001",
  "message" : "ErrInvalidParameter: The input parameter is incorrect."
}

状态码

状态码

描述

200

更新entity成功

400

entity更新失败

错误码

请参见错误码。

父主题： 向量entity接口

相关文档