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

大模型机器人API

# 大模型机器人

# 接口声明

在调用接口时必须在 https 请求的 header 中携带 "token" 参数

Token 是智齿客服接口开放平台全局唯一的接口调用凭据。 开发者在调用各业务接口时都需使用 Token，开发者需要进行妥善保存。 Token 的存储至少要保留 32 个字符空间。Token 的有效期目前为 24 个小时，需定时刷新，或根据接口返回的 Token 失效提示，进行重新获取。请求 Token 接口，无论 Token 是否存在，都会返回新的 Token，并重置 Token 的过期时间（目前 24 小时）。

Token 使用方式说明：
1、开发者需要统一获取和管理 Token，在调用智齿客服各个业务开放接口时都应该使用同一个的 Token，不应该每个业务都刷新获取新的 Token，否则容易导致 Token 失效，影响接口的正常调用；
2、目前 Token 的有效期通过返回的 expire_in 来传达，目前是 86,400 秒之内的值。开发者需要根据这个有效时间提前去刷新新 Token。
3、开发者需要根据接口返回的 Token 失效提示，进行重新获取 Token。

# 接口调用

# ● 获取访问 Token 编码

接口说明：

获取 API 开放接口 Token，此 Token 仅适用于智齿开放平台 5.0 版本全部 API 接口 。API 接口中的参数 appid 、 app_key 请联系智齿售后人员获取。

请求方式：

GET

请求地址：

 https://www.sobot.com/api/get_token
1

请求参数：

参数 类型 必填 描述
appid String 是 接口凭证 Id，第三方用户接口调用唯一凭证 id
create_time String 是 时间戳，时间戳、秒，例如 2019-09-25 15:49:33 的时间戳1569397773
sign String 是 签名，md5(appid + create_time + app_key) sign 签名、app_key 为密钥

返回参数：

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

item 对象：

参数 类型 必填 描述
token String 是 token 编码
expires_in String 是 凭证有效时间

时间戳转换参考工具：

 http://tool.chinaz.com/Tools/unixtime.aspx
1

sign 签名生成示例：

例如，appid = "1"; create_time="1569397773"; app_key="2"

sign = Md5("115693977732") 为 258eec3118705112b2c53dc8043d4d34。

请求示例：

curl  https://www.sobot.com/api/get_token?appid=1&create_time=1569397773&sign=258eec3118705112b2c53dc8043d4d34
1

返回示例：

{
    "item": {
        "token": "4ac37cb2e9c740dba4b75a34d5358802",
        "expires_in": "86400"
    },
    "ret_code": "000000",
    "ret_msg": "操作成功"
}
1
2
3
4
5
6
7
8
# ● 问答-流式

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口获取答案，并建立会话。

请求方式：

POST

请求地址：

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

请求参数

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

OpenRobotAnswerReqVo 对象：

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

请求示例：

{
  "question": "人工客服",
  "show_question": "人工客服",
  "input_type_enum": "INPUT",
  "biz_id": "a97e877ad6b9403bbf945401ea331111",
  "biz_type": "TEXT",
  "biz_type_id": "1000016",
  "robotid": "1",
  "uid": "c56844605e72633776a6de28d0f598f3",
  "user_name": "用户名称",
  "transfer": true,
  "ai_agent_cid": "17ad7f4ab65b4aedadb3b72caf6a86cd",
  "call_back_url": "http://www.sobot.com/aiAgent/callback",
  "source_enum": "PC",
  "partnerid": "123456",
  "params": {
    "key": {}
  },
  "multi_params": {
    "key": {}
  },
  "timing": false,
  "input_variable_infos": [
    {
      "variable_id": "1888794111663644672",
      "variable_name": "变量名",
      "variable_value": "变量值",
      "variable_type": "CHARACTER"
    }
  ],
  "process_info": {
    "process_id": "5a227ca7b4fc48e98d4e02b113c81c123",
    "node_id": "1905555364410802345",
    "variable_id": "1888794111663644672",
    "variable_value": "变量值"
  }
}
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

返回示例：

成功

返回结果

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

返回data数据结构

类型 必选 约束 说明
RobotAnswerRespVo 是 none none

RobotAnswerRespVo

名称 类型 必选 说明
robot_answer_type string 是 回答类型
robot_answer_message_type string 是 消息类型
answer string 否 答案
transfer_result string 否 转人工结果
roundid string 是 消息轮次id
msgid string 是 消息id
ai_agent_cid string 是 AiAgent会话id
biz_id string 是 业务id
robot_name string 是 机器人名称
robot_logo string 是 机器人logo
robotid string 是 机器人id
robot_status string 是 机器人状态
delay integer 是 节点延时
output_variable_infos AnswerVariableInfo 否 返回收集变量
process_id string 否 流程id
node_id string 否 节点id
variable_id string 否 变量id
variable_value_enums array 否 枚举列表
{
  "data": [
    {
      "robot_answer_type": "QA_DIRECT",
      "robot_answer_message_type": "MESSAGE",
      "answer": "人工客服",
      "transfer_result": "NO_ACTION",
      "roundid": "12ef2d1957434f2eb4b45c629d2db2dc",
      "msgid": "12789cf50b784e4480a02289ddc69fb9",
      "ai_agent_cid": "12dec883b46d48a5808ea143379b7014",
      "biz_id": "29967d81d67f4a708e8bd7d8f6356447",
      "robot_name": "大模型机器人",
      "robot_logo": "",
      "robotid": "1",
      "robot_status": "DELETE",
      "delay": 0,
      "output_variable_infos": [
        {
          "variable_id": "1888794111663644672",
          "variable_name": "变量名",
          "variable_value": "变量值",
          "variable_type": "CHARACTER"
        }
      ],
      "process_id": "5a227ca7b4fc48e98d4e02b113c81c123",
      "node_id": "1905555364410802345",
      "variable_id": "1888794111663644672",
      "variable_value_enums": [
        ""
      ]
    }
  ],
  "retCode": "000000",
  "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
# ● 问答-访客端初始化

接口说明：

接口类型：主动调用接口

接口作用：调用该接口初始化访客信息，生成访客。

请求方式：

GET

请求地址：

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

参数说明：

请求参数

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

返回示例

成功

{
  "data": {
    "bizid": "a97e877ad6b9403bbf945401ea331111",
    "ai_agent_cid": "17ad7f4ab65b4aedadb3b72caf6a86cd",
    "biz_type": "AI_AGENT",
    "biz_typeid": "1000045"
  },
  "retCode": "000000",
  "retMsg": "操作成功"
}
1
2
3
4
5
6
7
8
9
10

返回结果

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

返回data数据结构

InitRespVo

类型 必选 说明
InitRespVo 是 none

属性

名称 类型 必选 说明
bizId string¦null 否 业务id
aiAgentCid string¦null 否 当前会话id
bizType string¦null 否 业务线类型
bizTypeId string¦null 否 产品id
{
  "bizId": "a97e877ad6b9403bbf945401ea331111",
  "aiAgentCid": "17ad7f4ab65b4aedadb3b72caf6a86cd",
  "bizType": "AI_AGENT",
  "bizTypeId": "1000045"
}
1
2
3
4
5
6
7
# ● 问答-非流式

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口获取答案，并建立会话。

请求方式：

POST

请求地址：

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

请求参数：

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

OpenRobotAnswerReqVo 对象：

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

Body 请求参数

{
  "question": "人工客服",
  "show_question": "人工客服",
  "input_type_enum": "INPUT",
  "biz_id": "a97e877ad6b9403bbf945401ea331111",
  "biz_type": "TEXT",
  "biz_type_id": "1000016",
  "robotid": "1",
  "uid": "c56844605e72633776a6de28d0f598f3",
  "user_name": "用户名称",
  "transfer": true,
  "ai_agent_cid": "17ad7f4ab65b4aedadb3b72caf6a86cd",
  "call_back_url": "http://www.sobot.com/aiAgent/callback",
  "source_enum": "PC",
  "partnerid": "123456",
  "params": {
    "key": {}
  },
  "multi_params": {
    "key": {}
  },
  "timing": false,
  "input_variable_infos": [
    {
      "variable_id": "1888794111663644672",
      "variable_name": "变量名",
      "variable_value": "变量值",
      "variable_type": "CHARACTER"
    }
  ],
  "process_info": {
    "process_id": "5a227ca7b4fc48e98d4e02b113c81c123",
    "node_id": "1905555364410802345",
    "variable_id": "1888794111663644672",
    "variable_value": "变量值"
  }
}
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

返回示例

成功

返回结果

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

返回data数据结构

类型 必选 约束 说明
RobotAnswerRespVo 是 none none
{
  "data": [
    {
      "robot_answer_type": "QA_DIRECT",
      "robot_answer_message_type": "MESSAGE",
      "answer": "人工客服",
      "transfer_result": "NO_ACTION",
      "roundid": "12ef2d1957434f2eb4b45c629d2db2dc",
      "msgid": "12789cf50b784e4480a02289ddc69fb9",
      "ai_agent_cid": "12dec883b46d48a5808ea143379b7014",
      "biz_id": "29967d81d67f4a708e8bd7d8f6356447",
      "robot_name": "大模型机器人",
      "robot_logo": "",
      "robotid": "1",
      "robot_status": "DELETE",
      "delay": 0,
      "output_variable_infos": [
        {
          "variable_id": "1888794111663644672",
          "variable_name": "变量名",
          "variable_value": "变量值",
          "variable_type": "CHARACTER"
        }
      ],
      "process_id": "5a227ca7b4fc48e98d4e02b113c81c123",
      "node_id": "1905555364410802345",
      "variable_id": "1888794111663644672",
      "variable_value_enums": [
        ""
      ]
    }
  ],
  "retCode": "000000",
  "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
# ● 问答-分词联想

接口说明：

接口类型：主动调用接口

接口作用：客户通过此接口可以提前获取知识库中的标问。

请求方式：

POST

请求地址：

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

Body 请求参数

请求参数

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

OpenRobotAnswerReqVo 对象：

名称 类型 必选 说明
question string 是 问题
show_question string 是 展示问题
input_type_enum string 是 输入类型
biz_id string 是 业务id
biz_type string 是 业务线类型
biz_type_id string 是 产品id
robotid string 是 机器人id
uid string 否 访客id
user_name string 否 访客姓名
transfer boolean 否 是否开启转人工
ai_agent_cid string 否 AiAgent会话id
call_back_url string 否 回调地址
source_enum string 是 渠道来源
partnerid string 否 对接id
params Map<String,Object> 否 自定义参数
multi_params Map<String,Object> 否 自定义参数
timing boolean 否 是否开启外部定时
input_variable_infos OpenAnswerVariableInfo 否 外部传入变量
process_info OpenProcessInfo 否 枚举变量点击信息
{
  "question": "人工客服",
  "show_question": "人工客服",
  "input_type_enum": "INPUT",
  "biz_id": "29967d81d67f4a708e8bd7d8f6356447",
  "biz_type": "TEXT",
  "biz_type_id": "1000016",
  "robotid": "1",
  "uid": "c56844605e72633776a6de28d0f598f3",
  "user_name": "用户名称",
  "transfer": true,
  "ai_agent_cid": "12dec883b46d48a5808ea143379b7014",
  "call_back_url": "http://www.sobot.com/aiAgent/callback",
  "source_enum": "PC",
  "partnerid": "123456",
  "params": {
    "key": {}
  },
  "multi_params": {
    "key": {}
  },
  "timing": false,
  "input_variable_infos": [
    {
      "variable_id": "1888794111663644672",
      "variable_name": "变量名",
      "variable_value": "变量值",
      "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

返回示例

成功

返回结果

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

返回data数据结构

类型 必选 约束 说明
RobotAnswerSuggestRespVo 是 none none
{
  "data": {
    "qa_contents": [
      {
        "question": "人工客服",
        "questionid": "dda6a07ef5b74642a601102095d1681a",
        "docid": "e3e8a0a11f27496a8448ced8a7ba392d",
        "score": 0
      }
    ]
  },
  "retCode": "000000",
  "retMsg": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
# ● 问答-异步

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口异步的方式返回机器人答案。

请求方式：

POST

请求地址：

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

Body 请求参数

请求参数

名称 位置 类型 必选 说明
body body RobotAnswerReqVo 是 none
{
  "question": "人工客服",
  "show_question": "人工客服",
  "input_type_enum": "INPUT",
  "biz_id": "29967d81d67f4a708e8bd7d8f6356447",
  "biz_type": "TEXT",
  "biz_type_id": "1000016",
  "robotid": "1",
  "uid": "c56844605e72633776a6de28d0f598f3",
  "user_name": "用户名称",
  "transfer": true,
  "ai_agent_cid": "12dec883b46d48a5808ea143379b7014",
  "call_back_url": "http://www.sobot.com/aiAgent/callback",
  "source_enum": "PC",
  "partnerid": "123456",
  "params": {
    "key": {}
  },
  "multi_params": {
    "key": {}
  },
  "timing": "false",
  "input_variable_infos": [
    {
      "variable_id": "1888794111663644672",
      "variable_name": "变量名",
      "variable_value": "变量值",
      "variable_type": "CHARACTER"
    }
  ],
  "process_info": {
    "process_id": "5a227ca7b4fc48e98d4e02b113c81c123",
    "node_id": "1905555364410802345",
    "variable_id": "1888794111663644672",
    "variable_value": "变量值"
  }
}
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

返回示例

成功

{
  "data": {},
  "retCode": "000000",
  "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 否 返回对象
# ● 会话结束

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口结束机器人的会话。

请求方式：

GET

请求地址：

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

请求参数

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

返回示例：

成功

{
  "data": {},
  "ret_code": "000000",
  "ret_msg": "操作成功"
}
1
2
3
4
5

返回结果

参数 类型 必填 描述
ret_code String 是 返回编码
ret_msg String 是 返回信息
data Object 否 返回对象
# ● 轮询超时消息

接口说明：

接口类型：主动调用接口

接口作用：可通过调用该接口轮询超时消息。

请求方式：

POST

请求地址：

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

请求参数：

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

返回示例

成功

{
  "data": {
    "msgid": "12789cf50b784e4480a02289ddc69fb9",
    "data": {
      "msgid": "12789cf50b784e4480a02289ddc69fb9",
      "bizid": "a97e877ad6b9403bbf945401ea331111",
      "ai_agent_cid": "12dec883b46d48a5808ea143379b7014",
      "round_id": "12ef2d1957434f2eb4b45c629d2db2dc",
      "msg": "人工客服",
      "source_enum": "PC",
      "uid": "c56844605e72633776a6de28d0f598f3",
      "polling_id": "4cd268c9836d45eb931af9c70cf6cc1d",
      "polling_status": "POLLING_END"
    },
    "bizid": "a97e877ad6b9403bbf945401ea331111",
    "push_type": "ROBOT_ANSWER"
  },
  "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 是 none none
# ● 流式接口解析方式
  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，则开启轮询节点超时
# ● 任务流程中按钮消息交互
  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": "12789cf50b784e4480a02289ddc69fb9",
  "data": {},
  "bizid": "a97e877ad6b9403bbf945401ea331111",
  "push_type": "SESSION_OVER_TIME"
}
1
2
3
4
5
6
7

属性

名称 类型 必选 说明
msg_id string 是 消息id
data Object 是 消息
bizid string 是 业务id
push_type string 是 消息类型

PushData格式

{
      "msgid": "12789cf50b784e4480a02289ddc69fb9",
      "bizid": "a97e877ad6b9403bbf945401ea331111",
      "ai_agent_cid": "12dec883b46d48a5808ea143379b7014",
      "round_id": "12ef2d1957434f2eb4b45c629d2db2dc",
      "msg": "人工客服",
      "source_enum": "PC",
      "uid": "c56844605e72633776a6de28d0f598f3",
      "polling_id": "4cd268c9836d45eb931af9c70cf6cc1d",
      "polling_status": "POLLING_END"
}
1
2
3
4
5
6
7
8
9
10
11

属性

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

枚举值

属性 值 说明
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": "人工客服",
  "show_question": "人工客服",
  "input_type_enum": "INPUT",
  "biz_id": "29967d81d67f4a708e8bd7d8f6356447",
  "biz_type": "TEXT",
  "biz_type_id": "1000016",
  "robotid": "1",
  "uid": "c56844605e72633776a6de28d0f598f3",
  "user_name": "用户名称",
  "transfer": true,
  "ai_agent_cid": "12dec883b46d48a5808ea143379b7014",
  "call_back_url": "http://www.sobot.com/aiAgent/callback",
  "source_enum": "PC",
  "partnerid": "123456",
  "params": {
    "key": {}
  },
  "multi_params": {
    "key": {}
  },
  "timing": false,
  "input_variable_infos": [
    {
      "variable_id": "1888794111663644672",
      "variable_name": "变量名",
      "variable_value": "变量值",
      "variable_type": "CHARACTER"
    }
  ],
  "process_info": {
    "process_id": "5a227ca7b4fc48e98d4e02b113c81c123",
    "node_id": "1905555364410802345",
    "variable_id": "1888794111663644672",
    "variable_value": "变量值"
  }
}
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 是 问题
show_question string 是 展示问题
input_type_enum string 是 输入类型
biz_id string 是 业务id
biz_type string 是 业务线类型
biz_type_id string 是 产品id
robotid string 是 机器人id
uid string 否 访客id
user_name string 否 访客姓名
transfer boolean 否 是否开启转人工
ai_agent_cid string 否 AiAgent会话id
call_back_url string 否 回调地址
source_enum string 是 渠道来源
partnerid string 否 对接id
params Map<String,Object> 否 自定义参数
multi_params Map<String,Object> 否 自定义参数
timing boolean 否 是否开启外部定时
input_variable_infos OpenAnswerVariableInfo 否 外部传入变量
process_info OpenProcessInfo 否 枚举变量点击信息

枚举值

属性 值 说明
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": "1888794111663644672",
  "variable_name": "变量名",
  "variable_value": "变量值",
  "variable_code": "string",
  "variable_type": "CHARACTER"
}
1
2
3
4
5
6
7
8

属性

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

枚举值

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

OpenProcessInfo

{
  "process_id": "5a227ca7b4fc48e98d4e02b113c81c123",
  "node_id": "1905555364410802345",
  "variable_id": "1888794111663644672",
  "variable_value": "变量值"
}
1
2
3
4
5
6
7

属性

名称 类型 必选 说明
variable_id string 是 变量id
process_id string 是 流程id
variable_value string 是 变量值
node_id string 是 节点id

QaInfo

{
  "question": "人工客服",
  "questionid": "dda6a07ef5b74642a601102095d1681a",
  "docid": "e3e8a0a11f27496a8448ced8a7ba392d",
  "score": 0
}
1
2
3
4
5
6
7

属性

名称 类型 必选 说明
question string 是 标问
questionId string 是 标问id
docId string 是 词条id
score number 是 匹配阈值

RobotAnswerSuggestRespVo

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

属性

名称 类型 必选 说明
qaContents QaInfo 是 分词联想列表

RobotAnswerRespVo

{
  "robot_answer_type": "QA_DIRECT",
  "robot_answer_message_type": "MESSAGE",
  "answer": "人工客服",
  "transfer_result": "NO_ACTION",
  "roundid": "12ef2d1957434f2eb4b45c629d2db2dc",
  "msgid": "12789cf50b784e4480a02289ddc69fb9",
  "ai_agent_cid": "12dec883b46d48a5808ea143379b7014",
  "biz_id": "29967d81d67f4a708e8bd7d8f6356447",
  "robot_name": "大模型机器人",
  "robot_logo": "string",
  "robotid": "1",
  "robot_status": "DELETE",
  "delay": 0,
  "output_variable_infos": [
    {
      "variable_id": "1888794111663644672",
      "variable_name": "变量名",
      "variable_value": "变量值",
      "variable_code": "string",
      "variable_type": "CHARACTER"
    }
  ],
  "process_id": "5a227ca7b4fc48e98d4e02b113c81c123",
  "node_id": "1905555364410802345",
  "variable_id": "1888794111663644672",
  "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 是 回答类型
robot_answer_message_type string 是 消息类型
answer string 否 答案
transfer_result string 否 转人工结果
roundid string 是 消息轮次id
msgid string 是 消息id
ai_agent_cid string 是 AiAgent会话id
biz_id string 是 业务id
robot_name string 是 机器人名称
robot_logo string 是 机器人logo
robotid string 是 机器人id
robot_status string 是 机器人状态
delay integer 是 节点延时
output_variable_infos AnswerVariableInfo 否 返回收集变量
process_id string 否 流程id
node_id string 否 节点id
variable_id string 否 变量id
variable_value_enums array 否 枚举列表

枚举值

属性 值 说明
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 大模型机器人问答量已用完

枚举值

属性 值 说明
bizType AI_AGENT 大模型机器人
上次更新: 2025/5/28 10:28:58

← 在线客服统计V6 API→

最近更新
01
在线客服统计V6 API
04-23
02
运营支持 API
03-03
03
CRM 对接方案
12-05
更多文章>
Theme by Vdoing