Skip to content

docs: add comprehensive component documentation #684

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
shentongmartin wants to merge 2 commits into from
Closed

docs: add comprehensive component documentation #684

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a20a1ca
docs: add comprehensive component documentation
shentongmartin Feb 4, 2026
0640bfa
Merge branch 'main' into feat/directory
JonXSnow Feb 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,25 @@ The EinoExt project hosts various extensions for the [Eino](https://github.com/c

- **component implementations**: official implementations for Eino's component types.

| component type | official implementations |
|----------------------|----------------------------------------|
| ChatModel | OpenAI, Claude, Gemini, Ark, Ollama... |
| Tool | Google Search, Duck Duck Go... |
| Retriever | Elastic Search, Volc VikingDB... |
| ChatTemplate | DefaultChatTemplate... |
| Document Loader | WebURL, Amazon S3, File... |
| Document Transformer | HTMLSplitter, ScoreReranker... |
| Indexer | Elastic Search, Volc VikingDB... |
| Embedding | OpenAI, Ark... |
| Lambda | JSONMessageParser... |
### Component Summary

| Component Type | Count | Official Implementations |
|----------------|-------|--------------------------|
| **ChatModel** | 10 | OpenAI, Claude, Gemini, Ark, ArkBot, Ollama, Qwen, Qianfan, DeepSeek, OpenRouter |
| **Embedding** | 8 | OpenAI, Ark, Gemini, Ollama, Qianfan, DashScope, TencentCloud, Cache |
| **Indexer** | 10 | Elasticsearch (7/8/9), OpenSearch (2/3), Milvus, Milvus2, Qdrant, Redis, Volc VikingDB |
| **Retriever** | 12 | Elasticsearch (7/8/9), OpenSearch (2/3), Milvus, Milvus2, Qdrant, Redis, Dify, Volc VikingDB, Volc Knowledge |
| **Tool** | 10 | Bing Search, DuckDuckGo, Google Search, Wikipedia, SearXNG, BrowserUse, Command Line, HTTP Request, MCP, Sequential Thinking |
| **Prompt** | 2 | CozeLoop, MCP |
| **Document** | 12 | File/URL/S3 Loaders, HTML/PDF/DOCX/XLSX Parsers, Recursive/HTML/Markdown/Semantic Splitters, Score Reranker |
| **Callback Handler** | 4 | APMPlus, CozeLoop, Langfuse, Langsmith |

📋 **For detailed component information (import paths, descriptions, features, and GitHub links), see [components.md](components.md)**

For more details about component types, please refer to the [Eino component documentation.](https://www.cloudwego.io/zh/docs/eino/core_modules/components/)

For more details about component implementations, please refer to the [Eino ecosystem documentation.](https://www.cloudwego.io/zh/docs/eino/ecosystem_integration/)

- **callback handlers**: official callback handlers implementing Eino's CallbackHandler interface, such as [Langfuse tracing](https://langfuse.com/docs/tracing) callback.
- **DevOps tools**: IDE plugin for Eino that enables visualized debugging, UI based graph editing and more. For more details, please refer to the [Eino Dev tooling documentation.](https://www.cloudwego.io/zh/docs/eino/core_modules/devops/)

## Security
Expand Down
25 changes: 13 additions & 12 deletions README.zh_CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,25 @@ EinoExt 项目为 [Eino](https://github.com/cloudwego/eino) 框架提供了各

- **组件实现**: Eino 组件类型的官方实现。

| 组件类型 | 官方组件实现 |
|----------------------|----------------------------------------|
| ChatModel | OpenAI, Claude, Gemini, Ark, Ollama... |
| Tool | Google Search, Duck Duck Go... |
| Retriever | Elastic Search, Volc VikingDB... |
| ChatTemplate | DefaultChatTemplate... |
| Document Loader | WebURL, Amazon S3, File... |
| Document Transformer | HTMLSplitter, ScoreReranker... |
| Indexer | Elastic Search, Volc VikingDB... |
| Embedding | OpenAI, Ark... |
| Lambda | JSONMessageParser... |
### 组件概览

| 组件类型 | 数量 | 官方实现 |
|---------|------|---------|
| **ChatModel** | 10 | OpenAI, Claude, Gemini, Ark, ArkBot, Ollama, Qwen, Qianfan, DeepSeek, OpenRouter |
| **Embedding** | 8 | OpenAI, Ark, Gemini, Ollama, Qianfan, DashScope, TencentCloud, Cache |
| **Indexer** | 10 | Elasticsearch (7/8/9), OpenSearch (2/3), Milvus, Milvus2, Qdrant, Redis, Volc VikingDB |
| **Retriever** | 12 | Elasticsearch (7/8/9), OpenSearch (2/3), Milvus, Milvus2, Qdrant, Redis, Dify, Volc VikingDB, Volc Knowledge |
| **Tool** | 10 | Bing Search, DuckDuckGo, Google Search, Wikipedia, SearXNG, BrowserUse, Command Line, HTTP Request, MCP, Sequential Thinking |
| **Prompt** | 2 | CozeLoop, MCP |
| **Document** | 12 | File/URL/S3 加载器, HTML/PDF/DOCX/XLSX 解析器, Recursive/HTML/Markdown/Semantic 分割器, Score Reranker |
| **Callback Handler** | 4 | APMPlus, CozeLoop, Langfuse, Langsmith |

📋 **查看详细的组件信息（导入路径、描述、功能特性和 GitHub 链接），请参阅 [components.md](components.md)**

有关组件类型的更多详细信息，请参阅 [Eino 组件文档.](https://www.cloudwego.io/zh/docs/eino/core_modules/components/)

有关组件实现的更多详细信息，请参阅 [Eino 生态系统文档.](https://www.cloudwego.io/zh/docs/eino/ecosystem_integration/)

- **callback handlers**: 实现 Eino 的 callbacks.Handler 接口的官方 callback handler，例如[Langfuse tracing](https://langfuse.com/docs/tracing) 回调.
- **DevOps 工具**: 用于 Eino 的 IDE 插件，支持可视化调试、基于 UI 的图形编辑等功能。更多详细信息，请参阅 [Eino Dev 工具文档.](https://www.cloudwego.io/zh/docs/eino/core_modules/devops/)

## 安全
Expand Down
Loading
Loading