智能体管理
1. 准备
基础域名:https://api.rokid.com
准备:
- 确保已经获取到了有效的 API 密钥(
API_KEY),用于身份验证。 - 确保企业下已经产生智能体调用日志,便于查询返回结果。
2. 功能介绍
智能体管理模块提供了 AI 问答记录的分页查询能力,帮助开发者按用户、时间范围、模板名称、模型名称等条件筛选问答记录,查看问题内容、回答结果、模型信息和调用状态。
2.1 分页查询 AI 问答记录
接口地址:https://api.rokid.com/ar/assistant/openapi/chatLog/page?pageNum={$pageNum}&pageSize={$pageSize}&type={$type}&keywords={$keywords}&uid={$uid}&startTime={$startTime}&endTime={$endTime}&agentName={$agentName}&modelName={$modelName}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述: 分页查询当前企业下的 AI 问答记录
请求参数:
| 参数名称 | 参数说明 | 是否必须 | 数据类型 |
|---|---|---|---|
| pageNum | 页码,默认值 1 | false | int |
| pageSize | 每页数量,默认值 10 | false | int |
| type | 日志类型:0 聊天,1 识别,默认值 0 | false | int |
| keywords | 关键词,匹配问题内容和回答内容 | false | string |
| uid | 用户 ID,精确匹配 | false | string |
| startTime | 开始时间,支持 yyyy-MM-dd 或 yyyy-MM-dd HH:mm:ss | false | string |
| endTime | 结束时间,支持 yyyy-MM-dd 或 yyyy-MM-dd HH:mm:ss | false | string |
| agentName | 模板名称,模糊匹配 | false | string |
| modelName | 模型名称,模糊匹配 | false | string |
输出结果:
| 参数名称 | 参数说明 | 是否必须 | 数据类型 |
|---|---|---|---|
| pageNum | 当前页码 | true | int |
| pageSize | 每页数量 | true | int |
| total | 总记录数 | true | long |
| list | 日志记录列表 | true | array |
| id | 主键 ID | true | long |
| type | 日志类型:0 聊天,1 识别 | true | int |
| deviceId | 设备编号 | false | string |
| agentId | 智能体 ID | false | string |
| agentName | 模板名称 | false | string |
| modelId | 模型 ID | false | string |
| modelName | 模型名称 | false | string |
| modelApiName | 模型 API 名称 | false | string |
| systemPrompt | 系统提示词 | false | string |
| questionContent | 问题内容 | false | string |
| questionImg | 问题图片地址 | false | string |
| answerContent | 回答内容 | false | string |
| costTime | 耗时,单位毫秒 | false | int |
| status | 调用状态 | false | string |
| errorMsg | 错误信息 | false | string |
| isMemory | 是否启用记忆 | false | boolean |
| time | 调用时间 | false | string |
| uid | 用户 ID | false | string |
| userName | 用户名称 | false | string |
| companyId | 组织 ID | false | string |
| gmtCreated | 创建时间 | false | string |
| gmtModified | 更新时间 | false | string |
| deleted | 是否删除:0 未删除,1 已删除 | false | int |
请求示例:
bash
curl -X GET "https://api.rokid.com/ar/assistant/openapi/chatLog/page?pageNum=1&pageSize=10&type=0&uid=E0BB5354E9F54BC6A032E8B709CC7B2E&startTime=2026-06-01&endTime=2026-06-15%2023:59:59&agentName=%E5%B7%A1%E6%A3%80%E5%8A%A9%E6%89%8B&modelName=gpt" \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json"响应示例:
json
{
"code": 0,
"message": "OK",
"data": {
"pageNum": 1,
"pageSize": 10,
"total": 1,
"list": [
{
"id": 1001,
"type": 0,
"deviceId": "1901092524001715",
"agentId": "agent_demo_001",
"agentName": "巡检助手",
"modelId": "common",
"modelName": "默认模型",
"modelApiName": "gpt-4o-mini",
"systemPrompt": "你是一个巡检助手",
"questionContent": "请帮我总结今天的巡检结果",
"questionImg": "",
"answerContent": "今天共完成 8 个点位巡检,未发现异常。",
"costTime": 1260,
"status": "success",
"errorMsg": "",
"isMemory": true,
"time": "2025-11-07T15:20:00.000+08:00",
"uid": "E0BB5354E9F54BC6A032E8B709CC7B2E",
"userName": "张三",
"companyId": "rokid-demo-company",
"gmtCreated": "2025-11-07T15:20:00.000+08:00",
"gmtModified": "2025-11-07T15:20:00.000+08:00",
"deleted": 0
}
]
},
"success": true
}