ListAIAgentDialogues - 查询对话记录

更新时间:
复制为 MD 格式

列出会话的历史记录。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ice:ListAIAgentDialogues

none

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

SessionId

string

会话 ID。

f27f9b9be28642a88e18****

RoundLimit

string

对话回合限制。指定返回最近 N 个回合的对话记录,必须为正整数。与分页参数互斥,使用此参数时将忽略分页参数。

5

StartTime

integer

开始 Unix 时间戳(包含),毫秒。

0

EndTime

integer

结束 Unix 时间戳(包含),毫秒。

17358082464030

PageNumber

integer

分页数,默认 1。

1

PageSize

integer

分页大小,最大 100,默认 20。

20

Order

string

ASC 正序,DESC 倒序。默认 DESC。

DESC

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

7B117AF5-***************

Dialogues

array<object>

对话记录列表。

array<object>

DialogueId

string

这条对话的唯一 ID。

19de81b3b3d94abda22****

RoundId

string

对话回合 ID。

f27f9b9be28642a88e18****

Producer

string

这句话的产生者。

  • user: 用户产生的句子

  • agent:智能体产生的句子。

枚举值:

  • agent :

    agent

  • user :

    user

user

Text

string

对话具体的文本。

你好

ReasoningText

string

深度思考的文本。

我在思考

AttachedFileList

array<object>

附件列表。对话中引用的文件附件信息。

object

Url

string

附件的访问地址(URL)。

https://media.w3.org/2010/05/sintel/trailer.mp3

Id

string

附件的唯一标识。

7B117AF5-***************

Format

string

附件的格式(如 mp3、wav、pdf 等)。

mp3

Type

integer

附件类型。数值类型,具体含义由业务定义。

1

Name

string

附件的文件名称。

MusicDemix

Time

integer

这条对话产生的 Unix 时间戳,单位毫秒。

1734511087000

Type

string

这句话的类型。可选:

语音通话

  1. greeting 欢迎语

  2. normal 语音回复

  3. speech 主动播报

文本对话

  1. normal 文本回复

  2. announcement 主动推送文字。

  3. custom 自定义消息。

announcement

Source

string

这句话的来源。可选:

chat 文本对话

call 语音通话

chat

NodeId

string

节点 ID。标识生成该对话的流程节点,用于追溯对话是由哪个处理节点产生的。

e01-cn-to345ikn62o

Extend

string

扩展信息。JSON 格式的扩展字段,用于存储额外的自定义数据,如情感标签、意图识别结果等。

{\"addTransferLock\":true}

示例

正常返回示例

JSON格式

{
  "RequestId": "7B117AF5-***************",
  "Dialogues": [
    {
      "DialogueId": "19de81b3b3d94abda22****",
      "RoundId": "f27f9b9be28642a88e18****",
      "Producer": "user",
      "Text": "你好",
      "ReasoningText": "我在思考",
      "AttachedFileList": [
        {
          "Url": "https://media.w3.org/2010/05/sintel/trailer.mp3",
          "Id": "7B117AF5-***************\n",
          "Format": "mp3",
          "Type": 1,
          "Name": "MusicDemix"
        }
      ],
      "Time": 1734511087000,
      "Type": "announcement",
      "Source": "chat",
      "NodeId": "e01-cn-to345ikn62o",
      "Extend": "{\\\"addTransferLock\\\":true}"
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情