Framework for orchestrating role-playing, autonomous AI agents. By fostering collaborative intelligence, CrewAI empowers agents to work together seamlessly, tackling complex tasks.
docs: fix long term memory class name in examples (#2049)
devin-ai-integration[bot]d6d98ee96950
diff --git a/docs/concepts/memory.mdx b/docs/concepts/memory.mdxindex 33df47b82..8db1fe33a 100644--- a/docs/concepts/memory.mdx+++ b/docs/concepts/memory.mdx@@ -58,41 +58,107 @@ my_crew = Crew(### Example: Use Custom Memory Instances e.g FAISS as the VectorDB```python Code-from crewai import Crew, Agent, Task, Process+from crewai import Crew, Process+from crewai.memory import LongTermMemory, ShortTermMemory, EntityMemory+from crewai.memory.storage import LTMSQLiteStorage, RAGStorage+from typing import List, Optional# Assemble your crew with memory capabilities-my_crew = Crew(- agents=[...],- tasks=[...],- process="Process.sequential",- memory=True,- long_term_memory=EnhanceLongTermMemory(+my_crew: Crew = Crew(+ agents = [...],+ tasks = [...],+ process = Process.sequential,+ memory = True,+ # Long-term memory for persistent storage across sessions+ long_term_memory = LongTermMemory(storage=LTMSQLiteStorage(- db_path="/my_data_dir/my_crew1/long_term_memory_storage.db"+ db_path="/my_crew1/long_term_memory_storage.db")),- short_term_memory=EnhanceShortTermMemory(- storage=CustomRAGStorage(- crew_name="my_crew",- storage_type="short_term",- data_dir="//my_data_dir",- model=embedder["model"],- dimension=embedder["dimension"],+ # Short-term memory for current context using RAG+ short_term_memory = ShortTermMemory(+ storage = RAGStorage(+ embedder_config={+ "provider": "openai",+ "config": {+ "model": 'text-embedding-3-small'+ }+ },+ type="short_term",+ path="/my_crew1/"+ )),),- entity_memory=EnhanceEntityMemory(- storage=CustomRAGStorage(- crew_name="my_crew",- storage_type="entities",- data_dir="//my_data_dir",- model=embedder["model"],- dimension=embedder["dimension"],- ),+ # Entity memory for tracking key information about entities+ entity_memory = EntityMemory(+ storage=RAGStorage(+ embedder_config={+ "provider": "openai",+ "config": {+ "model": 'text-embedding-3-small'+ }+ },+ type="short_term",+ path="/my_crew1/"+ )),verbose=True,)```+## Security Considerations++When configuring memory storage:+- Use environment variables for storage paths (e.g., `CREWAI_STORAGE_DIR`)+- Never hardcode sensitive information like database credentials+- Consider access permissions for storage directories+- Use relative paths when possible to maintain portability++Example using environment variables:+```python+import os+from crewai import Crew+from crewai.memory import LongTermMemory+from crewai.memory.storage import LTMSQLiteStorage++# Configure storage path using environment variable+storage_path = os.getenv("CREWAI_STORAGE_DIR", "./storage")+crew = Crew(+ memory=True,+ long_term_memory=LongTermMemory(+ storage=LTMSQLiteStorage(+ db_path="{storage_path}/memory.db".format(storage_path=storage_path)+ )+ )+)+```++## Configuration Examples++### Basic Memory Configuration+```python+from crewai import Crew+from crewai.memory import LongTermMemory++# Simple memory configuration+crew = Crew(memory=True) # Uses default storage locations+```++### Custom Storage Configuration+```python+from crewai import Crew+from crewai.memory import LongTermMemory+from crewai.memory.storage import LTMSQLiteStorage++# Configure custom storage paths+crew = Crew(+ memory=True,+ long_term_memory=LongTermMemory(+ storage=LTMSQLiteStorage(db_path="./memory.db")+ )+)+```+## Integrating Mem0 for Enhanced User Memory[Mem0](https://mem0.ai/) is a self-improving memory layer for LLM applications, enabling personalized AI experiences.