文档

DescribeIntent - 意图-详情

更新时间:

返回指定意图的 meta 信息,如:意图类型、意图名称、创建时间、修改时间等。

调试

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

授权信息

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

请求参数

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

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

ac627989eb4f8a98ed05fd098bbae5_p_beebot_public
InstanceIdstring

机器人 ID

chatbot-cn-yjzbyrEvqd
IntentIdlong

意图 ID

123

返回参数

名称类型描述示例值
object

返回值

RequestIdstring

请求唯一标识

a22afaf2adfasf2gr345fga45ada
IntentIdlong

意图 ID

84243341
IntentNamestring

意图名称

查天气意图
AliasNamestring

意图别名

查天气意图
SlotInfosobject []

意图关联的槽位信息

SlotIdstring

槽位唯一标识

aa4d2a343a3ad4afad
Namestring

槽位名称

天气
Valuestring

槽位划词结果

天气
Interactiveboolean

是否交互式填槽,默认为 false

false
Arrayboolean

是否数组

false
Encryptboolean

是否敏感

false
CreateTimestring

创建时间(UTC 时间)

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

修改时间(UTC 时间)

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

创建人唯一标识

123231
CreateUserNamestring

创建人名称

test
ModifyUserIdstring

修改人唯一标识

123231
ModifyUserNamestring

修改人名称

test

示例

正常返回示例

JSON格式

{
  "RequestId": "a22afaf2adfasf2gr345fga45ada",
  "IntentId": 84243341,
  "IntentName": "查天气意图",
  "AliasName": "查天气意图",
  "SlotInfos": [
    {
      "SlotId": "aa4d2a343a3ad4afad",
      "Name": "天气",
      "Value": "天气",
      "Interactive": false,
      "Array": false,
      "Encrypt": false
    }
  ],
  "CreateTime": "2021-08-12T16:00:01Z",
  "ModifyTime": "2021-08-12T16:00:01Z",
  "CreateUserId": "123231",
  "CreateUserName": "test",
  "ModifyUserId": "123231",
  "ModifyUserName": "test"
}

错误码

HTTP status code错误码错误信息
400BusinessErrorIntentId.NotExistsThe business error IntentId is not exists.

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

  • 本页导读 (0)