tutorials.md

三、二次开发

非常简陋的文档，会逐步完善的～

自定义模型

方便接入其他平台的模型，或私有模型。

import {
  ChatModel,
  ConversationContext,
  defineLLM,
  ChatType
} from '@zhengxs/wechaty-plugin-assistant';

// ============ 基于类  ============

class ChatCustom implements ChatModel {
  name = 'custom';
  human_name = '自定义模型';
  input_type: [ChatType.Text], // 此模型接收的消息类型
  call(ctx: ConversationContext) {
    // message 就是 wechaty 的消息模型
    const { message } = ctx;

    // 直接回复发送者，如果在群里会直接 @ 他
    ctx.reply(`hello ${message.text()}`);
  }
}

// ============ 基于普通对象  ============

const llm = defineLLM({
  name: 'custom',
  human_name: '自定义模型',
  input_type: [ChatType.Text], // 此模型接收的消息类型
  call(ctx: ConversationContext) {
    // message 就是 wechaty 的消息模型
    const { message } = ctx;

    // 直接回复发送者，如果在群里会直接 @ 他
    ctx.reply(`hello ${message.text()}`);
  },
});

示例代码

记录状态

可以通过 session 记住当前聊天上下文，通过 userConfig 记录用户配置，如：当前模型。

class ChatCustom implements ChatModel {
  name = 'custom';
  human_name = '自定义模型';

  call(ctx: ConversationContext) {
    // message 就是 wechaty 的消息模型
    const { message, session, userConfig } = ctx;

    // 参考了 koa-session 模块
    // 可以在这里写入任何支持序列化的数据
    // 会自动保存到缓存中，无需手动处理
    session.view = 1;

    // 注意：这个只隔离了用户，群聊和私聊都是同一个对象
    userConfig.model = 'erniebot';

    // 直接回复发送者，如果在群里会直接 @ 他
    ctx.reply(`hello ${message.text()}`);
  }
}

注意: session 已经隔离了不同用户，以及私聊和群里下的同一个用户，所以你存储的状态，不用担心会影响到其他人。

注册聊天指令

const assistant = createAssistant({
  llm,
});

// 注意：这里不要带 / 线，聊天需要加 斜线
assistant.command.register('ping', function (ctx: ConversationContext) {
  ctx.reply('pong');
});

在聊天窗口输入 /ping，机器人就会回复 pong。

示例代码

使用多模型切换功能

使用 MultiChatModelSwitch 类，可以让用户切换不同的模型。

import {
  ChatClaudeAI,
  ChatERNIEBot,
  createAssistant,
  MultiChatModelSwitch,
} from '@zhengxs/wechaty-plugin-assistant';

const erniebot = new ChatERNIEBot({
  token: process.env.EB_ACCESS_TOKEN,
});

const claude = new ChatClaudeAI({
  apiOrg: process.env.CLAUDE_API_ORG!,
  sessionKey: process.env.CLAUDE_SESSION_KEY!,
});

const assistant = createAssistant({
  llm: new MultiChatModelSwitch([erniebot, claude, ...other]),
});

使用

• 输入: 查看模型 输出: 当前用户模型和列表
• 输入: 切换xxx 输出：已切换至 xx

示例代码

存储助手状态

import {
  createAssistant,
  type MemoryCache,
} from '@zhengxs/wechaty-plugin-assistant';

// 聊天上下文 和 MultiChatModelSwitch 的用户配置 都会调用这个
// 默认存储在内存中
const cache: MemoryCache = {
 /**
   * 读取一条缓存
   *
   * @param key - 缓存的键
   * @returns 缓存的值
   */
  async get(key: string) {

  },

  /**
   * 写入一条缓存
   *
   * @param key - 缓存的键
   * @param value - 缓存的值
   * @param ttl - 单位为秒
   * @returns 是否写入成功
   */
  async set(key: string, value: unknown, ttl?: number): Promise<true> {
    return true
  },

  /**
   * 删除一条缓存
   * @param key - 缓存的键
   * @returns 是否删除成功
   */
  async delete(key: string): Promise<boolean> {
    return true
  },

  /**
   * 删除所有条目
   */
  async clear(): Promise<void> {
    // pass
  }
}

const assistant = createAssistant({
  llm,
  cache:
});

• user:config:<talkerId> - 这是用户配置的 key
• assistant:session:${md5(roomId + talkerId)} - 这是聊天上下文的 key