跳到主要内容

🎬 动作函数

操作函数允许您在消息工具栏中编写自定义按钮，供终端用户交互。此功能可实现更具交互性的消息传递，使用户能够在执行任务前授予权限，生成结构化数据的可视化效果，下载聊天音频片段，以及许多其他用例。

操作代码的骨架可在社区版块中找到。

图表可视化操作的示例可在下面的视频中查看。

Graph Visualization Action

操作​

操作用于在消息界面中创建按钮（位于单个聊天消息下方的小按钮）。

操作有一个名为“操作函数”的独立主要组件。此组件接受一个定义操作类型和正在处理的数据的对象。

示例
async def action(
        self,
        body: dict,
        __user__=None,
        __event_emitter__=None,
        __event_call__=None,
    ) -> Optional[dict]:
        print(f"action:{__name__}")

        response = await __event_call__(
            {
                "type": "input",
                "data": {
                    "title": "write a message",
                    "message": "here write a message to append",
                    "placeholder": "enter your message",
                },
            }
        )
        print(response)

示例 - 指定操作前言​

每个操作函数都可以在顶部包含一个文档字符串（docstring）来定义按钮的元数据。这有助于自定义操作在 Open WebUI 中的显示和行为。

支持的前言字段示例

  • title: 操作的显示名称。
  • author: 创建者姓名。
  • version: 操作的版本号。
  • required_open_webui_version: Open WebUI 的最低兼容版本。
  • icon_url (可选): 自定义图标的 URL 或 Base64 字符串。

Base64 编码示例

"""
title: Summarize Text
author: @you
version: 1.0.0
required_open_webui_version: 0.5.0
icon_url: data:image/svg+xml;base64,<IMAGE STRING>...
"""