文档

ListDSEntity - 实体-列表

更新时间:

查询指定机器人下的实体列表数据,仅返回每个实体的meta信息,如:实体类型、实体名称、创建时间、修改时间等。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
AgentKeystring

业务空间 key,不设置则访问默认业务空间,key 值在主账号业务管理页面获取

ac627989eb4f8a98ed05fd098bbae5_p_beebot_public
InstanceIdstring

机器人 ID

chatbot-cn-yjzbyrEvqd
Keywordstring

筛选项,contains 匹配,范围:实体名称(未来扩展:实体成员、同义词)

实体
EntityTypestring

为空:全量自定义实体(默认)

枚举值:
  • regexregex
  • systemsystem
  • synonymssynonyms
synonyms regex system
PageNumberinteger

当前页,默认 1

1
PageSizeinteger

当前页数量,默认 10

10

返回参数

名称类型描述示例值
object

返回信息说明

RequestIdstring

请求 ID

ga4h345defgwet2sdf223
TotalCountinteger

总条数

1
PageSizeinteger

页面大小,默认 10

10
PageNumberinteger

当前页,默认 1

1
Entitiesobject []

实体列表信息

EntityIdlong

实体 ID

234564567445
EntityNamestring

实体名称

书实体
SysEntityCodestring

系统实体 code,如 sys.date;用户实体时为空

sys_date
EntityTypestring

实体类型(synonyms | regex | system)

synonyms
CreateTimestring

创建时间(UTC 时间)

2021-08-12T16:00:01Z
ModifyTimestring

修改时间(UTC 时间)

2021-08-12T16:00:01Z
CreateUserIdstring

创建人 ID

123231
CreateUserNamestring

创建人名称

test
ModifyUserIdstring

修改人 ID

123231
ModifyUserNamestring

修改人名称

test

示例

正常返回示例

JSON格式

{
  "RequestId": "ga4h345defgwet2sdf223",
  "TotalCount": 1,
  "PageSize": 10,
  "PageNumber": 1,
  "Entities": [
    {
      "EntityId": 234564567445,
      "EntityName": "书实体",
      "SysEntityCode": "sys_date",
      "EntityType": "synonyms",
      "CreateTime": "2021-08-12T16:00:01Z",
      "ModifyTime": "2021-08-12T16:00:01Z",
      "CreateUserId": "123231",
      "CreateUserName": "test",
      "ModifyUserId": "123231",
      "ModifyUserName": "test"
    }
  ]
}

错误码

HTTP status code错误码错误信息
400InvalidParameterDs.IllegalAccess.BotIdNotExists

访问错误中心查看更多错误码。

  • 本页导读 (0)