# 插入向量 - InsertEntities
#### 功能介绍
在指定的collection中插入一个或多个Entity。
#### URI
POST /v1/entities/insert
#### 请求参数
表1请求Body参数 
| 参数              | 是否必选 | 参数类型                                                       | 描述                                                                                                                                                                                                                                                                                                                                                                                                          |
|:---|:---|:---|:---|
| store_name      | 是    | String                                                     | **参数解释：** 知识仓实例名称，region内唯一。 约束限制： 长度范围为3到63个字符，支持小写字母、数字、中划线（ - ），第一个字符只能够是小写字母，中划线（ - ）不得出现在字符串末尾。 **取值范围：** 不涉及 **默认取值：** 不涉及                              |
| collection_name | 是    | String                                                     | **参数解释：** collection名称，知识仓内唯一。 **约束限制：** 长度范围为1到255个字符，支持字母、数字、中划线（ - ）和下划线（ _ ），大小写敏感。第一个字符只能够是下划线（ _ ）和字母，中划线（ - ）不得出现在字符串末尾。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
| data            | 是    | Array of [entity] objects | **参数解释：** 插入collection的entity数据。 **约束限制：** 满足插入collection的field schema。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                         |
   
 表2entity 
| 参数       | 是否必选 | 参数类型                 | 描述                                                                                                                                                                                                                                                                                                                                                                   |
|:---|:---|:---|:---|
| {自定义key} | 否    | Map\<String,Object\> | **参数解释：** collection中的一个基本结构化数据实体，包含向量和标量等字段数据。 **约束限制：** 必须满足目标collection field schema。 **取值范围：** 不涉及。 **默认取值:** 不涉及。 |
   
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数      | 参数类型                                                                          | 描述                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|
| code    | String                                                                        | **参数解释：** 返回码。参见错误码章节。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。 |
| message | String                                                                        | **参数解释：** 描述信息 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。         |
| data    | [insert_entities_data] object | **参数解释：** 响应数据。 **约束限制：** 不涉及。                                                                                                                                                                              |
   
 表4insert_entities_data 
| 参数           | 参数类型             | 描述                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|
| insert_count | Integer          | **参数解释：** 插入的entity数量。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。             |
| insert_ids   | Array of objects | **参数解释：** 插入成功的entity的primary_key。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。 |
   
**状态码：400**
表5响应Body参数 
| 参数      | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|
| code    | String | **参数解释：** 返回码。参见错误码章节。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。 |
| message | String | **参数解释：** 描述信息。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值:** 不涉及。        |
   
#### 请求示例
```
/v1/entities/insert
{
  "store_name" : "test-storename",
  "collection_name" : "test-collection",
  "data" : [ {
    "vector" : [ 0.324, 0.21, 0.2456 ],
    "scalar" : "文档1",
    "pk" : 1
  }, {
    "vector" : [ 0.333, 0.222, 0.1116 ],
    "scalar" : "文档2",
    "pk" : 2
  } ]
}
```
#### 响应示例
**状态码：200**
更新entity成功
```
{
  "code" : "LMS.00000000",
  "data" : {
    "insert_count" : 2,
    "insert_ids" : [ 1, 2 ]
  },
  "message" : "insert entities success"
}
```
**状态码：400**
entity插入失败
```
{
  "code" : "LMS.00004001",
  "message" : "ErrInvalidInsertData: Fail to deal the insert data"
}
```
#### 状态码
| 状态码 | 描述         |
|:---|:---|
| 200 | 更新entity成功 |
| 400 | entity插入失败 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-dwr/ErrorCode.html)。