EntityCreate - 自定义实体
所有文档
menu

客悦智能客服专业版

EntityCreate - 自定义实体

立即使用

API访问域名

请求方式 POST
base url https://keyue.cloud.baidu.com
后缀接口 /open/v1/api/v3/entity/createEntity
Authentication token为API Key

说明

请求参数

Header参数

名称 类型 必选 中文名 说明
Content-Type string 内容类型 固定值:application/json
token string API KEY 集成-API-API Key处获取。
详细获取方式参考:准备工作
uid string 用户ID 鼠标移动至页面右上角账户头像即可获取。
详细获取方式参考:准备工作
username string 用户名 鼠标移动至页面右上角账户头像即可获取。
详细获取方式参考:准备工作

Body参数

名称 类型 必选 中文名 说明
nameZh string 实体名称
refer string 实体类型 根据实体类型接口获取Id,自定义实体类型固定值:0

响应参数

名称 类型 必选 中文名 说明
time integer 时间 1717036810964
data object 数据 数据对象,详见data子数据
code integer 状态码 200
msg string 状态信息 OK

data 子数据

名称 类型 必选 中文名 说明
id integer 唯一标识 UUID
name object 英文名 默认自动生成
nameZh integer 中文名
entries list[object] 实体值列表 详见 entries 子数据

entries 子数据

名称 类型 必选 中文名 说明
id string 实体值唯一标识 UUID
agentId string agent唯一标识 UUID
entityId string 唯一标识 UUID
value string 实体值
synonyms string 同义词
created Data 创建时间 yyyy-MM-dd HH:mm:ss
updated Data 更新时间 yyyy-MM-dd HH:mm:ss
name string 名称 英文名,默认自动生成
nameZh string 中文名称
description string 描述
refer string 引用
hasActiveCopy boolean
version integer 版本号
type integer 类型 默认为0
indexExipred boolean

请求示例

curl --location --request POST 'https://keyue.cloud.baidu.com/open/v1/api/v3/entity/createEntity' \
--header 'token: 7f3894e7-01d8-4e2e-88d0-ef437ffd3f63' \
--header 'uid: dd6283a283df42998bab14607e23f38d' \
--header 'username: ldd' \
--data '{"nameZh":"自定义实体","refer":"0"}'

响应示例

{
    "time": 1733281574227,
    "data": {
        "id": "b8ecd146-b1ec-11ef-9f00-eac266151c1e",
        "name": "Gb9dff5f",
        "nameZh": "月份1",
        "entries": [
            {
                "_effect": 1,
                "id": "390d7685-24b4-4282-9747-05699581b190",
                "agentId": "ae8b75e0-2e75-446a-b291-c6995c94c9e3",
                "entityId": "b8ecd146-b1ec-11ef-9f00-eac266151c1e",
                "value": "月",
                "synonyms": "月份",
                "created": null,
                "updated": "2024-12-04 11:06:13",
                "name": "Gb9dff5f",
                "nameZh": "月份1",
                "description": null,
                "refer": null,
                "hasActiveCopy": false,
                "version": 0,
                "type": 0,
                "indexExpired": false
            }
        ]
    },
    "code": 200,
    "msg": "OK"
}
{
    "time":1734518679473,
    "data":null,
    "code":4000175,
    "msg":"实体创建失败\r\n实体名已存在\r\n"}
上一篇
API列表
下一篇
EntityList - 查看实体列表(查询实体详情、实体值列表)