OpenMax
免费试用

内置插件

内置输入框插件(@ 提及、# 工作项引用,以及规划中的表情):做什么、用到哪些插件能力、需要宿主哪些能力、发送时带什么。

内置插件

COMPOSER_PLUGINS(从 @openmaxai/chat/composer 导出)里是内置插件,ChatProvider 不传 plugins 时装的就是它们。工具条按钮按下表的顺序排列。

插件 id 触发符 用到的插件能力 requiredPorts 发送时
emoji 规划中 无 toolbar 无 选中的表情就是正文里的字符,不带别的数据
mention @、@ trigger、toolbar、nodes、sendKeys + contributeSend identity、i18n 正文里是 @ 加显示名,另带 mentions
work-reference #、# trigger、toolbar、nodes workItems 正文里是 [#label](resourceUri),不带别的数据

各项插件能力的含义见输入框插件。

@ 提及

插件 id mention。

做什么:输入 @ 或 @,或点工具条上的 @ 按钮,弹出候选:

  • 会话里的成员,不含自己,按输入的文字匹配显示名;
  • 会话允许时,最前面还有「所有人」「所有 Agent」两项;
  • 面板还会按输入的文字搜组织目录,列出不在会话里的人。

选中后插入一个 @ 胶囊。胶囊是一个整体,光标整块跳过,退格一下整块删掉。被 @ 的人会在消息区看到 @me 胶囊。

用到的插件能力:

能力 内容
trigger 触发符 @、@;设了 keepPanelOpenWhenEmpty,会话里没有匹配的人时面板照样打开,去目录里找;设了 listbox,读屏能念出高亮的候选
toolbar 一个按钮,id mention,默认在工具条上;点击插入 @,候选面板随之打开
nodes 节点 mention,带显示名、成员 id 或「所有人」类型
sendKeys + contributeSend 发送键 mentions

需要的宿主能力:requiredPorts 是 ["identity", "i18n"]。

  • identity:会话成员(listMembers)、当前用户(currentUserId)、组织目录搜索(searchDirectory)。
  • i18n:「所有人」「所有 Agent」两项的文字。

两项都是必填能力,所以 @ 在任何宿主上都有。

发送时带什么:

  • 正文里每个胶囊写成 @ 加显示名。
  • 另带结构化的 mentions,按在正文里出现的顺序,同一个人或同一种「所有人」只算一次:成员是 { type: "member", memberId },「所有人」是 { type: "all" },「所有 Agent」是 { type: "all_agents" }。
  • 没有 @ 任何人时不带 mentions 字段。

宿主收到的是 messaging.sendMessage 的 mentions,见宿主能力。

# 工作项引用

插件 id work-reference。

做什么:输入 # 或 #,或点工具条上的 # 按钮,按输入的文字搜项目和问题。项目可以展开,在同一个面板里列出它下面的问题;点箭头或按 ArrowLeft / ArrowRight 展开、收起。选中后插入一个工作项标签,标签也是一个整体。

用到的插件能力:

能力 内容
trigger 触发符 #、#;候选面板自己处理左右方向键
toolbar 一个按钮,id work-reference,默认在工具条上;点击插入 #,候选面板随之打开
nodes 节点 work_reference,带标签文字、资源地址、id 和类型(项目或问题)

不用 sendKeys 和 contributeSend:引用的信息都在正文里。

需要的宿主能力:requiredPorts 是 ["workItems"],用它的 search 搜项目和问题,展开项目时也用它取该项目下的问题。实现方法见输入框 · # 工作项。

workItems 是可选能力。宿主没有它时,SDK 不装这个插件:# 只是普通字符,工具条上也没有 # 按钮,@ 照常可用。

发送时带什么:正文里每个标签写成 [#label](resourceUri),即一个 Markdown 链接;不带别的结构化数据。

表情

插件 id emoji。规划中

做什么:工具条上的表情按钮,点了打开表情面板,选中的表情作为文字插入光标处。输入框收起和展开时都有这个按钮,展开后在底栏。

用到的插件能力:

能力 内容
toolbar 一个按钮,id emoji,默认在工具条上;按钮的 Panel 是表情面板

不用 trigger、nodes、sendKeys 和 contributeSend:表情是普通文字。

需要的宿主能力:无,requiredPorts 为空,任何宿主都装得上。

发送时带什么:表情就是正文里的字符,不带别的结构化数据。