获取会话历史消息

介绍

获取会话历史消息 API 允许开发者根据robot_id和conversation_id当前会话下的历史消息。此 API 适用于需要管理或查看Agent 会话历史的场景。

基本信息

GET https://ai-api.betteryeah.com/v1/oapi/agent/chat/history?robot_id=eaadc9531f0240d9beaf2bae98ea0e32&conversation_id=bc21a56c39b247e892541a69f56be3cc

请求头

名称	类型	是否必填	描述	示例
Content-Type	string	true	固定值 "application/json"	application/json
Access-Key	string	true	用于认证的访问密钥，获取参照：获取请求相关信息	NjMyZDZlMTFkNGUxNGU2NjhmMGY5MWFlLDEwMDAsMTY5NTA5ODEwNjkwMA==
Workspace-Id	string	true	工作空间 ID，获取参照：获取请求相关信息	632d6e11d4e14e668f0f91ae

示例

javascript

Content-Type:application/json
Access-Key:NjMyZDZlMTFkNGUxNGU2NjhmMGY5MWFlLDEwMDAsMTY5NTA5ODEwNjkwMA==
Workspace-Id:632d6e11d4e14e668f0f91ae

路径参数

名称	类型	是否必填	描述	示例
robot_id	string	true	agent的唯一标识符，获取参照：获取请求相关信息	eaadc9531f0240d9beaf2bae98ea0e32
conversation_id	string	true	会话 id	d6bdf19485554b419c9df8ab49e4bdb7
page_number	number	false	当前页，默认值为1	1
page_size	number	false	返回条数，默认值为20	20

示例

javascript

robot_id=eaadc9531f0240d9beaf2bae98ea0e32&conversation_id=bc21a56c39b247e892541a69f56be3cc&id=1&page_size=20

请求示例

javascript

curl --location 'https://ai-api.betteryeah.com/v1/oapi/agent/chat/history?robot_id=eaadc9531f0240d9beaf2bae98ea0e32&conversation_id=bc21a56c39b247e892541a69f56be3cc&id=1&page_size=20' \
--header 'Access-Key: NjMyZDZlMTFkNGUxNGU2NjhmMGY5MWFlLDEwMDAsMTY5NTA5ODEwNjkwMA==' \
--header 'Workspace-Id: 632d6e11d4e14e668f0f91ae'

响应

名称			类型	描述	示例
code			number	API响应的状态码	200｜500等
success			boolean	API调用是否成功。true表示成功，而false表示失败。	true｜false
message			string	API响应的状态消息	"SUCCESS"或者"请求失败，原因 xxxx"
data			array
	page_number		number	返回的页码
	page_size		number	每页显示的记录数
	total_pages		number	总页数
	total_count		number	总记录数
	data_list		array	分页数据
		id	string	会话 id
		user_content	string	用户聊天发送内容
		response	string	agent响应内容
		session_id	string	对话 id
		create_time	string	会话创建时间
		response_ext	object	agent 返回内容，参照发送会话消息 api 响应结构：发送会话消息
		record_status	enum	记录存储到数据库状态：FAILED（失败）、SUCCEEDED（成功）	SUCCEEDED
		is_push	boolean	是否`push_msg` api 推送的消息	默认值false
		~~tips~~	array	Deprecated
		~~file_url~~	string	Deprecated
		~~file_name~~	string	Deprecated
		~~file_type~~	string	Deprecated
		~~upload_file_id~~	string	Deprecated

now_time			number	服务器当前的时间戳（以秒为单位）

响应示例

javascript

{
    "code": 200,
    "success": true,
    "message": "SUCCESS",
    "data": {
        "page_number": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_count": 6,
        "data_list": [
            {
                "id": "d6bdf19485554b419c9df8ab49e4bdb7",
                "user_content": "总结孙子兵法形篇",
                "response": "孙子兵法的形篇主要论述了战争的基本形态、军事部署和战术运用的原则。形篇的总结如下：\n1. 作战环境：形篇首先强调了地形的重要性，指出应根据地形的优劣选择作战地点，同时提出了“知己知彼，百战不殆”的思想，强调了对敌情、我方实力和环境的全面了解。\n2. 军队部署：形篇阐述了军队的部署原则，包括了“兵法”、“势”、“军形”、“地形”四个方面，指出了作战中的合理部署应当考虑到这四个因素。\n3. 军事运动：形篇提出了“兵不厌诈”、“军形”、“节用”、“变化”等原则，强调了灵活运用兵力、变化战术、节约资源的重要性。\n4. 战争规划：形篇对攻守、进退等战争策略进行了讨论，提出了“能进能退”、“能动能静”等战略原则。\n\n形篇的总结可以帮助军事领导者更好地理解战争形势，合理部署兵力，制定战争策略，以取得战争的胜利。",
                "session_id": "6f327ac104354642b2bf764566f8cdd1",
                "create_time": "2024-03-21T16:34:07.462866",
                "response_ext": {
                    "status": "SUCCEEDED",
                    "duration_time": 8.081,
                    "message": "运行成功",
                    "tasks": [
                        {
                            "name": "related_questions",
                            "type": "RELATED_QUESTIONS",
                            "tool_type": "",
                            "tool_id": "",
                            "timestamp": 1711010054,
                            "status": "STARTED",
                            "content": {},
                            "duration_time": 0.0,
                            "message": "运行成功"
                        },
                        {
                            "name": "related_questions",
                            "type": "RELATED_QUESTIONS",
                            "tool_type": "",
                            "tool_id": "",
                            "timestamp": 1711010054,
                            "status": "SUCCEEDED",
                            "content": {
                                "related_questions": [
                                    "如何根据地形的优劣选择作战地点？",
                                    "军队部署原则包括哪些方面？",
                                    "如何灵活运用兵力、变化战术和节约资源？"
                                ]
                            },
                            "duration_time": 1.275,
                            "message": "运行成功"
                        },
                        {
                            "name": "llm_response",
                            "type": "TEXT",
                            "tool_type": "SYSTEM",
                            "tool_id": "",
                            "timestamp": 1711010055,
                            "status": "SUCCEEDED",
                            "content": "孙子兵法的形篇主要论述了战争的基本形态、军事部署和战术运用的原则。形篇的总结如下：\n1. 作战环境：形篇首先强调了地形的重要性，指出应根据地形的优劣选择作战地点，同时提出了“知己知彼，百战不殆”的思想，强调了对敌情、我方实力和环境的全面了解。\n2. 军队部署：形篇阐述了军队的部署原则，包括了“兵法”、“势”、“军形”、“地形”四个方面，指出了作战中的合理部署应当考虑到这四个因素。\n3. 军事运动：形篇提出了“兵不厌诈”、“军形”、“节用”、“变化”等原则，强调了灵活运用兵力、变化战术、节约资源的重要性。\n4. 战争规划：形篇对攻守、进退等战争策略进行了讨论，提出了“能进能退”、“能动能静”等战略原则。\n\n形篇的总结可以帮助军事领导者更好地理解战争形势，合理部署兵力，制定战争策略，以取得战争的胜利。",
                            "duration_time": 0.0,
                            "message": "运行成功"
                        }
                    ],
                    "timestamp": 1711010047
                },
                "record_status": "SUCCEEDED",
                "is_push": false,
                "tips": [],
                "file_url": "",
                "file_name": "",
                "file_type": "",
                "upload_file_id": ""
            }
        ]
    },
    "now_time": 1711039789
}

获取会话历史消息 ​

介绍 ​

基本信息 ​

请求头 ​

路径参数 ​

请求示例 ​

响应 ​

获取会话历史消息

介绍

基本信息

请求头

路径参数

请求示例

响应