Skip to content

Commit cccef3f

Browse files
committed
docs: remove duplicate YAML example and fix comments
- Simplify YAML preset example by removing redundant content - Remove "optional" wording from pgvector extension comment
1 parent 57a06f0 commit cccef3f

2 files changed

Lines changed: 2 additions & 10 deletions

File tree

README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -128,15 +128,11 @@ forego run go run . web
128128
### Prepare preset data file in YAML
129129

130130
```yaml
131-
# Simple preset
132131
welcome: "Hello, I am your virtual assistant. How can I help you?"
133132
systemPrompt: "You are a helpful assistant."
134133
toolsPrompt: "You will select the appropriate tool based on the user's question and call the tool to solve the problem."
135134

136135
# Or with custom tool descriptions
137-
welcome: "Hello, I am your virtual assistant. How can I help you?"
138-
systemPrompt: "You are a helpful assistant."
139-
toolsPrompt: "You will select the appropriate tool based on the user's question and call the tool to solve the problem."
140136
tools:
141137
kb_search: "Search documents in knowledge base with subject. When faced with unknown or uncertain issues, prioritize consulting the knowledge base."
142138
kb_create: "Create new document of knowledge base, all parameters are required. Note: Unless the user explicitly requests supplementary content, do not invoke it."
@@ -165,7 +161,7 @@ GRANT ALL PRIVILEGES ON DATABASE morign to morign;
165161
166162
\c morign
167163
168-
-- optional: install extension from https://github.com/pgvector/pgvector
164+
-- install extension from https://github.com/pgvector/pgvector
169165
CREATE EXTENSION vector;
170166
171167
```

README_CN.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -128,15 +128,11 @@ forego run go run . web
128128
### 准备 YAML 预设数据文件
129129

130130
```yaml
131-
# 简单配置
132131
welcome: "你好,我是你的虚拟助手。有什么可以帮助你的吗?"
133132
systemPrompt: "你是一位有用的助手。"
134133
toolsPrompt: "根据用户问题选择合适的工具并调用来解决问题。"
135134

136135
# 或配置自定义工具描述
137-
welcome: "你好,我是你的虚拟助手。有什么可以帮助你的吗?"
138-
systemPrompt: "你是一位有用的助手。"
139-
toolsPrompt: "根据用户的问题选择合适的工具,区分读写操作,提取必要参数进行调用,使用中文关键词进行搜索,必要时翻译英文内容。"
140136
tools:
141137
kb_search: "在知识库中搜索相关内容。当遇到未知或不确定的问题时,优先查阅知识库。"
142138
kb_create: "创建新的知识库文档,所有参数必填。注意:除非用户明确要求补充内容,否则不要调用。"
@@ -165,7 +161,7 @@ GRANT ALL PRIVILEGES ON DATABASE morign to morign;
165161
166162
\c morign
167163
168-
# 可选:安装扩展 https://github.com/pgvector/pgvector
164+
# 安装扩展 https://github.com/pgvector/pgvector
169165
CREATE EXTENSION vector;
170166
171167
```

0 commit comments

Comments
 (0)