|
1 |
| -# MongoDB Chatbot Framework |
| 1 | +# MongoDB Knowledge Service |
2 | 2 |
|
3 |
| -The MongoDB Chatbot Framework is a set of libraries that you can use to build |
4 |
| -full-stack intelligent chatbot applications using MongoDB and [Atlas Vector Search](https://www.mongodb.com/docs/atlas/atlas-vector-search/vector-search-overview/). |
5 |
| -The MongoDB Chatbot Framework includes first class support for |
6 |
| -retrieval-augmented generation (RAG). |
| 3 | +This repo contains the work of the MongoDB Education AI team. |
7 | 4 |
|
8 |
| -The framework can take your chatbot application from prototype to production. |
| 5 | +## MongoDB Knowledge Service |
9 | 6 |
|
10 |
| -You can quickly get an AI chatbot enhanced with your data up and running using |
11 |
| -the framework's built-in data ingest process, chatbot server, and web UI. As you |
12 |
| -refine your application and scale to more users, you can modify the chatbot's |
13 |
| -behavior to meet your needs. |
| 7 | +The MongoDB Knowledge Service lets you learn about MongoDB using generative AI. To learn more about it, refer to the [MongoDB Knolwedge Service documentation](https://mongodb.github.io/chatbot) |
14 | 8 |
|
15 |
| -The framework is flexible and customizable. It supports multiple AI models and |
16 |
| -complex prompting strategies. It also includes tools for programmatic evaluation of your chatbot's AI components. |
| 9 | +## MongoDB Chatbot Framework (deprecated) |
17 | 10 |
|
18 |
| -## Documentation |
| 11 | +The team building the MongoDB Knowledge Service previous developed the MongoDB Chatbot Framework. This consisted of the npm packages: |
19 | 12 |
|
20 |
| -To learn how to use the MongoDB Chatbot Framework, refer to the documentation: |
21 |
| -<https://mongodb.github.io/chatbot/>. |
| 13 | +- `mongodb-chatbot-server` |
| 14 | +- `mongodb-chatbot-ui` (still used, refer to [UI](https://mongodb.github.io/chatbot/ui)) |
| 15 | +- `mongodb-rag-core` |
| 16 | +- `mongodb-rag-ingest` |
22 | 17 |
|
23 |
| -You can also check out the following articles and videos about the framework: |
| 18 | +The MongoDB Chatbot Framework in now deprecated. We will no longer be maintaining it. |
24 | 19 |
|
25 |
| -- [[Video] MongoDB Chatbot Framework Learning Byte](https://learn.mongodb.com/courses/mongodb-chatbot-framework) |
26 |
| -- [[Article] Build a Production-Ready, Intelligent Chatbot With the MongoDB Chatbot Framework](https://dev.to/mongodb/build-a-production-ready-intelligent-chatbot-with-the-mongodb-chatbot-framework-4dd) |
27 |
| -- [[Article] Taking RAG to Production with the MongoDB Documentation AI Chatbot](https://www.mongodb.com/developer/products/atlas/taking-rag-to-production-documentation-ai-chatbot/) |
| 20 | +To learn more about the framework, refer to the the blog post [Build a Production-Ready, Intelligent Chatbot With the MongoDB Chatbot Framework](https://dev.to/mongodb/build-a-production-ready-intelligent-chatbot-with-the-mongodb-chatbot-framework-4dd). |
28 | 21 |
|
29 |
| -## MongoDB Docs AI Chatbot Implementation |
| 22 | +### Why Deprecate the MongoDB Chatbot Framework? |
30 | 23 |
|
31 |
| -This repo also contains the implementation of the MongoDB Docs Chatbot, |
32 |
| -which uses the MongoDB Chatbot Framework. |
| 24 | +Since we first launched the framework a year and a half ago, there's been a lot of progress in the TypeScript ecosystem for AI frameworks. We have decided that these frameworks remove the need for the MongoDB Chatbot Framework. Additionally, supporting the framework in addition to the Knowledge Service has been a maintenance burden on our small team. |
33 | 25 |
|
34 |
| -The MongoDB Docs Chatbot uses the MongoDB [documentation](https://www.mongodb.com/docs/) and [Developer Center](https://www.mongodb.com/developer/) as its sources of truth. |
| 26 | +In particular, we've been very impressed by the [Vercel AI SDK](https://ai-sdk.dev/docs/introduction). It has a great developer experience, is well maintained, and a robust feature set. We've moved most of our LLM call logic to the AI SDK. You can refer to our [mongodb/chatbot repository](https://github.com/mongodb/chatbot) to see how we're using it. For a tutorial on building with MongoDB Atlas and the AI SDK, refer to the blog post [Building a Chat Application That Doesn't Forget!](https://dev.to/mongodb/building-a-chat-application-with-mongodb-memory-provider-for-vercel-ai-sdk-56ap) by MongoDB's own Jesse Hall. |
35 | 27 |
|
36 |
| -The chatbot builds on the following technologies: |
| 28 | +For building more agentic applications in TypeScript, [Mastra](https://mastra.ai/en/docs) (itself built on the AI SDK), [LangGraph.js](https://langchain-ai.github.io/langgraphjs/), and the [OpenAI Agents SDK](https://openai.github.io/openai-agents-js/) all seem to be solid options. |
37 | 29 |
|
38 |
| -- Atlas Vector Search: Indexes and queries content for use in project. |
39 |
| -- MongoDB Atlas: Persists conversations and content. |
40 |
| -- ChatGPT API: LLM to pre-process user queries and summarize responses to user queries. |
41 |
| -- OpenAI Embeddings API: Create vector embeddings for user queries and content. Used by Atlas Vector Search. |
42 |
| - |
43 |
| -To learn more about how we built the chatbot, check out the MongoDB Developer Center blog post |
44 |
| -[Taking RAG to Production with the MongoDB Documentation AI Chatbot](https://www.mongodb.com/developer/products/atlas/taking-rag-to-production-documentation-ai-chatbot/). |
45 | 30 |
|
46 | 31 | ## Contributing
|
47 | 32 |
|
|
0 commit comments