docs: 完善 _special 配置项说明并补充 select_knowledgebase 返回类型#163
Open
piexian wants to merge 2 commits intoAstrBotDevs:v4from
Open
docs: 完善 _special 配置项说明并补充 select_knowledgebase 返回类型#163piexian wants to merge 2 commits intoAstrBotDevs:v4from
piexian wants to merge 2 commits intoAstrBotDevs:v4from
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! 此拉取请求主要更新了 AstrBot 插件配置文档中关于 Highlights
Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey - I've found 2 issues
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="zh/dev/star/guides/plugin-config.md" line_range="65" />
<code_context>
-**_special** 字段仅 v4.0.0 之后可用。目前支持填写 `select_provider`, `select_provider_tts`, `select_provider_stt`, `select_persona`，用于让用户快速选择用户在 WebUI 上已经配置好的模型提供商、人设等数据。结果均为字符串。以 select_provider 为例，将呈现以下效果:
+**_special** 字段仅 v4.0.0 之后可用。常用可填写值包括 `select_provider`, `select_provider_tts`, `select_provider_stt`, `select_persona`, `select_knowledgebase`，用于让用户快速选择用户在 WebUI 上已经配置好的模型提供商、人设、知识库等数据。其中 `select_provider`、`select_provider_tts`、`select_provider_stt`、`select_persona` 的结果为字符串；`select_knowledgebase` 的结果为 `list` 类型，支持多选，建议将对应配置项的 `type` 设为 `list`，默认值设为 `[]`。此外，AstrBot Core 内部还使用了 `select_providers`、`provider_pool`、`persona_pool`、`select_plugin_set`、`t2i_template`、`get_embedding_dim`、`select_agent_runner_provider:*` 等 `_special` 值。以 `select_provider` 为例，将呈现以下效果:
</code_context>
<issue_to_address>
**suggestion (typo):** 为了让中文读起来更顺畅，避免这句话中连续两次出现“用户”。
这句话中“用户”连续出现两次，显得重复。建议改为“用于让用户快速选择在 WebUI 上已经配置好的模型提供商、人设、知识库等数据。”以提升语句流畅度。
```suggestion
**_special** 字段仅 v4.0.0 之后可用。常用可填写值包括 `select_provider`, `select_provider_tts`, `select_provider_stt`, `select_persona`, `select_knowledgebase`，用于让用户快速选择在 WebUI 上已经配置好的模型提供商、人设、知识库等数据。其中 `select_provider`、`select_provider_tts`、`select_provider_stt`、`select_persona` 的结果为字符串；`select_knowledgebase` 的结果为 `list` 类型，支持多选，建议将对应配置项的 `type` 设为 `list`，默认值设为 `[]`。此外，AstrBot Core 内部还使用了 `select_providers`、`provider_pool`、`persona_pool`、`select_plugin_set`、`t2i_template`、`get_embedding_dim`、`select_agent_runner_provider:*` 等 `_special` 值。以 `select_provider` 为例，将呈现以下效果:
```
</issue_to_address>
### Comment 2
<location path="zh/dev/star/plugin.md" line_range="786" />
<code_context>
-**_special** 字段仅 v4.0.0 之后可用。目前支持填写 `select_provider`, `select_provider_tts`, `select_provider_stt`, `select_persona`，用于让用户快速选择用户在 WebUI 上已经配置好的模型提供商、人设等数据。结果均为字符串。以 select_provider 为例，将呈现以下效果:
+**_special** 字段仅 v4.0.0 之后可用。常用可填写值包括 `select_provider`, `select_provider_tts`, `select_provider_stt`, `select_persona`, `select_knowledgebase`，用于让用户快速选择用户在 WebUI 上已经配置好的模型提供商、人设、知识库等数据。其中 `select_provider`、`select_provider_tts`、`select_provider_stt`、`select_persona` 的结果为字符串；`select_knowledgebase` 的结果为 `list` 类型，支持多选，建议将对应配置项的 `type` 设为 `list`，默认值设为 `[]`。此外，AstrBot Core 内部还使用了 `select_providers`、`provider_pool`、`persona_pool`、`select_plugin_set`、`t2i_template`、`get_embedding_dim`、`select_agent_runner_provider:*` 等 `_special` 值。以 `select_provider` 为例，将呈现以下效果:
</code_context>
<issue_to_address>
**suggestion (typo):** 重复使用“用户”会让这句话读起来有些别扭，建议去掉第二个“用户”。
建议改为“用于让用户快速选择在 WebUI 上已经配置好的模型提供商、人设、知识库等数据。”以避免“用户”重复，使语句更自然顺畅。
```suggestion
**_special** 字段仅 v4.0.0 之后可用。常用可填写值包括 `select_provider`, `select_provider_tts`, `select_provider_stt`, `select_persona`, `select_knowledgebase`，用于让用户快速选择在 WebUI 上已经配置好的模型提供商、人设、知识库等数据。其中 `select_provider`、`select_provider_tts`、`select_provider_stt`、`select_persona` 的结果为字符串；`select_knowledgebase` 的结果为 `list` 类型，支持多选，建议将对应配置项的 `type` 设为 `list`，默认值设为 `[]`。此外，AstrBot Core 内部还使用了 `select_providers`、`provider_pool`、`persona_pool`、`select_plugin_set`、`t2i_template`、`get_embedding_dim`、`select_agent_runner_provider:*` 等 `_special` 值。以 `select_provider` 为例，将呈现以下效果:
```
</issue_to_address>帮我变得更有用！请在每条评论上点击 👍 或 👎，我会根据你的反馈改进后续的评审。
Original comment in English
Hey - I've found 2 issues
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="zh/dev/star/guides/plugin-config.md" line_range="65" />
<code_context>
-**_special** 字段仅 v4.0.0 之后可用。目前支持填写 `select_provider`, `select_provider_tts`, `select_provider_stt`, `select_persona`，用于让用户快速选择用户在 WebUI 上已经配置好的模型提供商、人设等数据。结果均为字符串。以 select_provider 为例，将呈现以下效果:
+**_special** 字段仅 v4.0.0 之后可用。常用可填写值包括 `select_provider`, `select_provider_tts`, `select_provider_stt`, `select_persona`, `select_knowledgebase`，用于让用户快速选择用户在 WebUI 上已经配置好的模型提供商、人设、知识库等数据。其中 `select_provider`、`select_provider_tts`、`select_provider_stt`、`select_persona` 的结果为字符串；`select_knowledgebase` 的结果为 `list` 类型，支持多选，建议将对应配置项的 `type` 设为 `list`，默认值设为 `[]`。此外，AstrBot Core 内部还使用了 `select_providers`、`provider_pool`、`persona_pool`、`select_plugin_set`、`t2i_template`、`get_embedding_dim`、`select_agent_runner_provider:*` 等 `_special` 值。以 `select_provider` 为例，将呈现以下效果:
</code_context>
<issue_to_address>
**suggestion (typo):** Avoid repeating “用户” twice in succession in this sentence for smoother Chinese.
这句话中“用户”连续出现两次，显得重复。建议改为“用于让用户快速选择在 WebUI 上已经配置好的模型提供商、人设、知识库等数据。”以提升语句流畅度。
```suggestion
**_special** 字段仅 v4.0.0 之后可用。常用可填写值包括 `select_provider`, `select_provider_tts`, `select_provider_stt`, `select_persona`, `select_knowledgebase`，用于让用户快速选择在 WebUI 上已经配置好的模型提供商、人设、知识库等数据。其中 `select_provider`、`select_provider_tts`、`select_provider_stt`、`select_persona` 的结果为字符串；`select_knowledgebase` 的结果为 `list` 类型，支持多选，建议将对应配置项的 `type` 设为 `list`，默认值设为 `[]`。此外，AstrBot Core 内部还使用了 `select_providers`、`provider_pool`、`persona_pool`、`select_plugin_set`、`t2i_template`、`get_embedding_dim`、`select_agent_runner_provider:*` 等 `_special` 值。以 `select_provider` 为例，将呈现以下效果:
```
</issue_to_address>
### Comment 2
<location path="zh/dev/star/plugin.md" line_range="786" />
<code_context>
-**_special** 字段仅 v4.0.0 之后可用。目前支持填写 `select_provider`, `select_provider_tts`, `select_provider_stt`, `select_persona`，用于让用户快速选择用户在 WebUI 上已经配置好的模型提供商、人设等数据。结果均为字符串。以 select_provider 为例，将呈现以下效果:
+**_special** 字段仅 v4.0.0 之后可用。常用可填写值包括 `select_provider`, `select_provider_tts`, `select_provider_stt`, `select_persona`, `select_knowledgebase`，用于让用户快速选择用户在 WebUI 上已经配置好的模型提供商、人设、知识库等数据。其中 `select_provider`、`select_provider_tts`、`select_provider_stt`、`select_persona` 的结果为字符串；`select_knowledgebase` 的结果为 `list` 类型，支持多选，建议将对应配置项的 `type` 设为 `list`，默认值设为 `[]`。此外，AstrBot Core 内部还使用了 `select_providers`、`provider_pool`、`persona_pool`、`select_plugin_set`、`t2i_template`、`get_embedding_dim`、`select_agent_runner_provider:*` 等 `_special` 值。以 `select_provider` 为例，将呈现以下效果:
</code_context>
<issue_to_address>
**suggestion (typo):** The repeated “用户” makes the sentence slightly awkward; consider removing the second occurrence.
建议改为“用于让用户快速选择在 WebUI 上已经配置好的模型提供商、人设、知识库等数据。”以避免“用户”重复，使语句更自然顺畅。
```suggestion
**_special** 字段仅 v4.0.0 之后可用。常用可填写值包括 `select_provider`, `select_provider_tts`, `select_provider_stt`, `select_persona`, `select_knowledgebase`，用于让用户快速选择在 WebUI 上已经配置好的模型提供商、人设、知识库等数据。其中 `select_provider`、`select_provider_tts`、`select_provider_stt`、`select_persona` 的结果为字符串；`select_knowledgebase` 的结果为 `list` 类型，支持多选，建议将对应配置项的 `type` 设为 `list`，默认值设为 `[]`。此外，AstrBot Core 内部还使用了 `select_providers`、`provider_pool`、`persona_pool`、`select_plugin_set`、`t2i_template`、`get_embedding_dim`、`select_agent_runner_provider:*` 等 `_special` 值。以 `select_provider` 为例，将呈现以下效果:
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
本次 PR 主要是完善了 _special 配置项的文档说明，并补充了 select_knowledgebase 的返回类型信息。文档的更新内容清晰且有帮助。我发现几处可以进一步改进的地方以提高文档的可读性：更新后的说明段落内容较长，信息密集，我建议将其拆分。此外，在 zh/dev/star/plugin.md 文件中，引用的示例图片似乎不正确。我已经针对这些问题提出了具体的修改建议。
Note: Security Review has been skipped due to the limited scope of the PR.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by Sourcery
在插件配置指南中补充文档，说明额外的
_special配置选项，并澄清select_knowledgebase的返回类型。文档更新：
select_knowledgebase返回列表、支持多选，并且在插件配置文档中应与type: list和空列表默认值一起使用。_special值，包括知识库相关，以及各种与 provider 和 pool 相关的选项。Original summary in English
Summary by Sourcery
Document additional
_specialconfiguration options and clarify return types forselect_knowledgebasein plugin configuration guides.Documentation:
select_knowledgebasereturns a list, supports multi-select, and should be paired withtype: listand an empty list default in plugin config docs._specialvalues, including knowledge base and various provider- and pool-related options, in both English and Chinese plugin documentation.