|
1 |
| -# byorg-ai - chatbot application framework |
| 1 | +# byorg.ai - Chatbot Application Framework |
2 | 2 |
|
3 |
| -[Docs](https://callstack.github.io/byorg-ai/) |
| 3 | +[Our Docs](https://byorg.ai) |
4 | 4 |
|
5 | 5 | ## Structure
|
6 | 6 |
|
7 |
| -### byorg-ai framework |
| 7 | +### byorg.ai framework |
8 | 8 |
|
9 | 9 | Packages:
|
10 | 10 |
|
11 |
| -- `packages/core` - contains the core logic for the chatbot framework |
12 |
| -- `packages/slack` - contains the logic for the slack integration |
13 |
| -- `packages/discord` - contains the logic for the discord integration |
14 |
| -- `packages/utils` - contains the utility functions (e.g. logger) |
15 |
| -- `packages/document-loaders` - contains the document loaders (e.g. for Google Drive, Notion, etc.) |
16 |
| -- `packages/slack-rich-text` - custom Markdown renderer for Slack Blocks/Rich Text format |
| 11 | +- `packages/core` - Frontend-agnostic chatbot logic (application, middlewares, effects) |
| 12 | +- `packages/slack` - Slack frontend integration |
| 13 | +- `packages/discord` - Discord frontend integration |
| 14 | +- `packages/utils` - Utility functions (e.g. logger) |
| 15 | +- `packages/document-loaders` - Document loaders: Google Docs, Notion, PDF, etc.) |
| 16 | +- `packages/slack-rich-text` - Markdown renderer to/from Slack Blocks format |
17 | 17 |
|
18 |
| -## byorg-ai framework key concepts (`core` package) |
| 18 | +## byorg.ai key concepts (`core` package) |
19 | 19 |
|
20 | 20 | - `Application` (message processor) - pipeline for processing messages from the user. In starts with conversation history (e.g. for Slack), then in passes the message through a series of middleware and finally to AI provider (e.g. OpenAI) which produces the response.
|
21 | 21 | - `Middleware` - a middleware is a function that processes the message before it is passed to the AI provider. It is used to add custom logic to the message processing pipeline.
|
|
0 commit comments