@chamvi/聊天

Chamvi探员的聊天频道.
聊天SDK适配器开始运行,通过一个通道得到回复,
和平台软件包通过公共接缝插入.

目录

• 安装
• 使用量
• 网络呼号
• 平台软件包
• 订阅和答复
• 内存
• 信托
• 限制
• 使用@ chamvi/ app
• API 密码
• 许可证

安装

npm install @chamvi/chat @chamvi/core @chamvi/http chat --save

仅限无害环境管理,节点.js >=26.0.0。 。 。 . @chamvi/core, (中文(简体) ), @chamvi/http (网络浏览器)和 chat (Chat SDK,4.44或后在 4.x行)是同位相依性; smob 是唯一的运行时间依赖. @chamvi/app 是可选的对等点 @chamvi/chat/module。软件包没有导入 SDK:WhatsApp Web 的平台 @chamvi/chat-whatsapp。 。 。 .

使用量

任意聊天 SDK Adapter 通过频道工作。 包起来 createChatIngressAdapter() 在登记之前 Chat,所以Chamvi的收录,而不是SDK的处理器和预处理器分解,接受它的信息;频道拥有 Chat 一个人 在引擎上注册频道, 订阅代理 channel.on() 并用工具回复 ctx.channels.findOneOrFail('chat').emit()数字 :

import type { LanguageModel } from 'ai';
import { z } from 'zod';
import { Chat } from 'chat';
import type { Adapter, StateAdapter } from 'chat';
import {
    Engine,
    createMemoryStore,
    defineModelAgent,
    defineTool,
} from '@chamvi/core';
import type { IClock, IEngine } from '@chamvi/core';
import { chatChannel, createChatIngressAdapter } from '@chamvi/chat';

export function createChatEngine(
    model: LanguageModel,
    // adapter: any Chat SDK adapter whose platform posts webhooks; state: a Chat SDK state adapter
    options: {
        adapter: Adapter;
        state: StateAdapter;
        clock?: IClock
    },
): IEngine {
    const { CHAT_USERS, APP_URL } = process.env;

    if (!CHAT_USERS || !APP_URL) {
        throw new Error('Set CHAT_USERS (platform user ids, comma separated) and APP_URL.');
    }

    const allowed = new Set(CHAT_USERS.split(','));

    // chamvi's intake, not the Chat SDK's handlers, accepts the adapter's messages
    const ingress = createChatIngressAdapter(options.adapter);
    const chat = new Chat({
        userName: 'chamvi',
        adapters: { [ingress.name]: ingress },
        state: options.state,
        logger: 'warn',
        concurrency: 'concurrent',
    });

    const channel = chatChannel({
        chat,
        adapters: [ingress],
        // the platform posts to POST /channels/chat/<adapter> (the http app's channel mount)
        webhooks: [ingress.name],
        // only these users start runs; everybody else is ignored
        allowMessage: ({ message }) => allowed.has(message.author.userId),
        resolveInvoker: ({ message }) => ({
            id: message.author.userId,
            kind: 'chat',
            permissions: [],
        }),
        // a link to the approval in the chamvi UI: ids only, answered there
        approvalUrl: ({ runId, approvalId }) => `${APP_URL}/ui/approvals?run=${encodeURIComponent(runId)}&approval=${encodeURIComponent(approvalId)}`,
    });

    const reply = defineTool({
        description: 'Reply in the chat the message came from.',
        inputSchema: z.object({ text: z.string() }),
        execute: async ({ text }, { context }) => {
            // the source chat: no address needed
            await context.channels.findOneOrFail('chat').emit({ body: text });

            return 'sent';
        },
    });

    const assistant = defineModelAgent({
        name: 'assistant',
        model,
        instructions: 'You are the team\'s assistant. Answer with the reply tool.',
        // one memory per direct chat and one per group
        conversation: true,
        // direct messages and mentions in a group
        channels: [channel.on()],
        tools: { reply },
    });

    return new Engine({
        // memory store: conversations included; use @chamvi/store-db in production
        store: createMemoryStore({ clock: options.clock }),
        agents: [assistant],
        channels: [channel],
        clock: options.clock,
        conversations: { authorize: ({ agent }) => agent === 'assistant' },
    });
}

频道建成时没有初始化:频道的 start (引擎)绑定适配器,初始化 Chat,然后打电话 connect。 。 。 . allowMessage 要求每个适配器(可启动运行); resolveInvoker 命名运行的引用者( 无默认) ; connect编号 :disconnect 将套接字式的适配器接入频道的起动和停止. 消息只在 allowMessage 允许它; 拒绝的消息被悄悄地删除: 没有运行, 没有回复, 没有下载。 通用的webhook适配器仅被假适配器的测试所覆盖: chamvi除了WhatsApp Web之外没有验证过任何平台.

网络呼号

一个网点适配器的平台帖子 POST /channels/<channel>/<adapter> ( http app 的频道挂载; 仅列出在 webhooks,任何其它404个。 身体被读取到 CHAT_BODY_LIMIT_BYTES (一米B,上面有413个) 交给适配器自己 handleWebhook以核实请求。 答案将等到适配器移交的每个消息都作为运行存储(最多) CHAT_WEBHOOK_TIMEOUT_MS, 30 s)),并且是一个503,当一个人不能因为某种原因重新交付可能会被修复(存储失败,频道没有启动或停止,超时),所以平台被重新删除. 一个消息只被拒绝(媒体,没有文本,无效的ID,拒绝的谈话,扔出过滤器)一次被报告,并得到了适配器自己的答案,因为重新发送会被再次拒绝. 获取挑战流量没有服务。 只有适配器在请求的同声上下文中交接的信息才会被跟踪:一个将信息传递给在它之外开始的消费者的适配器(一个队列,一个请求前的收听器)不会被等待,它自己的2xx站. 除非 channelRateLimits 命名频道.

平台软件包

平台软件包( 如 @chamvi/chat-whatsapp建立其 Chat,其包裹适配器和一个 chatChannel() 喜欢任何应用,通过 只有运输知道 platform (单位:千美元)IChatPlatform,每个钩子可选并呼叫平台对象:

频道在施工时检查平台(InvalidAgentDefinitionError 对于一个非对象,一个没有功能的钩子,或者一个没有钩子的普通对象. 它的套接字寿命周期与 connect编号 :disconnect,其信息政策与 allowMessage编号 :resolveInvoker。 。 。 .

订阅和答复

channel.on({ adapter?, events?, id?, filter?, concurrencyMaxRuns? }) 订阅代理; events 为: direct (直接聊天), mention (一组中提及的机器人)和 message (任何其他组消息),默认 ['direct', 'mention']。 。 。 . chat.on() 对命名的频道进行同样的修改 chat运行的有效载荷是很小的 ChatPayload (单位:千美元)adapter, (中文(简体) ), event, (中文(简体) ), threadId, (中文(简体) ), channelId, (中文(简体) ), message: { id, text, author, sentAt? }),从来不是平台的原始对象;其地址是聊天,所以工具的 emit() 没有地址回复. channel.to({ adapter, threadId }) 构建另一个聊天地址 .

一旦每个代理商(偶当键的散列通道、适配器、线程、发送器和消息ID)接受消息,就不再进行第二次发送;瞬态商店故障将重复两次(1 s, 2 s),然后报告为 chat_intake_failed。 。 。 .

核准ctx.channels.findOneOrFail('chat').approve()发送带有标题、正文(切合)、选项和 approvalUrl 链接( c)Approve or deny: <link>选项 Choose and approve or deny: <link>; 车主在chamvi UI中回答. 链接只携带ID;没有本地按钮,聊天中的回覆不回答批准.

内存

一个特工与 conversation: true 每个聊天通过核心获得一个内存 对话记忆:信道通过引擎的可信赖的谈话收录,从不通过有效载荷场来绑定每个消息. 它需要一个商店 conversations (单位:千美元)createMemoryStore() 或者说 @chamvi/store-db和发动机的 conversations: { authorize } (单位:千美元)createApp({ conversations })) (中文(简体) ). 身份是频道 account 别名、聊天和观众: direct:<sender> 直接聊天, group:<channel id> 对于一个集团,所以一个集团在其成员之间共享一个记忆. 被接受的消息文本和向源聊天发送的答复被记住; history: 0 是唯一的设置( 没有获取平台历史) 。 一个平台软件包可以命名自己的身份(IChatPlatform.conversationTarget) (中文(简体) ).

信托

每次运行聊天频道启动都会被污染(untrusted: true 默认; false 仅用于完全信任的私人部署),所以工具分类 guardWhenTainted 要求批准(或被拒绝)。 消息源聊天的回覆可以免去出入口;发送到另一个聊天的回覆通过. 一个配置 defaultAddress 也可以免责:它是一个被污染的跑道的通水槽,所以没有一条是默认的.

限制

• 只有文本:拒绝发送带有附件或没有文本的信息(报告,不运行)。 无媒体下载.
• 无历史history: 0),没有消息分割:上面的信息 maxTextChars (默认) CHAT_TEXT_MAX_CHARS, 4096 UTF-16 代码单位)被拒绝;批准只削减其通用语.
• ChannelMessage.slot 被忽略 : 每个消息都是新的聊天消息 .
• 发送至少一次:发送方为 timeoutMs (默认) CHAT_TIMEOUT_MS, 30 s); 发送时段仍可发送, 重试时可能再次发送。 频道停止或耗尽时发送失败 .

使用@ chamvi/ app

import { createApp } from '@chamvi/app';
import { chatChannel } from '@chamvi/chat';
import { chatModule } from '@chamvi/chat/module';

const channel = chatChannel({ ... });

export default createApp({
    agents: [assistant],
    modules: [chatModule({ channel })],
    conversations: { authorize: ({ agent }) => agent === 'assistant' },
});

chatModule() 将频道输入 AppToken.CHANNELS (单元名称) chamvi:channel:<name>); 引擎开始并停止它, 和 http 模块挂载它 in 当它服务于网络用户。 它没有增加嵌入变量 并且构造什么,所以 chamvi start --check 没有初始化 Chat 也没有连接.

API 密码

整个选项参考是 聊天参考。 。 。 .

许可证

由 所制

原载 Apache 许可证 2.0。 。 。 .