全部产品
存储与CDN 数据库 域名与网站(万网) 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 钉钉智能硬件

会话

更新时间:2017-10-23 13:33:45

会话接口

描述

根据机器人实例ID与其进行会话。

请求参数

名称 类型 是否必须 描述
Action String 系统规定参数,取值:Chat
InstanceId String 机器人实例ID
Utterance String 机器人访问者的输入
SessionId String 会话ID,用于标识一个访问者的会话和保持上下文信息。
对于一个新的访问者,首次调用Chat接口时无需传递此字段,机器人会开启一个会话,并在Chat接口的响应中返回该会话的SessionId。
对于该访问者的后续轮次的会话,调用Chat接口时传递当前会话的SessionId,机器人即可基于SessionId继续该轮次会话。
KnowledgeId String 知识库词条的关联问题的ID。若指定此ID,那么机器人会直接返回指定的关联问题的答案
SenderId String 访问者ID。用于识别当前会话中的用户
SenderNick String 当前会话中访问的昵称

返回参数

名称 类型 描述
MessageId String 本条会话应答消息的ID
SessionId String 本次会话的ID
Messages Array of Message 消息的列表

Message

名称 类型 描述
Type String 本条消息的类型 Text=文本,Recommend=知识库关联问题推荐,Knowledge=知识库关联问题
Text Text 当Type为Text时,此字段包含机器人返回的Text对象
Knowledge Knowledge 当Type为Knowledge时,此字段包含机器人返回的Knowledge对象
Recommends Array of Recommend 当Type为Recommend时,此字段包含机器人返回的Recommend的列表

Text

名称 类型 描述
Content String 文本消息的内容
AnswerSource String 答案来源,KnowledgeBase=知识库,BotFramework,ChitChat=未命中知识库或BotFramework时的闲聊

Knowledge

名称 类型 描述
Id String 知识库中的关联问题ID
Title String 关联问题的标题
Summary String 关联问题的简介
Content String 关联问题的内容

Recommend

名称 类型 描述
KnowledgeId String 知识库中的关联问题的ID
Title 知识库中的关联问题的标题 String

错误码

错误代码 Http状态码 描述
InvalidInstanceId.NotFound 404 指定的InstanceId不存在
InvalidParameter 400 参数不合法
InternalError 500 内部错误

示例

请求示例

  1. https://chatbot.cn-shanghai.aliyuncs.com/?Action=Chat
  2. &InstanceId=<InstanceId>
  3. &Utterance=<Utterance>
  4. &SenderId=<SenderId>
  5. %SenderNick=<SenderNick>
  6. &<公共请求参数>

返回示例

XML格式

  1. <ChatResponse>
  2. <RequestId>F2E2C40D-AB09-45A1-B5C5-EB9F5C4E4E4A</RequestId>
  3. <MessageId>cbf0a754ad3041fe9f1df91708aaf3b9</MessageId>
  4. <SessionId>45cf4e6e066f4f27a622c195ac666c43</SessionId>
  5. <Messages>
  6. <Message>
  7. <Type>Text</Type>
  8. <Text>
  9. <Content>你好</Content>
  10. <AnswerSource>ChitChat</AnswerSource>
  11. </Text>
  12. </Message>
  13. <Message>
  14. <Type>Knowledge</Type>
  15. <Knowledge>
  16. <Id>64</Id>
  17. <Title>Title of knowledge</Title>
  18. <Summary>Summary of knowledge</Summary>
  19. <Content>Content of knowledge</Content>
  20. </Knowledge>
  21. </Message>
  22. <Message>
  23. <Type>Recommend</Type>
  24. <Recommends>
  25. <Recommend>
  26. <KnowledgeId>64</KnowledgeId>
  27. <Title>Title of knowledge</Title>
  28. </Recommend>
  29. </Recommends>
  30. </Message>
  31. </Messages>
  32. </ChatResponse>

JSON格式

  1. {
  2. "RequestId" : "F2E2C40D-AB09-45A1-B5C5-EB9F5C4E4E4A",
  3. "MessageId" : "cbf0a754ad3041fe9f1df91708aaf3b9",
  4. "SessionId" : "45cf4e6e066f4f27a622c195ac666c43",
  5. "Messages" : [
  6. "Message" : {
  7. "Type" : "Text",
  8. "Text" : {
  9. "Content" : "你好",
  10. "AnswerSource" : "ChitChat"
  11. }
  12. },
  13. "Message" : {
  14. "Type" : "Knowledge",
  15. "Recommends" : {
  16. "Id" : "64",
  17. "Title" : "Title of knowledge",
  18. "Summary" : "Summary of knowledge",
  19. "Content" : "Content of knowledge"
  20. }
  21. },
  22. "Message" : {
  23. "Type" : "Recommend",
  24. "Recommends" : [
  25. "Recommend" : {
  26. "KnowledgeId" : "64",
  27. "Title" : "Title of knowledge"
  28. }
  29. ]
  30. }
  31. ]
  32. }
本文导读目录