From 7be32641c7628fffdde236c874923946744a2768 Mon Sep 17 00:00:00 2001 From: Parth Sharma <109902593+parthshr370@users.noreply.github.com> Date: Mon, 27 Oct 2025 00:19:29 +0530 Subject: [PATCH] [docs] Essential cookbook added and overall revamp to the structure of cookbooks (#3668) --- .../companions/ai-tutor.mdx} | 15 +- .../companions/local-companion-ollama.mdx} | 17 +- .../companions/nodejs-companion.mdx} | 15 +- .../companions/quickstart-demo.mdx} | 14 +- .../companions/travel-assistant.mdx} | 16 +- .../companions/voice-companion-openai.mdx} | 20 +- .../companions/youtube-research.mdx} | 15 +- .../essentials/building-ai-companion.mdx | 525 +++++++++++++++ .../building-ai-with-personality.mdx | 603 ++++++++++++++++++ .../image.png | Bin 0 -> 71066 bytes ...ng-memory-architecture-vector-vs-graph.mdx | 361 +++++++++++ .../controlling-memory-ingestion.mdx | 508 +++++++++++++++ .../essentials/exporting-memories.mdx | 289 +++++++++ .../memory-expiration-short-and-long-term.mdx | 277 ++++++++ .../tagging-and-organizing-memories.mdx | 251 ++++++++ .../frameworks}/chrome-extension.mdx | 17 +- .../frameworks/eliza-os-character.mdx} | 15 +- .../frameworks/llamaindex-multiagent.mdx} | 15 +- .../frameworks/llamaindex-react.mdx} | 15 +- .../frameworks/multimodal-retrieval.mdx} | 14 +- .../integrations/agents-sdk-tool.mdx} | 14 +- .../integrations/aws-bedrock.mdx} | 15 +- .../integrations/healthcare-google-adk.mdx} | 17 +- .../integrations/mastra-agent.mdx} | 17 +- .../integrations/neptune-analytics.mdx} | 15 +- .../integrations/openai-tool-calls.mdx} | 17 +- .../integrations/tavily-search.mdx} | 17 +- .../operations/content-writing.mdx} | 17 +- .../operations/deep-research.mdx} | 15 +- .../operations/email-automation.mdx} | 14 +- .../operations/support-inbox.mdx} | 16 +- .../operations/team-task-agent.mdx} | 15 +- docs/cookbooks/overview.mdx | 140 ++++ docs/core-concepts/memory-operations/add.mdx | 6 +- .../memory-operations/delete.mdx | 2 +- .../memory-operations/search.mdx | 6 +- .../memory-operations/update.mdx | 4 +- docs/core-concepts/memory-types.mdx | 6 +- docs/docs.json | 91 +-- docs/examples.mdx | 116 ---- docs/introduction.mdx | 2 +- docs/llms.txt | 10 +- docs/open-source/configuration.mdx | 2 +- docs/open-source/overview.mdx | 2 +- docs/open-source/python-quickstart.mdx | 2 +- docs/platform/quickstart.mdx | 2 +- 46 files changed, 3356 insertions(+), 226 deletions(-) rename docs/{examples/personal-ai-tutor.mdx => cookbooks/companions/ai-tutor.mdx} (86%) rename docs/{examples/mem0-with-ollama.mdx => cookbooks/companions/local-companion-ollama.mdx} (80%) rename docs/{examples/ai_companion_js.mdx => cookbooks/companions/nodejs-companion.mdx} (87%) rename docs/{examples/mem0-demo.mdx => cookbooks/companions/quickstart-demo.mdx} (81%) rename docs/{examples/personal-travel-assistant.mdx => cookbooks/companions/travel-assistant.mdx} (91%) rename docs/{examples/mem0-openai-voice-demo.mdx => cookbooks/companions/voice-companion-openai.mdx} (96%) rename docs/{examples/youtube-assistant.mdx => cookbooks/companions/youtube-research.mdx} (81%) create mode 100644 docs/cookbooks/essentials/building-ai-companion.mdx create mode 100644 docs/cookbooks/essentials/building-ai-with-personality.mdx create mode 100644 docs/cookbooks/essentials/building_ai_with_personality 295f22c70c908182affdfc87ec79f2db/image.png create mode 100644 docs/cookbooks/essentials/choosing-memory-architecture-vector-vs-graph.mdx create mode 100644 docs/cookbooks/essentials/controlling-memory-ingestion.mdx create mode 100644 docs/cookbooks/essentials/exporting-memories.mdx create mode 100644 docs/cookbooks/essentials/memory-expiration-short-and-long-term.mdx create mode 100644 docs/cookbooks/essentials/tagging-and-organizing-memories.mdx rename docs/{examples => cookbooks/frameworks}/chrome-extension.mdx (85%) rename docs/{examples/eliza_os.mdx => cookbooks/frameworks/eliza-os-character.mdx} (77%) rename docs/{examples/llamaindex-multiagent-learning-system.mdx => cookbooks/frameworks/llamaindex-multiagent.mdx} (96%) rename docs/{examples/llama-index-mem0.mdx => cookbooks/frameworks/llamaindex-react.mdx} (91%) rename docs/{examples/multimodal-demo.mdx => cookbooks/frameworks/multimodal-retrieval.mdx} (77%) rename docs/{examples/mem0-agentic-tool.mdx => cookbooks/integrations/agents-sdk-tool.mdx} (91%) rename docs/{examples/aws_example.mdx => cookbooks/integrations/aws-bedrock.mdx} (88%) rename docs/{examples/mem0-google-adk-healthcare-assistant.mdx => cookbooks/integrations/healthcare-google-adk.mdx} (94%) rename docs/{examples/mem0-mastra.mdx => cookbooks/integrations/mastra-agent.mdx} (87%) rename docs/{examples/aws_neptune_analytics_hybrid_store.mdx => cookbooks/integrations/neptune-analytics.mdx} (86%) rename docs/{examples/openai-inbuilt-tools.mdx => cookbooks/integrations/openai-tool-calls.mdx} (94%) rename docs/{examples/personalized-search-tavily-mem0.mdx => cookbooks/integrations/tavily-search.mdx} (92%) rename docs/{examples/memory-guided-content-writing.mdx => cookbooks/operations/content-writing.mdx} (91%) rename docs/{examples/personalized-deep-research.mdx => cookbooks/operations/deep-research.mdx} (80%) rename docs/{examples/email_processing.mdx => cookbooks/operations/email-automation.mdx} (91%) rename docs/{examples/customer-support-agent.mdx => cookbooks/operations/support-inbox.mdx} (85%) rename docs/{examples/collaborative-task-agent.mdx => cookbooks/operations/team-task-agent.mdx} (88%) create mode 100644 docs/cookbooks/overview.mdx delete mode 100644 docs/examples.mdx diff --git a/docs/examples/personal-ai-tutor.mdx b/docs/cookbooks/companions/ai-tutor.mdx similarity index 86% rename from docs/examples/personal-ai-tutor.mdx rename to docs/cookbooks/companions/ai-tutor.mdx index 4e0663bec..b63263fe2 100644 --- a/docs/examples/personal-ai-tutor.mdx +++ b/docs/cookbooks/companions/ai-tutor.mdx @@ -1,7 +1,9 @@ --- -title: Personalized AI Tutor +title: AI Tutor with Mem0 +description: "Keep student progress and preferences persistent across tutoring sessions." --- + You can create a personalized AI Tutor using Mem0. This guide will walk you through the necessary steps and provide the complete code to get you started. ## Overview @@ -110,3 +112,14 @@ for m in memories['results']: ## Conclusion As the conversation progresses, Mem0's memory automatically updates based on the interactions, providing a continuously improving personalized learning experience. This setup ensures that the AI Tutor can offer contextually relevant and accurate responses, enhancing the overall educational process. + +--- + + + + Learn the foundations of memory-powered companions with production-ready patterns. + + + Build a travel companion that remembers preferences and past conversations. + + diff --git a/docs/examples/mem0-with-ollama.mdx b/docs/cookbooks/companions/local-companion-ollama.mdx similarity index 80% rename from docs/examples/mem0-with-ollama.mdx rename to docs/cookbooks/companions/local-companion-ollama.mdx index 7f17effdd..4baed5855 100644 --- a/docs/examples/mem0-with-ollama.mdx +++ b/docs/cookbooks/companions/local-companion-ollama.mdx @@ -1,8 +1,8 @@ --- -title: Mem0 with Ollama +title: Local Companion with Mem0 and Ollama +description: "Run Mem0 end-to-end on your machine using Ollama-powered LLMs and embedders." --- -## Running Mem0 Locally with Ollama Mem0 can be utilized entirely locally by leveraging Ollama for both the embedding model and the language model (LLM). This guide will walk you through the necessary steps and provide the complete code to get you started. @@ -69,4 +69,15 @@ memories = m.get_all(user_id="john") ## Conclusion -This local setup of Mem0 using Ollama provides a fully self-contained solution for memory management and AI interactions. It allows for greater control over your data and models while still leveraging the powerful capabilities of Mem0. \ No newline at end of file +This local setup of Mem0 using Ollama provides a fully self-contained solution for memory management and AI interactions. It allows for greater control over your data and models while still leveraging the powerful capabilities of Mem0. + +--- + + + + Explore advanced configuration options for vector stores, LLMs, and embedders. + + + Learn core companion patterns that work with any LLM provider. + + diff --git a/docs/examples/ai_companion_js.mdx b/docs/cookbooks/companions/nodejs-companion.mdx similarity index 87% rename from docs/examples/ai_companion_js.mdx rename to docs/cookbooks/companions/nodejs-companion.mdx index 8222ecfa5..3e04ab16e 100644 --- a/docs/examples/ai_companion_js.mdx +++ b/docs/cookbooks/companions/nodejs-companion.mdx @@ -1,7 +1,9 @@ --- -title: AI Companion in Node.js +title: Node.js Companion with Mem0 +description: "Build a JavaScript fitness coach that remembers user goals run after run." --- + You can create a personalized AI Companion using Mem0. This guide will walk you through the necessary steps and provide the complete code to get you started. ## Overview @@ -124,3 +126,14 @@ export OPENAI_API_KEY=your_api_key This implementation demonstrates how to create an AI Companion that maintains context across conversations using Mem0's memory capabilities. The system automatically stores and retrieves relevant information, creating a more personalized and context-aware interaction experience. As users interact with the system, Mem0's memory system continuously learns and adapts, making future responses more relevant and personalized. This setup is ideal for creating long-term learning AI assistants that can maintain context and provide increasingly personalized responses over time. + +--- + + + + Separate user and agent memories to keep your companion's personality consistent. + + + Run the full showcase app to see memory-powered companions in action. + + diff --git a/docs/examples/mem0-demo.mdx b/docs/cookbooks/companions/quickstart-demo.mdx similarity index 81% rename from docs/examples/mem0-demo.mdx rename to docs/cookbooks/companions/quickstart-demo.mdx index 5286de421..48f1f136d 100644 --- a/docs/examples/mem0-demo.mdx +++ b/docs/cookbooks/companions/quickstart-demo.mdx @@ -1,7 +1,9 @@ --- -title: Mem0 Demo +title: Quickstart Demo with Mem0 +description: "Spin up the showcase companion app to see Mem0 memories in action." --- + You can create a personalized AI Companion using Mem0. This guide will walk you through the necessary steps and provide the complete setup instructions to get you started.