mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-07 15:18:29 +00:00
docs: Add memory configuration documentation
Co-Authored-By: Joe Moura <joao@crewai.com>
This commit is contained in:
36
docs/memory.md
Normal file
36
docs/memory.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# Memory Management in CrewAI
|
||||
|
||||
CrewAI provides a robust memory system that allows agents to store and retrieve information across conversations and tasks.
|
||||
|
||||
## Memory Types
|
||||
|
||||
- **Short Term Memory**: Stores recent interactions and context
|
||||
- **Long Term Memory**: Persists important information for extended periods
|
||||
- **Entity Memory**: Tracks information about specific entities
|
||||
|
||||
## Configuration
|
||||
|
||||
### Embedding Providers
|
||||
|
||||
CrewAI supports multiple embedding providers for memory storage. By default, it uses OpenAI, but you can configure different providers:
|
||||
|
||||
```bash
|
||||
# OpenAI (default)
|
||||
export CREWAI_EMBEDDING_PROVIDER=openai
|
||||
export CREWAI_EMBEDDING_MODEL=text-embedding-3-small
|
||||
export OPENAI_API_KEY=your_key
|
||||
|
||||
# Ollama
|
||||
export CREWAI_EMBEDDING_PROVIDER=ollama
|
||||
export CREWAI_EMBEDDING_MODEL=llama2
|
||||
export CREWAI_OLLAMA_URL=http://localhost:11434/api/embeddings # Optional
|
||||
```
|
||||
|
||||
### Memory Operations
|
||||
|
||||
Reset all memories:
|
||||
```bash
|
||||
crewai reset-memories -a
|
||||
```
|
||||
|
||||
The memory system will use the configured embedding provider for all operations, including memory reset.
|
||||
Reference in New Issue
Block a user