完善配置信息
目录
修改清单文件
插件目录下的manifest.yaml文件声明了插件的基础信息，这些信息会被展示到 LangBot UI 或插件市场等界面上。
apiVersion: v1 # 请勿修改
kind: Plugin # 请勿修改
metadata:
author: RockChinQ # 作者，符合正则表达式 ^[a-zA-Z0-9_-]+$
name: HelloPlugin # 插件名称，用于区分插件，符合正则表达式 ^[a-zA-Z0-9-]+$
repository: 'https://github.com/langbot-app/HelloPlugin' # 插件仓库地址
version: 0.1.0 # 插件版本
description:
en_US: 'Hello LangBot Plugin' # 插件描述，多语言
zh_Hans: 'Hello LangBot Plugin'
label:
en_US: HelloPlugin # 插件标签，用于在界面上展示，多语言
zh_Hans: HelloPlugin
icon: assets/icon.svg # 插件图标，默认使用 assets/icon.svg，可自行替换，支持各种图片格式
spec:
config: [] # 插件所需配置项格式
components: {} # 插件组件列表，无需手动修改
execution:
python:
path: main.py # 请勿修改
attr: HelloPlugin # 请勿修改插件多语言遵循 RFC 4646 标准，目前支持的语言有：
en_US英文zh_Hans简体中文zh_Hant繁体中文ja_JP日语
插件配置项格式
在 manifest.yaml 文件中，spec.config 声明的字段将在 LangBot 渲染成配置项表单由用户填写，插件可通过 SDK 提供的 API 获取用户填写的配置项（见后文）。
例如：
spec:
config:
- name: github_token # 必填；配置项名称，用于在插件中获取
type: string # 必填；配置项类型，支持 string, integer, float, boolean, select, prompt-editor, llm-model-selector, bot-selector 等
label: # 必填；配置项显示名称，支持多语言。语言代码采用 RFC 4646 标准。
en_US: Github Token
zh_Hans: Github Token
description: # 配置项描述，支持多语言。可选。
en_US: Image downloading requires a Github token
zh_Hans: 如果不填的话，图片可能会下载失败
default: '' # 配置项默认值，可选。
required: false # 配置项是否必填，可选。
- name: mode
type: select
...配置项支持的各个类型及字段如下：
type: string
字符串。
- name: api_key
type: string
...type: array[string]
字符串数组。
- name: tags
type: array[string]
...type: integer
整数。
- name: progress
type: integer
...type: float
浮点数。
- name: temperature
type: float
...type: boolean
布尔值。
- name: is_enabled
type: boolean
...type: select
下拉框。需要配置 options 选项，表示下拉框的选项。
- name: mode
type: select
options: # 下拉框选项，支持多语言。
- name: mode1 # 值
label: # 显示名称，支持多语言。
en_US: Mode 1
zh_Hans: 模式 1
- name: mode2
label: # 显示名称，支持多语言。
en_US: Mode 2
zh_Hans: 模式 2
...type: prompt-editor
提示词编辑器。会展示一个流水线配置页面的提示词编辑器，最终结果表示为 OpenAI 的 messages 格式。
- name: prompt
type: prompt-editor
...type: text
大段文本。前端渲染为 textarea 以供用户输入，最终以 string 类型传递给插件。
- name: prompt
type: text
...type: file
文件上传。支持最大 10MB 的文件上传，最终以 {"file_key": "xxxxx.xxx", "mimetype": "xxxxx"} 格式传递给插件。插件可使用 get_config_file API 获取文件内容。
- name: config_file
type: file
accept: 'application/json' # 可选，指定接受的文件 MIME 类型
...在插件中获取文件：
# 从配置中获取文件信息
file_config = self.get_config()['config_file']
file_key = file_config['file_key']
mimetype = file_config['mimetype']
# {'file_input': {'file_key': 'plugin_config_d2234fd802054faf80babe0679a97fa9.json', 'mimetype': 'application/json'}}
print(file_config)
# 获取文件内容
file_bytes = await self.get_config_file(file_key)INFO
常见 mimetype 与文件扩展名对应参考：mdn 文档
type: array[file]
多文件上传。与 file 类型类似，但支持上传多个文件，最终以 [{"file_key": "xxxxx.xxx", "mimetype": "xxxxx"}] 格式传递给插件。
- name: resource_files
type: array[file]
accept: 'image/*' # 可选，指定接受的文件 MIME 类型
...在插件中获取文件：
# 从配置中获取文件列表
files_config = self.get_config()['resource_files']
for file_config in files_config:
file_key = file_config['file_key']
mimetype = file_config['mimetype']
# 获取文件内容
file_bytes = await self.get_config_file(file_key)type: llm-model-selector
LLM 模型选择器。会展示一个 LLM 模型选择器，可选择已配置的 LLM 模型，最终结果表示为 LLM 模型 uuid。
- name: model
type: llm-model-selector
...type: bot-selector
Bot 选择器。会展示一个 Bot 选择器，可选择已配置的 Bot，最终结果表示为 Bot uuid。
- name: bot
type: bot-selector
...在插件中使用 Bot uuid：
# 从配置中获取 Bot UUID
bot_uuid = self.get_config()['bot']
print(bot_uuid) # 输出: '550e8400-e29b-41d4-a716-446655440000'接下来做什么
该教程将指引您逐步完善插件功能。
- 添加组件：插件组件是插件的核心功能单元，您可以根据需求添加组件。