小程序开放平台

文档中心
起步
CLI开发
IDE开发
在小组件中集成
使用多模态能力
模型的出入参标准
模拟器调试

在小组件中集成

开发
>
指南
>
起步
>
在小组件中集成
>
更新时间:2025-11-03 14:00:49

小程序/小组件内调用智能体

小程序/小组件从基础库从 x.x.x 版本开始内置了 Agent 对话能力,开发者可以直接通过小程序/小组件内,通过 xhs.cloud.AI 调用 agent 进行对话

... existing code ...
  async onLoad() {
    console.log("页面加载");
    await this.initAgent();
  },
 
  // 初始化agent
  async initAgent() {
    try {
      const agentId = "921e2e0eaf004d7aa376ee8985e929bb";
      this.agent = xhs.cloud.AI.createAgent({
        agentId,
        env: 'production',
        version: 'latest'
      });
      
      console.log("Agent初始化成功");
    } catch (error) {
      console.error("Agent初始化失败:", error);
      xhs.showToast({
        title: "Agent初始化失败",
        icon: "none",
      });
    }
 }
... existing code ...

开发者调用 xhs.cloud.AI.createAgent 可以得到一个智能体 Agent。Agent 上一共挂载了3个实例属性和7个实例方法,方法的具体参数见JS API文档。

开发者调用 xhs.cloud.AI.createAgent 可以得到一个智能体 Agent

类型声明

xhs.cloud.AI.createAgent({
    agentId,
    accessToken,
    env: 'production',
    version: 'latest'
});

返回值

属性名
类型
说明
最低支持版本
agentAgentAgent实例x.x.x
agentId属性智能体IDx.x.x
agentVersion属性智能体版本x.x.x
env属性环境x.x.x
sendMessage同步方法与智能体进行对话x.x.x
getAgentInfo异步方法获取智能体信息x.x.x
getHistoryMessages异步方法获取历史对话信息x.x.x
getConversations异步方法获取当前智能体会话x.x.x

入参说明

属性名
是否必传
类型
说明
最低支持版本
agentIdstring智能体agentid开放平台获取x.x.x
envstring环境变量,可选值:development 开发环境智能体、production 生产环境智能体x.x.x
version当 env 为 development 必传、当 env 为 production,默认 lateststring智能体函数版本:development - 可能存在多个开发版本,不同智能体存在差异、production - 仅存在一个版本,默认 latestx.x.x