Skip to content

Commit 5d90376

Browse files
committed
docs: update README and AGENTS for LLM provider changes
- Add agent command documentation - Add Provider Type configuration (openai/anthropic/openrouter/ollama) - Update tech stack to reflect custom LLM implementation
1 parent c773526 commit 5d90376

2 files changed

Lines changed: 41 additions & 3 deletions

File tree

AGENTS.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Morrigan 是一个基于 PostgreSQL + Redis 的知识库系统后端,用于 AI
2121
- **Web 框架**: chi/v5
2222
- **数据库**: PostgreSQL (含 vector 扩展)
2323
- **缓存/会话**: Redis
24-
- **AI SDK**: github.com/sashabaranov/go-openai (deprecated, use pkg/services/llm)
24+
- **LLM**: 自定义实现 (pkg/services/llm),支持 OpenAI/Anthropic/OpenRouter/Ollama
2525
- **MCP**: github.com/mark3labs/mcp-go
2626
- **ORM**: github.com/uptrace/bun
2727

@@ -84,9 +84,16 @@ Morrigan 是一个基于 PostgreSQL + Redis 的知识库系统后端,用于 AI
8484
8585
### main.go
8686
87-
- 定义 CLI 命令: `initdb`, `import`, `embedding`, `web`, `usage`, `version`
87+
- 定义 CLI 命令: `initdb`, `import`, `embedding`, `agent`, `web`, `usage`, `version`
8888
- 启动 Web 服务器逻辑
8989
90+
### pkg/services/llm/
91+
92+
- LLM 统一客户端接口,支持多种 Provider
93+
- `Client` 接口: `Chat`, `StreamChat`, `Generate`, `Embedding`
94+
- 支持的 Provider: `openai`, `anthropic`, `openrouter`, `ollama`
95+
- `anthropic.go`: Anthropic Provider 实现,包含流式响应支持
96+
9097
### pkg/web/server.go
9198
9299
- Web 服务器主文件

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,7 @@ COMMANDS:
189189
import import documents from a csv
190190
export export documents to csv/jsonl
191191
embedding, embedding-prompt read prompt documents and embedding
192+
agent, llm, chat test LLM agent
192193
web, run run a web server
193194
version, ver show version
194195
help, h Shows a list of commands or help for one command
@@ -198,6 +199,26 @@ GLOBAL OPTIONS:
198199
199200
```
200201

202+
#### Agent Command
203+
204+
测试 LLM 功能的命令行工具:
205+
206+
```bash
207+
# 非流式对话
208+
forego run go run . agent -m "你好"
209+
210+
# 流式对话
211+
forego run go run . agent -m "你好" -s
212+
213+
# 显示详细日志
214+
forego run go run . agent -m "你好" -v
215+
```
216+
217+
参数:
218+
- `-m, --message`: 发送的消息 (必填)
219+
- `-s, --stream`: 启用流式响应
220+
- `-v, --verbose`: 显示日志 (默认关闭)
221+
201222

202223
### Change settings with environment
203224

@@ -249,22 +270,32 @@ HTTPS_PROXY=socks5://proxy.my-company.xyz:1081
249270

250271
#### Provider Configuration (AI Services)
251272

252-
Each provider requires `API_KEY` and `MODEL`, optional `URL` for custom endpoints:
273+
Each provider requires `API_KEY` and `MODEL`, optional `URL` and `TYPE` for custom endpoints:
253274

254275
| Provider | Purpose | Required Variables |
255276
|----------|---------|-------------------|
256277
| `INTERACT` | Chat/completion | `API_KEY`, `MODEL` |
257278
| `EMBEDDING` | Vector embedding | `API_KEY`, `MODEL` |
258279
| `SUMMARIZE` | Text summarization | `API_KEY`, `MODEL` |
259280

281+
支持的 Provider Type: `openai`, `anthropic`, `openrouter`, `ollama`
282+
260283
Example:
261284
```
285+
# Interact provider (支持 openai/anthropic/openrouter/ollama)
262286
MORRIGAN_INTERACT_API_KEY=sk-xxx
263287
MORRIGAN_INTERACT_MODEL=gpt-4o-mini
288+
MORRIGAN_INTERACT_TYPE=openai # 可选,默认 openai
289+
290+
# 使用 Anthropic
291+
MORRIGAN_INTERACT_TYPE=anthropic
292+
MORRIGAN_INTERACT_MODEL=claude-3-5-sonnet
264293
294+
# Embedding provider
265295
MORRIGAN_EMBEDDING_API_KEY=sk-xxx
266296
MORRIGAN_EMBEDDING_MODEL=text-embedding-3-small
267297
298+
# Summarize provider
268299
MORRIGAN_SUMMARIZE_API_KEY=sk-xxx
269300
MORRIGAN_SUMMARIZE_MODEL=gpt-4o-mini
270301
```

0 commit comments

Comments
 (0)