小程序开放平台

文档中心
平台概述

getConversations

更新时间:2025-10-31 14:48:56

getConversations

方法概述

getConversations
用于获取用户的会话列表,返回所有可用的对话会话信息。该方法主要用于获取对话历史记录,支持多会话管理和历史对话查看。

基本信息

  1. 函数签名
    getConversations(): Promise<GetConversationsData>
  2. 服务 URI
    GET
    /v1/aiagent/agents/:agentId/conversations
  3. 返回类型
    Promise<GetConversationsData>
    - 异步方法,返回会话列表数据
  4. 调用方式 内部方法,由 AgentRuntime 框架提供

功能说明

  • 会话列表获取:获取用户的所有对话会话
  • 历史管理:支持查看对话历史记录
  • 会话信息:提供会话ID和创建时间等基本信息
  • 多会话支持:支持多个独立对话会话的管理

参数说明

该方法无需传入参数,直接调用即可获取会话列表。

返回值说明

GetConversationsData 返回数据结构:

属性名
类型
说明
最低支持版本
conversationsConversation会话列表x.x.x

Conversation 对象结构:

属性名
类型
说明
最低支持版本
idstring会话 idx.x.x
createAtstring会话创建时间x.x.x

类型定义

export interface Conversation {
    id: string;
    createAt: string;
}

export interface GetConversationsData {
    conversations: Conversation[];
}

使用示例

基础使用示例

const agent = this.getAgent();
if (!agent) return;

const conversations = await agent.getConversations();
console.log("会话列表:", conversations);
console.log("会话数量:", conversations.conversations.length);

遍历会话列表示例

const agent = this.getAgent();
if (!agent) return;

const conversations = await agent.getConversations();

// 遍历所有会话
conversations.conversations.forEach((conversation, index) => {
    console.log(`会话 ${index + 1}:`);
    console.log(`  ID: ${conversation.id}`);
    console.log(`  创建时间: ${conversation.createAt}`);
});

按时间排序示例

const agent = this.getAgent();
if (!agent) return;

const conversations = await agent.getConversations();

// 按创建时间排序(最新的在前)
const sortedConversations = conversations.conversations.sort((a, b) => 
    new Date(b.createAt).getTime() - new Date(a.createAt).getTime()
);

console.log("按时间排序的会话列表:", sortedConversations);

注意事项

⚠️ 重要提醒

  1. 数据格式:createAt 字段为字符串格式的时间戳
  2. 空列表处理:当没有会话时,conversations 数组为空
  3. 错误处理:建议添加 try-catch 块处理可能的异常
  4. 性能考虑:会话数量较多时可能影响加载性能