ListDSEntityValue - 实体成员-列表

更新时间:
复制 MD 格式

查询指定实体的实体成员列表及详情数据,同时支持关键词筛选(contains),筛选范围:实体值、同义词。

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值

AgentKey

string

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

ac627989eb4f8a98ed05fd098bbae5_p_beebot_public

InstanceId

string

机器人 ID

chatbot-cn-yjzbyrEvqd

EntityId

integer

实体 ID

123

EntityValueId

integer

实体成员 ID

234

Keyword

string

实体成员名称搜索关键词

PageNumber

integer

页码

1

PageSize

integer

分页大小

10

返回参数

名称

类型

描述

示例值

object

返回值信息

RequestId

string

请求唯一标识

n3fg34gbfj8adf2gj923

EntityValues

array<object>

实体列表

object

实体列表信息

EntityId

integer

实体 ID

34313785463

EntityValueId

integer

实体成员 ID

3467858234534534532

Content

string

实体成员名称(实体值或正则表达式)

书类型

Synonyms

array

同义词列表

string

同义词列表说明

小说

CreateTime

string

创建时间(UTC 时间)

2021-08-12T16:00:01Z

ModifyTime

string

修改时间(UTC 时间)

2021-08-12T16:00:01Z

TotalCount

integer

总条数

1

PageNumber

integer

当前页,默认 1

1

PageSize

integer

页面大小,默认 10

10

示例

正常返回示例

JSON格式

{
  "RequestId": "n3fg34gbfj8adf2gj923",
  "EntityValues": [
    {
      "EntityId": 34313785463,
      "EntityValueId": 3467858234534534700,
      "Content": "书类型",
      "Synonyms": [
        "小说"
      ],
      "CreateTime": "2021-08-12T16:00:01Z",
      "ModifyTime": "2021-08-12T16:00:01Z"
    }
  ],
  "TotalCount": 1,
  "PageNumber": 1,
  "PageSize": 10
}

错误码

HTTP status code

错误码

错误信息

描述

400 BusinessErrorEntityId.NotExists The business error EntityId is not exists.

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

变更历史

更多信息,参考变更详情