Update READMEs: add Copilot adapter, contributors section
This commit is contained in:
parent
3ae8011673
commit
7acd450707
13
README.md
13
README.md
|
|
@ -21,7 +21,7 @@ Build AI agent teams that work together. One agent plans, another implements, a
|
||||||
npm install @jackchen_me/open-multi-agent
|
npm install @jackchen_me/open-multi-agent
|
||||||
```
|
```
|
||||||
|
|
||||||
Set `ANTHROPIC_API_KEY` (and optionally `OPENAI_API_KEY`) in your environment.
|
Set `ANTHROPIC_API_KEY` (and optionally `OPENAI_API_KEY` or `GITHUB_TOKEN` for Copilot) in your environment.
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { OpenMultiAgent } from '@jackchen_me/open-multi-agent'
|
import { OpenMultiAgent } from '@jackchen_me/open-multi-agent'
|
||||||
|
|
@ -160,7 +160,7 @@ const result = await agent.run('Find the three most recent TypeScript releases.'
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary><b>Multi-Model Teams</b> — mix Claude and GPT in one workflow</summary>
|
<summary><b>Multi-Model Teams</b> — mix Claude, GPT, and Copilot in one workflow</summary>
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
const claudeAgent: AgentConfig = {
|
const claudeAgent: AgentConfig = {
|
||||||
|
|
@ -246,6 +246,7 @@ for await (const event of agent.stream('Explain monads in two sentences.')) {
|
||||||
│ - prompt() │───►│ LLMAdapter │
|
│ - prompt() │───►│ LLMAdapter │
|
||||||
│ - stream() │ │ - AnthropicAdapter │
|
│ - stream() │ │ - AnthropicAdapter │
|
||||||
└────────┬──────────┘ │ - OpenAIAdapter │
|
└────────┬──────────┘ │ - OpenAIAdapter │
|
||||||
|
│ │ - CopilotAdapter │
|
||||||
│ └──────────────────────┘
|
│ └──────────────────────┘
|
||||||
┌────────▼──────────┐
|
┌────────▼──────────┐
|
||||||
│ AgentRunner │ ┌──────────────────────┐
|
│ AgentRunner │ ┌──────────────────────┐
|
||||||
|
|
@ -269,7 +270,7 @@ for await (const event of agent.stream('Explain monads in two sentences.')) {
|
||||||
|
|
||||||
Issues, feature requests, and PRs are welcome. Some areas where contributions would be especially valuable:
|
Issues, feature requests, and PRs are welcome. Some areas where contributions would be especially valuable:
|
||||||
|
|
||||||
- **LLM Adapters** — Ollama, llama.cpp, vLLM, Gemini. The `LLMAdapter` interface requires just two methods: `chat()` and `stream()`.
|
- **LLM Adapters** — Copilot is now supported out of the box. Additional adapters for Ollama, llama.cpp, vLLM, and Gemini are welcome. The `LLMAdapter` interface requires just two methods: `chat()` and `stream()`.
|
||||||
- **Examples** — Real-world workflows and use cases.
|
- **Examples** — Real-world workflows and use cases.
|
||||||
- **Documentation** — Guides, tutorials, and API docs.
|
- **Documentation** — Guides, tutorials, and API docs.
|
||||||
|
|
||||||
|
|
@ -277,6 +278,12 @@ Issues, feature requests, and PRs are welcome. Some areas where contributions wo
|
||||||
|
|
||||||
[](https://star-history.com/#JackChen-me/open-multi-agent&Date)
|
[](https://star-history.com/#JackChen-me/open-multi-agent&Date)
|
||||||
|
|
||||||
|
## Contributors
|
||||||
|
|
||||||
|
<a href="https://github.com/JackChen-me/open-multi-agent/graphs/contributors">
|
||||||
|
<img src="https://contrib.rocks/image?repo=JackChen-me/open-multi-agent" />
|
||||||
|
</a>
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
MIT
|
MIT
|
||||||
|
|
|
||||||
13
README_zh.md
13
README_zh.md
|
|
@ -21,7 +21,7 @@
|
||||||
npm install @jackchen_me/open-multi-agent
|
npm install @jackchen_me/open-multi-agent
|
||||||
```
|
```
|
||||||
|
|
||||||
在环境变量中设置 `ANTHROPIC_API_KEY`(以及可选的 `OPENAI_API_KEY`)。
|
在环境变量中设置 `ANTHROPIC_API_KEY`(以及可选的 `OPENAI_API_KEY` 或用于 Copilot 的 `GITHUB_TOKEN`)。
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { OpenMultiAgent } from '@jackchen_me/open-multi-agent'
|
import { OpenMultiAgent } from '@jackchen_me/open-multi-agent'
|
||||||
|
|
@ -160,7 +160,7 @@ const result = await agent.run('Find the three most recent TypeScript releases.'
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary><b>多模型团队</b> — 在一个工作流中混合使用 Claude 和 GPT</summary>
|
<summary><b>多模型团队</b> — 在一个工作流中混合使用 Claude、GPT 和 Copilot</summary>
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
const claudeAgent: AgentConfig = {
|
const claudeAgent: AgentConfig = {
|
||||||
|
|
@ -246,6 +246,7 @@ for await (const event of agent.stream('Explain monads in two sentences.')) {
|
||||||
│ - prompt() │───►│ LLMAdapter │
|
│ - prompt() │───►│ LLMAdapter │
|
||||||
│ - stream() │ │ - AnthropicAdapter │
|
│ - stream() │ │ - AnthropicAdapter │
|
||||||
└────────┬──────────┘ │ - OpenAIAdapter │
|
└────────┬──────────┘ │ - OpenAIAdapter │
|
||||||
|
│ │ - CopilotAdapter │
|
||||||
│ └──────────────────────┘
|
│ └──────────────────────┘
|
||||||
┌────────▼──────────┐
|
┌────────▼──────────┐
|
||||||
│ AgentRunner │ ┌──────────────────────┐
|
│ AgentRunner │ ┌──────────────────────┐
|
||||||
|
|
@ -269,7 +270,7 @@ for await (const event of agent.stream('Explain monads in two sentences.')) {
|
||||||
|
|
||||||
欢迎提 Issue、功能需求和 PR。以下方向的贡献尤其有价值:
|
欢迎提 Issue、功能需求和 PR。以下方向的贡献尤其有价值:
|
||||||
|
|
||||||
- **LLM 适配器** — Ollama、llama.cpp、vLLM、Gemini。`LLMAdapter` 接口只需实现两个方法:`chat()` 和 `stream()`。
|
- **LLM 适配器** — Copilot 已原生支持。欢迎继续贡献 Ollama、llama.cpp、vLLM、Gemini 等适配器。`LLMAdapter` 接口只需实现两个方法:`chat()` 和 `stream()`。
|
||||||
- **示例** — 真实场景的工作流和用例。
|
- **示例** — 真实场景的工作流和用例。
|
||||||
- **文档** — 指南、教程和 API 文档。
|
- **文档** — 指南、教程和 API 文档。
|
||||||
|
|
||||||
|
|
@ -277,6 +278,12 @@ for await (const event of agent.stream('Explain monads in two sentences.')) {
|
||||||
|
|
||||||
[](https://star-history.com/#JackChen-me/open-multi-agent&Date)
|
[](https://star-history.com/#JackChen-me/open-multi-agent&Date)
|
||||||
|
|
||||||
|
## 贡献者
|
||||||
|
|
||||||
|
<a href="https://github.com/JackChen-me/open-multi-agent/graphs/contributors">
|
||||||
|
<img src="https://contrib.rocks/image?repo=JackChen-me/open-multi-agent" />
|
||||||
|
</a>
|
||||||
|
|
||||||
## 许可证
|
## 许可证
|
||||||
|
|
||||||
MIT
|
MIT
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue