Skip to content
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

add readme #52

Merged
merged 1 commit into from
Jan 15, 2025
Merged

add readme #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,29 @@ English | [中文](README.zh_CN.md)

## Overview

The EinoExt project hosts various extensions for the [Eino](https://github.com/cloudwego/eino) framework. Eino framework is a powerful and flexible framework for building LLM applications. The extensions include:

- **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... |

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 DevOps tooling documentation.](https://www.cloudwego.io/zh/docs/eino/core_modules/application_development_toolchain/)

## Security

If you discover a potential security issue in this project, or think you may
Expand Down
23 changes: 22 additions & 1 deletion README.zh_CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,28 @@

## 详细文档

// TODO：链接用户手册等文档
EinoExt 项目为 [Eino](https://github.com/cloudwego/eino) 框架提供了各种扩展。Eino 框架是一个功能强大且灵活的用于构建大语言模型（LLM）应用程序的框架。这些扩展包括：

- **组件实现**: 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... |

有关组件类型的更多详细信息，请参阅 [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 DevOps 工具文档.](https://www.cloudwego.io/zh/docs/eino/core_modules/application_development_toolchain/)

## 安全

Expand Down
Loading