GetCopilotHistory - 获取copilot流式接口的聊天记录 - Alibaba Cloud Linux

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

sysom:GetCopilotHistory

list

*全部资源

*

无

请求语法

POST /api/v1/copilot/get_copilot_history HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
body	object	否	请求 Body
count	integer	是	请求历史聊天记录的数量，一般小于 100 条	100

返回参数

名称	类型	描述	示例值
	object	Schema of Response
code	string	错误码	SysomOpenAPI.InvalidParameter
data	array<object>	聊天记录列表，长度为请求数量，若聊天记录小于请求数量，则为实际的聊天记录数量，格式：[{"user":“”,"content":“”.question,"time":"“},{...}]
	object	返回数据。
content	string	聊天内容文本	copilot回复的具体内容
time	string	聊天记录时间，string 类型	2024-09-02 10:02:39
user	string	user/copilot，user 为用户，copilot 为机器人	user copilot
message	string	错误信息如果 `code == Success`，则本字段为空；否则本字段包含请求错误信息。	SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom
requestId	string	Id of the request	2D693121-C925-5154-8DF6-C09A8B369822

示例

正常返回示例

JSON格式

{
  "code": "SysomOpenAPI.InvalidParameter",
  "data": [
    {
      "content": "copilot回复的具体内容",
      "time": "2024-09-02 10:02:39",
      "user": "user\ncopilot"
    }
  ],
  "message": "SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom",
  "requestId": "2D693121-C925-5154-8DF6-C09A8B369822\n"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。