From b8680efe2a988a981cea9ee04bac041fb665bda0 Mon Sep 17 00:00:00 2001 From: Greyson LaLonde Date: Fri, 22 May 2026 22:28:35 +0800 Subject: [PATCH] docs: simplify Event types section, drop env events --- docs/ar/concepts/checkpointing.mdx | 18 +++--------------- docs/en/concepts/checkpointing.mdx | 18 +++--------------- docs/ko/concepts/checkpointing.mdx | 18 +++--------------- docs/pt-BR/concepts/checkpointing.mdx | 18 +++--------------- 4 files changed, 12 insertions(+), 60 deletions(-) diff --git a/docs/ar/concepts/checkpointing.mdx b/docs/ar/concepts/checkpointing.mdx index 0774c36ae..a38bfef54 100644 --- a/docs/ar/concepts/checkpointing.mdx +++ b/docs/ar/concepts/checkpointing.mdx @@ -317,7 +317,7 @@ mode: "wide" - أنواع الأحداث التي تطلق نقطة حفظ. `CheckpointEventType` هو `Literal` — مدقق الأنواع يكمل تلقائيا ويرفض القيم غير المدعومة. راجع [جميع الأحداث المدعومة](#جميع-الأحداث-المدعومة). + أنواع الأحداث التي تطلق نقطة حفظ. `CheckpointEventType` هو `Literal` — مدقق الأنواع يكمل تلقائيا ويرفض القيم غير المدعومة. راجع [أنواع الأحداث](#أنواع-الأحداث) للقائمة الكاملة. @@ -354,24 +354,13 @@ mode: "wide" ### أنواع الأحداث -قيم شائعة لـ `on_events`: - -| حالة الاستخدام | الأحداث | -|:---------------|:--------| -| بعد كل مهمة | `["task_completed"]` | -| بعد كل طريقة في التدفق | `["method_execution_finished"]` | -| بعد تنفيذ الوكيل | `["agent_execution_completed"]`, `["lite_agent_execution_completed"]` | -| عند اكتمال الطاقم فقط | `["crew_kickoff_completed"]` | -| بعد كل استدعاء LLM | `["llm_call_completed"]` | -| كل شيء | `["*"]` | +يقبل `on_events` أي مجموعة من قيم `CheckpointEventType`. الافتراضي `["task_completed"]` يكتب نقطة حفظ لكل مهمة منتهية، و`["*"]` يطابق جميع الأحداث. `["*"]` والأحداث عالية التردد مثل `llm_call_completed` تكتب نقاط حفظ كثيرة وقد تضر بالاداء. استخدمها مع `max_checkpoints`. -#### جميع الأحداث المدعومة - - + - **Task** — `task_started`, `task_completed`, `task_failed`, `task_evaluation` - **Crew** — `crew_kickoff_started`, `crew_kickoff_completed`, `crew_kickoff_failed`, `crew_train_started`, `crew_train_completed`, `crew_train_failed`, `crew_test_started`, `crew_test_completed`, `crew_test_failed`, `crew_test_result` @@ -389,7 +378,6 @@ mode: "wide" - **Logging** — `agent_logs_started`, `agent_logs_execution` - **A2A** — `a2a_delegation_started`, `a2a_delegation_completed`, `a2a_conversation_started`, `a2a_conversation_completed`, `a2a_message_sent`, `a2a_response_received`, `a2a_polling_started`, `a2a_polling_status`, `a2a_push_notification_registered`, `a2a_push_notification_received`, `a2a_push_notification_sent`, `a2a_push_notification_timeout`, `a2a_streaming_started`, `a2a_streaming_chunk`, `a2a_agent_card_fetched`, `a2a_authentication_failed`, `a2a_artifact_received`, `a2a_connection_error`, `a2a_server_task_started`, `a2a_server_task_completed`, `a2a_server_task_canceled`, `a2a_server_task_failed`, `a2a_parallel_delegation_started`, `a2a_parallel_delegation_completed`, `a2a_transport_negotiated`, `a2a_content_type_negotiated`, `a2a_context_created`, `a2a_context_expired`, `a2a_context_idle`, `a2a_context_completed`, `a2a_context_pruned` - **إشارات النظام** — `SIGTERM`, `SIGINT`, `SIGHUP`, `SIGTSTP`, `SIGCONT` -- **Env** — `cc_env`, `codex_env`, `cursor_env`, `default_env` - **حرف بدل** — `"*"` يطابق جميع الأحداث. diff --git a/docs/en/concepts/checkpointing.mdx b/docs/en/concepts/checkpointing.mdx index 3d1dfd18a..7fc3bc599 100644 --- a/docs/en/concepts/checkpointing.mdx +++ b/docs/en/concepts/checkpointing.mdx @@ -317,7 +317,7 @@ This walkthrough takes ~5 minutes. You will run a two-task crew, kill it midway, - Event types that trigger a checkpoint. `CheckpointEventType` is a `Literal` — your type checker will autocomplete and reject unsupported values. See [all supported events](#all-supported-events). + Event types that trigger a checkpoint. `CheckpointEventType` is a `Literal` — your type checker will autocomplete and reject unsupported values. See [event types](#event-types) for the full list. @@ -354,24 +354,13 @@ Accepted by `Crew`, `Flow`, and `Agent`. ### Event types -Common values for `on_events`: - -| Use case | Events | -|:---------|:-------| -| After each task | `["task_completed"]` | -| After each flow method | `["method_execution_finished"]` | -| After agent execution | `["agent_execution_completed"]`, `["lite_agent_execution_completed"]` | -| On crew completion only | `["crew_kickoff_completed"]` | -| After every LLM call | `["llm_call_completed"]` | -| Everything | `["*"]` | +`on_events` accepts any combination of `CheckpointEventType` values. The default `["task_completed"]` writes one checkpoint per finished task; `["*"]` matches every event. `["*"]` and high-frequency events like `llm_call_completed` write many checkpoints and can degrade performance. Pair them with `max_checkpoints`. -#### All supported events - - + - **Task** — `task_started`, `task_completed`, `task_failed`, `task_evaluation` - **Crew** — `crew_kickoff_started`, `crew_kickoff_completed`, `crew_kickoff_failed`, `crew_train_started`, `crew_train_completed`, `crew_train_failed`, `crew_test_started`, `crew_test_completed`, `crew_test_failed`, `crew_test_result` @@ -389,7 +378,6 @@ Common values for `on_events`: - **Logging** — `agent_logs_started`, `agent_logs_execution` - **A2A** — `a2a_delegation_started`, `a2a_delegation_completed`, `a2a_conversation_started`, `a2a_conversation_completed`, `a2a_message_sent`, `a2a_response_received`, `a2a_polling_started`, `a2a_polling_status`, `a2a_push_notification_registered`, `a2a_push_notification_received`, `a2a_push_notification_sent`, `a2a_push_notification_timeout`, `a2a_streaming_started`, `a2a_streaming_chunk`, `a2a_agent_card_fetched`, `a2a_authentication_failed`, `a2a_artifact_received`, `a2a_connection_error`, `a2a_server_task_started`, `a2a_server_task_completed`, `a2a_server_task_canceled`, `a2a_server_task_failed`, `a2a_parallel_delegation_started`, `a2a_parallel_delegation_completed`, `a2a_transport_negotiated`, `a2a_content_type_negotiated`, `a2a_context_created`, `a2a_context_expired`, `a2a_context_idle`, `a2a_context_completed`, `a2a_context_pruned` - **System signals** — `SIGTERM`, `SIGINT`, `SIGHUP`, `SIGTSTP`, `SIGCONT` -- **Env** — `cc_env`, `codex_env`, `cursor_env`, `default_env` - **Wildcard** — `"*"` matches every event. diff --git a/docs/ko/concepts/checkpointing.mdx b/docs/ko/concepts/checkpointing.mdx index f15544519..12a31ad1b 100644 --- a/docs/ko/concepts/checkpointing.mdx +++ b/docs/ko/concepts/checkpointing.mdx @@ -317,7 +317,7 @@ CrewAI에는 두 가지 프로바이더가 포함되어 있습니다: - 체크포인트를 트리거하는 이벤트 타입. `CheckpointEventType`은 `Literal`이므로 타입 체커가 자동 완성하고 지원되지 않는 값을 거부합니다. [지원되는 모든 이벤트](#지원되는-모든-이벤트) 참조. + 체크포인트를 트리거하는 이벤트 타입. `CheckpointEventType`은 `Literal`이므로 타입 체커가 자동 완성하고 지원되지 않는 값을 거부합니다. 전체 목록은 [이벤트 타입](#이벤트-타입) 참조. @@ -354,24 +354,13 @@ CrewAI에는 두 가지 프로바이더가 포함되어 있습니다: ### 이벤트 타입 -`on_events`에 대한 일반적인 값: - -| 사용 사례 | 이벤트 | -|:----------|:-------| -| 각 태스크 완료 후 | `["task_completed"]` | -| 각 플로우 메서드 완료 후 | `["method_execution_finished"]` | -| 에이전트 실행 완료 후 | `["agent_execution_completed"]`, `["lite_agent_execution_completed"]` | -| 크루 완료 시에만 | `["crew_kickoff_completed"]` | -| 모든 LLM 호출 후 | `["llm_call_completed"]` | -| 모든 이벤트 | `["*"]` | +`on_events`는 `CheckpointEventType` 값의 임의 조합을 받습니다. 기본값 `["task_completed"]`는 완료된 태스크당 하나의 체크포인트를 기록하며, `["*"]`는 모든 이벤트와 일치합니다. `["*"]` 및 `llm_call_completed`와 같은 고빈도 이벤트는 많은 체크포인트를 기록하고 성능을 저하시킬 수 있습니다. `max_checkpoints`와 함께 사용하세요. -#### 지원되는 모든 이벤트 - - + - **Task** — `task_started`, `task_completed`, `task_failed`, `task_evaluation` - **Crew** — `crew_kickoff_started`, `crew_kickoff_completed`, `crew_kickoff_failed`, `crew_train_started`, `crew_train_completed`, `crew_train_failed`, `crew_test_started`, `crew_test_completed`, `crew_test_failed`, `crew_test_result` @@ -389,7 +378,6 @@ CrewAI에는 두 가지 프로바이더가 포함되어 있습니다: - **Logging** — `agent_logs_started`, `agent_logs_execution` - **A2A** — `a2a_delegation_started`, `a2a_delegation_completed`, `a2a_conversation_started`, `a2a_conversation_completed`, `a2a_message_sent`, `a2a_response_received`, `a2a_polling_started`, `a2a_polling_status`, `a2a_push_notification_registered`, `a2a_push_notification_received`, `a2a_push_notification_sent`, `a2a_push_notification_timeout`, `a2a_streaming_started`, `a2a_streaming_chunk`, `a2a_agent_card_fetched`, `a2a_authentication_failed`, `a2a_artifact_received`, `a2a_connection_error`, `a2a_server_task_started`, `a2a_server_task_completed`, `a2a_server_task_canceled`, `a2a_server_task_failed`, `a2a_parallel_delegation_started`, `a2a_parallel_delegation_completed`, `a2a_transport_negotiated`, `a2a_content_type_negotiated`, `a2a_context_created`, `a2a_context_expired`, `a2a_context_idle`, `a2a_context_completed`, `a2a_context_pruned` - **시스템 시그널** — `SIGTERM`, `SIGINT`, `SIGHUP`, `SIGTSTP`, `SIGCONT` -- **Env** — `cc_env`, `codex_env`, `cursor_env`, `default_env` - **와일드카드** — `"*"`는 모든 이벤트와 일치합니다. diff --git a/docs/pt-BR/concepts/checkpointing.mdx b/docs/pt-BR/concepts/checkpointing.mdx index 25e034c89..f2769be0b 100644 --- a/docs/pt-BR/concepts/checkpointing.mdx +++ b/docs/pt-BR/concepts/checkpointing.mdx @@ -317,7 +317,7 @@ Este passo a passo leva cerca de 5 minutos. Voce executara uma crew de duas tare - Tipos de evento que disparam um checkpoint. `CheckpointEventType` e um `Literal` — seu type checker autocompleta e rejeita valores nao suportados. Veja [todos os eventos suportados](#todos-os-eventos-suportados). + Tipos de evento que disparam um checkpoint. `CheckpointEventType` e um `Literal` — seu type checker autocompleta e rejeita valores nao suportados. Veja [tipos de evento](#tipos-de-evento) para a lista completa. @@ -354,24 +354,13 @@ Aceito por `Crew`, `Flow` e `Agent`. ### Tipos de evento -Valores comuns para `on_events`: - -| Caso de uso | Eventos | -|:------------|:--------| -| Apos cada tarefa | `["task_completed"]` | -| Apos cada metodo do flow | `["method_execution_finished"]` | -| Apos execucao do agente | `["agent_execution_completed"]`, `["lite_agent_execution_completed"]` | -| Apenas na conclusao da crew | `["crew_kickoff_completed"]` | -| Apos cada chamada LLM | `["llm_call_completed"]` | -| Tudo | `["*"]` | +`on_events` aceita qualquer combinacao de valores `CheckpointEventType`. O padrao `["task_completed"]` grava um checkpoint por tarefa finalizada; `["*"]` corresponde a todos os eventos. `["*"]` e eventos de alta frequencia como `llm_call_completed` gravam muitos checkpoints e podem degradar o desempenho. Combine com `max_checkpoints`. -#### Todos os eventos suportados - - + - **Task** — `task_started`, `task_completed`, `task_failed`, `task_evaluation` - **Crew** — `crew_kickoff_started`, `crew_kickoff_completed`, `crew_kickoff_failed`, `crew_train_started`, `crew_train_completed`, `crew_train_failed`, `crew_test_started`, `crew_test_completed`, `crew_test_failed`, `crew_test_result` @@ -389,7 +378,6 @@ Valores comuns para `on_events`: - **Logging** — `agent_logs_started`, `agent_logs_execution` - **A2A** — `a2a_delegation_started`, `a2a_delegation_completed`, `a2a_conversation_started`, `a2a_conversation_completed`, `a2a_message_sent`, `a2a_response_received`, `a2a_polling_started`, `a2a_polling_status`, `a2a_push_notification_registered`, `a2a_push_notification_received`, `a2a_push_notification_sent`, `a2a_push_notification_timeout`, `a2a_streaming_started`, `a2a_streaming_chunk`, `a2a_agent_card_fetched`, `a2a_authentication_failed`, `a2a_artifact_received`, `a2a_connection_error`, `a2a_server_task_started`, `a2a_server_task_completed`, `a2a_server_task_canceled`, `a2a_server_task_failed`, `a2a_parallel_delegation_started`, `a2a_parallel_delegation_completed`, `a2a_transport_negotiated`, `a2a_content_type_negotiated`, `a2a_context_created`, `a2a_context_expired`, `a2a_context_idle`, `a2a_context_completed`, `a2a_context_pruned` - **Sinais de sistema** — `SIGTERM`, `SIGINT`, `SIGHUP`, `SIGTSTP`, `SIGCONT` -- **Env** — `cc_env`, `codex_env`, `cursor_env`, `default_env` - **Wildcard** — `"*"` corresponde a todos os eventos.