开发者文档
智齿科技
2024-09-09
目录

大模型机器人API

# 大模型机器人

# 1、 问答-流式

POST http://api-c.soboten.com/text/ai-agent-open/ask/answer

Body 请求参数

{
  "question": "string",
  "show_question": "string",
  "input_type_enum": "INPUT",
  "biz_id": "string",
  "biz_type": "TEXT",
  "biz_type_id": "string",
  "robotid": "string",
  "uid": "string",
  "user_name": "string",
  "transfer": true,
  "ai_agent_cid": "string",
  "call_back_url": "string",
  "source_enum": "PC",
  "partnerid": "string",
  "params": {
    "key": {}
  },
  "multi_params": {
    "key": {}
  },
  "timing": "false",
  "input_variable_infos": [
    {
      "variable_id": "string",
      "variable_name": "string",
      "variable_value": "string",
      "variable_type": "CHARACTER"
    }
  ],
  "process_info": {
    "process_id": "string",
    "node_id": "string",
    "variable_id": "string",
    "variable_value": "string"
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

# 请求参数

名称 位置 类型 必选 说明
body body RobotAnswerReqVo 是

返回示例

成功

# 返回结果

参数 类型 必填 描述
ret_code String 是 返回编码
ret_msg String 是 返回信息
data Object 否 返回对象

# 返回data数据结构

类型 必选 约束 中文名 说明
RobotAnswerRespVo yes none none

# 2、GET 问答-访客端初始化

GET http://api-c.soboten.com/text/ai-agent-open/ask/ask_init

# 请求参数

名称 位置 类型 必选 说明
robotid query string 是 none
bizid query string 是 none

返回示例

成功

{
  "data": {
    "bizid": "",
    "ai_agent_cid": "",
    "biz_type": "",
    "biz_typeid": ""
  },
  "retCode": "",
  "retMsg": ""
}
1
2
3
4
5
6
7
8
9
10

# 返回结果

参数 类型 必填 描述
ret_code String 是 返回编码
ret_msg String 是 返回信息
data Object 否 返回对象

# 返回data数据结构

类型 必选 约束 中文名 说明
InitRespVo yes none none

# 3、POST 问答-非流式

POST http://api-c.soboten.com/text/ai-agent-open/ask/answer_no_stream

Body 请求参数

{
  "question": "string",
  "show_question": "string",
  "input_type_enum": "INPUT",
  "biz_id": "string",
  "biz_type": "TEXT",
  "biz_type_id": "string",
  "robotid": "string",
  "uid": "string",
  "user_name": "string",
  "transfer": true,
  "ai_agent_cid": "string",
  "call_back_url": "string",
  "source_enum": "PC",
  "partnerid": "string",
  "params": {
    "key": {}
  },
  "multi_params": {
    "key": {}
  },
  "timing": "false",
  "input_variable_infos": [
    {
      "variable_id": "string",
      "variable_name": "string",
      "variable_value": "string",
      "variable_type": "CHARACTER"
    }
  ],
  "process_info": {
    "process_id": "string",
    "node_id": "string",
    "variable_id": "string",
    "variable_value": "string"
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

# 请求参数

名称 位置 类型 必选 说明
body body OpenRobotAnswerReqVo 是 none

返回示例

成功

{
  "data": [
    {
      "robot_answer_type": "",
      "robot_answer_message_type": "",
      "answer": "",
      "transfer_result": "",
      "roundid": "",
      "msgid": "",
      "ai_agent_cid": "",
      "biz_id": "",
      "robot_name": "",
      "robot_logo": "",
      "robotid": "",
      "robot_status": "",
      "delay": 0,
      "output_variable_infos": [
        {
          "variable_id": "",
          "variable_name": "",
          "variable_value": "",
          "variable_type": ""
        }
      ],
      "process_id": "",
      "node_id": "",
      "variable_id": "",
      "variable_value_enums": [
        ""
      ]
    }
  ],
  "retCode": "",
  "retMsg": ""
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

# 返回结果

参数 类型 必填 描述
ret_code String 是 返回编码
ret_msg String 是 返回信息
data Object 否 返回对象

# 返回data数据结构

类型 必选 约束 中文名 说明
RobotAnswerRespVo yes none none

# 4、POST 问答-分词联想

POST http://api-c.soboten.com/text/ai-agent-open/ask/answer_suggest

Body 请求参数

{
  "question": "string",
  "show_question": "string",
  "input_type_enum": "INPUT",
  "biz_id": "string",
  "biz_type": "TEXT",
  "biz_type_id": "string",
  "robotid": "string",
  "uid": "string",
  "user_name": "string",
  "transfer": true,
  "ai_agent_cid": "string",
  "call_back_url": "string",
  "source_enum": "PC",
  "partnerid": "string",
  "params": {
    "key": {}
  },
  "multi_params": {
    "key": {}
  },
  "timing": "false",
  "input_variable_infos": [
    {
      "variable_id": "string",
      "variable_name": "string",
      "variable_value": "string",
      "variable_type": "CHARACTER"
    }
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

# 请求参数

名称 位置 类型 必选 说明
body body RobotAnswerReqVo 是 none

返回示例

成功

{
  "data": {
    "qa_contents": [
      {
        "question": "",
        "questionid": "",
        "docid": "",
        "score": 0
      }
    ]
  },
  "retCode": "",
  "retMsg": ""
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

# 返回结果

参数 类型 必填 描述
ret_code String 是 返回编码
ret_msg String 是 返回信息
data Object 否 返回对象

# 返回data数据结构

类型 必选 约束 中文名 说明
RobotAnswerSuggestRespVo yes none none

# 5、POST 问答-异步

POST http://api-c.soboten.com/text/ai-agent-open/ask/answer_with_call_back

Body 请求参数

{
  "question": "string",
  "show_question": "string",
  "input_type_enum": "INPUT",
  "biz_id": "string",
  "biz_type": "TEXT",
  "biz_type_id": "string",
  "robotid": "string",
  "uid": "string",
  "user_name": "string",
  "transfer": true,
  "ai_agent_cid": "string",
  "call_back_url": "string",
  "source_enum": "PC",
  "partnerid": "string",
  "params": {
    "key": {}
  },
  "multi_params": {
    "key": {}
  },
  "timing": "false",
  "input_variable_infos": [
    {
      "variable_id": "string",
      "variable_name": "string",
      "variable_value": "string",
      "variable_type": "CHARACTER"
    }
  ],
  "process_info": {
    "process_id": "string",
    "node_id": "string",
    "variable_id": "string",
    "variable_value": "string"
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

# 请求参数

名称 位置 类型 必选 说明
body body RobotAnswerReqVo 是 none

返回示例

成功

{
  "data": {},
  "retCode": "",
  "retMsg": "",
  "pageNo": 0,
  "pageCount": 0,
  "totalCount": 0,
  "pageSize": 0
}
1
2
3
4
5
6
7
8
9

# 返回结果

参数 类型 必填 描述
ret_code String 是 返回编码
ret_msg String 是 返回信息
data Object 否 返回对象

# 6、GET 会话结束

GET http://api-c.soboten.com/text/ai-agent-open/ask/end_session

# 请求参数

名称 位置 类型 必选 说明
ai_agent_cid query string 是 none

返回示例

成功

{
  "data": {},
  "ret_code": "",
  "ret_msg": ""
}
1
2
3
4
5

# 返回结果

参数 类型 必填 描述
ret_code String 是 返回编码
ret_msg String 是 返回信息
data Object 否 返回对象

# 7、GET 轮询超时消息

GET http://api-c.soboten.com/text/ai-agent-open/ask/get_push_info

# 请求参数

名称 位置 类型 必选 说明
msgid query string 是 none

返回示例

成功

{
  "data": {
    "msgid": "",
    "data": {
      "msgid": "",
      "bizid": "",
      "ai_agent_cid": "",
      "round_id": "",
      "msg": "",
      "source_enum": "",
      "uid": "",
      "polling_id": "",
      "polling_status": ""
    },
    "bizid": "",
    "push_type": ""
  },
  "retCode": "",
  "retMsg": ""
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

# 返回结果

参数 类型 必填 描述
ret_code String 是 返回编码
ret_msg String 是 返回信息
data Object 否 返回对象

# 返回data数据结构

类型 必选 约束 中文名 说明
PushInfo yes none none

# 7、流式接口解析方式

  1. 判断robotAnswerMessageType字段 ERROR_END为会话异常结束 MESSAGE为消息解析，取answer字段即可，msgId为消息id，和下面的回答信息对应 ANSWER_INFO和PROCESS_INFO为回答信息解析，answer和其余字段均需解析，其中answer无值则无需解析
  2. 判断robotAnswerType字段，在ANSWER_INFO和PROCESS的情况下，该字段目前用于转人工按钮显示，后续可能会有别的作用
  3. 判断transferResult字段，在ANSWER_INFO和PROCESS的情况下，该字段用于判断是否需要转人工
  4. 判断delay字段，在ANSWER_INFO和PROCESS的情况下，该字段大于0，则开启轮询节点超时

# 8、任务流程中按钮消息交互

  1. 流程中变量设置为枚举类型
  2. 机器人问答接口出参RobotAnswerRespVo会返回枚举相关数据(process_id,node_id,variable_id,variable_value_enums)
  3. 当选择枚举中某个值后，需要机器人问答接口入参RobotAnswerReqVo增加枚举数据process_info(process_id对应步骤2的process_id,node_id对应步骤2的node_id,variable_id对应步骤2的variable_id,variable_value对应步骤2的variable_value_enums某个值)，input_type_enum设置为PROCESS_CLICK

# 数据模型

# PushInfo

{
  "msgid": "string",
  "data": {},
  "bizid": "string",
  "push_type": "SESSION_OVER_TIME"
}
1
2
3
4
5
6
7

# 属性

名称 类型 必选 约束 中文名 说明
msg_id string yes none 消息id
data Object yes none 消息
bizid string yes none 业务id
push_type string yes none 消息类型

# PushData格式

{
      "msgid": "",
      "bizid": "",
      "ai_agent_cid": "",
      "round_id": "",
      "msg": "",
      "source_enum": "",
      "uid": "",
      "polling_id": "",
      "polling_status": ""
}
1
2
3
4
5
6
7
8
9
10
11

# 属性

名称 类型 必选 约束 中文名 说明
msgid string yes none 消息id
bizid string yes none 业务id
ai_agent_cid string yes none 大模型机器人会话id
round_id string yes none 轮次id
msg string false none 消息
source_enum string yes none 来源
uid string false none 访客id
polling_id string yes none 轮询id
polling_status string yes none 轮询状态

# 枚举值

属性 值 说明
push_type SESSION_OVER_TIME 会话超时，data格式
push_type NODE_OVER_TIME 节点超时，data格式
push_type ROBOT_ANSWER 推送答案，data数据为List
polling_status POLLING_START 开始
polling_status POLLING_RUNNING 进行中
polling_status POLLING_END 结束

# RobotAnswerReqVo

{
  "question": "string",
  "show_question": "string",
  "input_type_enum": "INPUT",
  "biz_id": "string",
  "biz_type": "TEXT",
  "biz_type_id": "string",
  "robotid": "string",
  "uid": "string",
  "user_name": "string",
  "transfer": true,
  "ai_agent_cid": "string",
  "call_back_url": "string",
  "source_enum": "PC",
  "partnerid": "string",
  "params": {
    "key": {}
  },
  "multi_params": {
    "key": {}
  },
  "timing": "false",
  "input_variable_infos": [
    {
      "variable_id": "string",
      "variable_name": "string",
      "variable_value": "string",
      "variable_type": "CHARACTER"
    }
  ],
  "process_info": {
    "process_id": "string",
    "node_id": "string",
    "variable_id": "string",
    "variable_value": "string"
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

# 属性

名称 类型 必选 约束 中文名 说明
question string yes none 问题
show_question string yes none 展示问题
input_type_enum string yes none 输入类型
biz_id string yes none 业务id
biz_type string yes none 业务线类型
biz_type_id string yes none 产品id
robotid string yes none 机器人id
uid string false none 访客id
user_name string false none 访客姓名
transfer boolean false none 是否开启转人工
ai_agent_cid string false none AiAgent会话id
call_back_url string false none 回调地址
source_enum string yes none 渠道来源
partnerid string false none 对接id
params Map<String,Object> false none 自定义参数
multi_params Map<String,Object> false none 自定义参数
timing boolean false none 是否开启外部定时
input_variable_infos OpenAnswerVariableInfo false none 外部传入变量
process_info OpenProcessInfo false none 枚举变量点击信息

# 枚举值

属性 值 说明
input_type_enum INPUT 普通输入
input_type_enum CLICK 点击输入
input_type_enum PROCESS_CLICK 任务流程点击输入
input_type_enum WELCOME 获取欢迎语
biz_type AI_AGENT 大模型机器人本身
source_enum PC 桌面
source_enum weChat 微信
source_enum APP sdk
source_enum weiBo 微博
source_enum wap h5
source_enum huJiao 呼叫
source_enum workOrder 工单
source_enum uCenter 客户中心
source_enum qiYeWeixin 企业微信
source_enum miniApp 小程序
source_enum baiDu 百度
source_enum touTiao 淘宝
source_enum qihu360 奇虎360
source_enum wolongShenMa
source_enum sougou 搜狗
source_enum wxkf 微信客服
source_enum guangDianTong
source_enum zhihu
source_enum fb
source_enum whatsApp
source_enum instagram
source_enum line
source_enum discord
source_enum telegram
source_enum shopify
source_enum twitter

# AnswerVariableInfo

{
  "variable_id": "string",
  "variable_name": "string",
  "variable_value": "string",
  "variable_code": "string",
  "variable_type": "CHARACTER"
}
1
2
3
4
5
6
7
8

# 属性

名称 类型 必选 约束 中文名 说明
variable_id string yes none 变量id
variable_name string yes none 变量名称
variable_value string yes none 变量值
variable_code string yes none 变量编码
variable_type string yes none 变量类型(1:字符, 2:数字, 3:枚举)

# 枚举值

属性 值 说明
variable_type CHARACTER 字符
variable_type NUMBER 数字
variable_type ENUMERATION 枚举

# OpenProcessInfo

{
  "process_id": "string",
  "node_id": "string",
  "variable_id": "string",
  "variable_value": "string"
}
1
2
3
4
5
6
7

# 属性

名称 类型 必选 约束 中文名 说明
variable_id string yes none 变量id
process_id string yes none 流程id
variable_value string yes none 变量值
node_id string yes none 节点id

# QaInfo

{
  "question": "string",
  "questionid": "string",
  "docid": "string",
  "score": 0
}
1
2
3
4
5
6
7

# 属性

名称 类型 必选 约束 中文名 说明
question string yes none 标问
questionId string yes none 标问id
docId string yes none 词条id
score number yes none 匹配阈值

# RobotAnswerSuggestRespVo

{
  "qa_contents": [
    {
      "question": "string",
      "questionid": "string",
      "docid": "string",
      "score": 0
    }
  ]
}
1
2
3
4
5
6
7
8
9
10
11

# 属性

名称 类型 必选 约束 中文名 说明
qaContents QaInfo yes none 分词联想列表

# RobotAnswerRespVo

{
  "robot_answer_type": "QA_DIRECT",
  "robot_answer_message_type": "MESSAGE",
  "answer": "string",
  "transfer_result": "NO_ACTION",
  "roundid": "string",
  "msgid": "string",
  "ai_agent_cid": "string",
  "biz_id": "string",
  "robot_name": "string",
  "robot_logo": "string",
  "robotid": "string",
  "robot_status": "DELETE",
  "delay": 0,
  "output_variable_infos": [
    {
      "variable_id": "string",
      "variable_name": "string",
      "variable_value": "string",
      "variable_code": "string",
      "variable_type": "CHARACTER"
    }
  ],
  "process_id": "string",
  "node_id": "string",
  "variable_id": "string",
  "variable_value_enums": [
    "string"
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

# 属性

名称 类型 必选 约束 中文名 说明
robot_answer_type string yes none 回答类型
robot_answer_message_type string yes none 消息类型
answer string false none 答案
transfer_result string false none 转人工结果
roundid string yes none 消息轮次id
msgid string yes none 消息id
ai_agent_cid string yes none AiAgent会话id
biz_id string yes none 业务id
robot_name string yes none 机器人名称
robot_logo string yes none 机器人logo
robotid string yes none 机器人id
robot_status string yes none 机器人状态
delay integer yes none 节点延时
output_variable_infos AnswerVariableInfo false none 返回收集变量
process_id string false none 流程id
node_id string false none 节点id
variable_id string false none 变量id
variable_value_enums array false none 枚举列表

# 枚举值

属性 值 说明
robot_answer_type QA_DIRECT 直接回答
robot_answer_type DOCUMENT_DIRECT 文档直接回答
robot_answer_type PROCESS 流程开始
robot_answer_type PROCESS_DOING 流程进行中
robot_answer_type PROCESS_DOING_UNKOW 任务流程进行中命中未知回答
robot_answer_type PROCESS_DOING_LLM 任务流程进行中提示语由大模型生成
robot_answer_type PROCESS_DOING_QA_GENERAL 任务流程进行中命中通识
robot_answer_type PROCESS_DOING_CLEAR 任务流程进行中流程澄清
robot_answer_type PROCESS_DOING_SLOT_CLEAR 任务流程进行中槽值澄清
robot_answer_type PROCESS_DOING_QA_DIRECT 任务流程进行中命中QA直接回答
robot_answer_type PROCESS_DOING_DOCUMENT_DIRECT 任务流程进行中命中文档直接回答
robot_answer_type PROCESS_ERROR 任务流程_异常
robot_answer_type PROCESS_VALUE_ERROR 未获取到变量枚举值
robot_answer_type PROCESS_END 任务流程结束
robot_answer_type TRANSFER_INTENTION 转人工意图
robot_answer_type UNKNOWN 未知回答
robot_answer_type GENERAL 通识回答
robot_answer_message_type MESSAGE 消息解析
robot_answer_message_type ANSWER_INFO 回答解析
robot_answer_message_type ERROR 解析错误
robot_answer_message_type ERROR_END 会话已终止
robot_answer_message_type PROCESS_INFO 流程解析
transfer_result NO_ACTION 不转人工
transfer_result KEY_WORD 关键词转人工
transfer_result GPT_TRANSFER 意图转人工
transfer_result REPEAT 重复提问转人工
transfer_result NEGATIVE_EMOTIONS 情绪负向转人工
transfer_result MUCH_UNKNOWN 多次未知转人工
transfer_result PROCESS_NODE_TRANSFER 流程节点转人工
robot_status DELETE 大模型机器人已被删除
robot_status ENABLE 大模型机器人正常
robot_status EXPIRE 大模型机器人已过期停用
robot_status EXHAUST 大模型机器人问答量已用完

# InitRespVo

{
  "bizId": "string",
  "aiAgentCid": "string",
  "bizType": "TEXT",
  "bizTypeId": "string"
}
1
2
3
4
5
6
7

# 属性

名称 类型 必选 约束 中文名 说明
bizId string¦null false none 业务id
aiAgentCid string¦null false none 当前会话id
bizType string¦null false none 业务线类型
bizTypeId string¦null false none 产品id

# 枚举值

属性 值 说明
bizType AI_AGENT 大模型机器人
上次更新: 2024/12/26 19:58:16

←

最近更新
01
运营支持 API
03-03
02
CRM 对接方案
12-05
03
LINE API
06-25
更多文章>
Theme by Vdoing