Framework for orchestrating role-playing, autonomous AI agents. By fostering collaborative intelligence, CrewAI empowers agents to work together seamlessly, tackling complex tasks.
docs: add storage providers section, export JsonProvider
Greyson LaLondef98dde6c62b6
diff --git a/docs/ar/concepts/checkpointing.mdx b/docs/ar/concepts/checkpointing.mdxindex 442a98bea..4fa3665dd 100644--- a/docs/ar/concepts/checkpointing.mdx+++ b/docs/ar/concepts/checkpointing.mdx@@ -144,6 +144,51 @@ agent = Agent(result = agent.kickoff(messages=[{"role": "user", "content": "Research AI trends"}])```+## مزودات التخزين++يتضمن CrewAI مزودي تخزين لنقاط الحفظ.++### JsonProvider (افتراضي)++يكتب كل نقطة حفظ كملف JSON منفصل.++```python+from crewai import Crew, CheckpointConfig+from crewai.state import JsonProvider++crew = Crew(+ agents=[...],+ tasks=[...],+ checkpoint=CheckpointConfig(+ directory="./my_checkpoints",+ provider=JsonProvider(),+ max_checkpoints=5,+ ),+)+```++### SqliteProvider++يخزن جميع نقاط الحفظ في ملف قاعدة بيانات SQLite واحد.++```python+from crewai import Crew, CheckpointConfig+from crewai.state import SqliteProvider++crew = Crew(+ agents=[...],+ tasks=[...],+ checkpoint=CheckpointConfig(+ directory="./.checkpoints.db",+ provider=SqliteProvider(max_checkpoints=50),+ ),+)+```++<Note>+عند استخدام `SqliteProvider`، حقل `directory` هو مسار ملف قاعدة البيانات، وليس مجلدا.+</Note>+## انواع الاحداثيقبل حقل `on_events` اي مجموعة من سلاسل انواع الاحداث. الخيارات الشائعة:diff --git a/docs/en/concepts/checkpointing.mdx b/docs/en/concepts/checkpointing.mdxindex 799f674d3..dccdf1b1a 100644--- a/docs/en/concepts/checkpointing.mdx+++ b/docs/en/concepts/checkpointing.mdx@@ -144,6 +144,55 @@ agent = Agent(result = agent.kickoff(messages=[{"role": "user", "content": "Research AI trends"}])```+## Storage Providers++CrewAI ships with two checkpoint storage providers.++### JsonProvider (default)++Writes each checkpoint as a separate JSON file. Simple, human-readable, easy to inspect.++```python+from crewai import Crew, CheckpointConfig+from crewai.state import JsonProvider++crew = Crew(+ agents=[...],+ tasks=[...],+ checkpoint=CheckpointConfig(+ directory="./my_checkpoints",+ provider=JsonProvider(), # this is the default+ max_checkpoints=5, # prunes oldest files+ ),+)+```++Files are named `<timestamp>_<uuid>.json` inside the directory.++### SqliteProvider++Stores all checkpoints in a single SQLite database file. Better for high-frequency checkpointing and avoids many small files.++```python+from crewai import Crew, CheckpointConfig+from crewai.state import SqliteProvider++crew = Crew(+ agents=[...],+ tasks=[...],+ checkpoint=CheckpointConfig(+ directory="./.checkpoints.db",+ provider=SqliteProvider(max_checkpoints=50),+ ),+)+```++`SqliteProvider` accepts its own `max_checkpoints` parameter that prunes old rows via SQL. WAL journal mode is enabled for concurrent read access.++<Note>+When using `SqliteProvider`, the `directory` field is the database file path, not a directory. The `max_checkpoints` on `CheckpointConfig` controls filesystem pruning (for `JsonProvider`), while `SqliteProvider.max_checkpoints` controls row pruning in the database.+</Note>+## Event TypesThe `on_events` field accepts any combination of event type strings. Common choices:diff --git a/docs/ko/concepts/checkpointing.mdx b/docs/ko/concepts/checkpointing.mdxindex da33aa3c8..a08933faa 100644--- a/docs/ko/concepts/checkpointing.mdx+++ b/docs/ko/concepts/checkpointing.mdx@@ -144,6 +144,51 @@ agent = Agent(result = agent.kickoff(messages=[{"role": "user", "content": "Research AI trends"}])```+## 스토리지 프로바이더++CrewAI는 두 가지 체크포인트 스토리지 프로바이더를 제공합니다.++### JsonProvider (기본값)++각 체크포인트를 별도의 JSON 파일로 저장합니다.++```python+from crewai import Crew, CheckpointConfig+from crewai.state import JsonProvider++crew = Crew(+ agents=[...],+ tasks=[...],+ checkpoint=CheckpointConfig(+ directory="./my_checkpoints",+ provider=JsonProvider(),+ max_checkpoints=5,+ ),+)+```++### SqliteProvider++모든 체크포인트를 단일 SQLite 데이터베이스 파일에 저장합니다.++```python+from crewai import Crew, CheckpointConfig+from crewai.state import SqliteProvider++crew = Crew(+ agents=[...],+ tasks=[...],+ checkpoint=CheckpointConfig(+ directory="./.checkpoints.db",+ provider=SqliteProvider(max_checkpoints=50),+ ),+)+```++<Note>+`SqliteProvider`를 사용할 때 `directory` 필드는 디렉토리가 아닌 데이터베이스 파일 경로입니다.+</Note>+## 이벤트 타입`on_events` 필드는 이벤트 타입 문자열의 조합을 받습니다. 일반적인 선택:diff --git a/docs/pt-BR/concepts/checkpointing.mdx b/docs/pt-BR/concepts/checkpointing.mdxindex 251691243..1ef7aedf3 100644--- a/docs/pt-BR/concepts/checkpointing.mdx+++ b/docs/pt-BR/concepts/checkpointing.mdx@@ -144,6 +144,51 @@ agent = Agent(result = agent.kickoff(messages=[{"role": "user", "content": "Research AI trends"}])```+## Provedores de Armazenamento++O CrewAI inclui dois provedores de armazenamento para checkpoints.++### JsonProvider (padrao)++Grava cada checkpoint como um arquivo JSON separado.++```python+from crewai import Crew, CheckpointConfig+from crewai.state import JsonProvider++crew = Crew(+ agents=[...],+ tasks=[...],+ checkpoint=CheckpointConfig(+ directory="./my_checkpoints",+ provider=JsonProvider(),+ max_checkpoints=5,+ ),+)+```++### SqliteProvider++Armazena todos os checkpoints em um unico arquivo SQLite.++```python+from crewai import Crew, CheckpointConfig+from crewai.state import SqliteProvider++crew = Crew(+ agents=[...],+ tasks=[...],+ checkpoint=CheckpointConfig(+ directory="./.checkpoints.db",+ provider=SqliteProvider(max_checkpoints=50),+ ),+)+```++<Note>+Ao usar `SqliteProvider`, o campo `directory` e o caminho do arquivo de banco de dados, nao um diretorio.+</Note>+## Tipos de EventoO campo `on_events` aceita qualquer combinacao de strings de tipo de evento. Escolhas comuns:diff --git a/lib/crewai/src/crewai/state/__init__.py b/lib/crewai/src/crewai/state/__init__.pyindex c08d19dcd..e97921ee0 100644--- a/lib/crewai/src/crewai/state/__init__.py+++ b/lib/crewai/src/crewai/state/__init__.py@@ -1,5 +1,11 @@from crewai.state.checkpoint_config import CheckpointConfig, CheckpointEventType+from crewai.state.provider.json_provider import JsonProviderfrom crewai.state.provider.sqlite_provider import SqliteProvider-__all__ = ["CheckpointConfig", "CheckpointEventType", "SqliteProvider"]+__all__ = [+ "CheckpointConfig",+ "CheckpointEventType",+ "JsonProvider",+ "SqliteProvider",+]