文档首页> 工单管理> API参考> API v2(推荐)> 智能客服> 提问(在制定的会话中)
更新时间:2023-12-18 GMT+08:00

提问(在制定的会话中)

功能介绍

提问(在制定的会话中)

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v2/irobot/sessions/{session_id}/ask

表1 路径参数

参数

是否必选

参数类型

描述

session_id

String

会话Id

最小长度:1

最大长度:64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度:1

最大长度:5000

x-service-key

String

调用智能客服服务标志。

最小长度:1

最大长度:32

x-site

String

站点标记,0-中国站 1-国际站

最小长度:0

最大长度:1

x-language

String

区域语言简写,en-us zh-cn

最小长度:0

最大长度:32

表3 请求Body参数

参数

是否必选

参数类型

描述

question

String

用户输入问题

最小长度:1

最大长度:1000

domain

String

问答领域

最小长度:0

最大长度:65535

top

Integer

最大返回数据条数

最小值:1

最大值:10

themes

Array of RelationTheme objects

主题列表

数组长度:0 - 10

source_qa_pair_id

String

语料ID

最小长度:0

最大长度:64

chat_enable

Boolean

是否需要兜底

product_type_id

String

产品类型Id

最小长度:0

最大长度:64

表4 RelationTheme

参数

是否必选

参数类型

描述

theme_name

String

主题

最小长度:0

最大长度:65535

relation_type

String

  • NON_PRIMARY: 主主题

  • PRIMARY:

枚举值:

  • NON_PRIMARY

  • PRIMARY

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

answers

Array of AnswerQaPair objects

答案列表

数组长度:0 - 9223372036854775807

error_code

String

错误码

最小长度:0

最大长度:32

error_msg

String

错误描述

最小长度:0

最大长度:32

answer_type

Integer

答案类型:0 知识库回复,1 技能回复,2 闲聊回复,3 华为云答案。

最小值:0

最大值:10

request_id

String

请求Id

最小长度:0

最大长度:65535

表6 AnswerQaPair

参数

参数类型

描述

score

Double

相似度得分

最小值:0

最大值:1

answer

String

答案

最小长度:0

最大长度:9223372036854775807

domain

String

主题

最小长度:0

最大长度:65535

link

String

链接

最小长度:0

最大长度:65535

question

String

问题

最小长度:0

最大长度:65535

qa_pair_id

String

语料Id

最小长度:0

最大长度:65535

relevance_details

Array of RelevanceQapair objects

相关问题详情列表

数组长度:0 - 65535

task_complete

Boolean

技能意图识别是否结束

表7 RelevanceQapair

参数

参数类型

描述

link

String

链接

最小长度:0

最大长度:65535

question

String

标准问题

最小长度:0

最大长度:9223372036854775807

qa_pair_id

String

标准问题Id

最小长度:0

最大长度:64

请求示例

POST https://{endpoint}/v2/irobot/sessions/session-id/ask

{
  "question" : "ECS如何购买",
  "domain" : "domain"
}

响应示例

状态码: 200

成功返回200

{
  "answer_type" : 0,
  "request_id" : "requestId",
  "answers" : [ {
    "score" : 0.85,
    "answer" : "answer",
    "domain" : "ECS",
    "link" : "link",
    "qa_pair_id" : "pair_001",
    "question" : "问题",
    "task_complete" : true,
    "relevance_details" : {
      "link" : "link",
      "question" : "标准问题",
      "qa_pair_id" : "pairId"
    }
  } ]
}

状态码

状态码

描述

200

成功返回200

错误码

请参见错误码