From b858d705a8a32ec89ced8a96443aa7b3f60e24c2 Mon Sep 17 00:00:00 2001 From: Joao Moura Date: Sun, 11 Jan 2026 16:02:55 -0800 Subject: [PATCH] updating docs --- docs/en/concepts/flows.mdx | 4 ++++ docs/en/learn/human-feedback-in-flows.mdx | 4 ++++ docs/en/learn/human-in-the-loop.mdx | 8 ++++---- docs/ko/concepts/flows.mdx | 4 ++++ docs/ko/learn/human-feedback-in-flows.mdx | 4 ++++ docs/ko/learn/human-in-the-loop.mdx | 17 +++++++++++++++-- docs/pt-BR/concepts/flows.mdx | 4 ++++ docs/pt-BR/learn/human-feedback-in-flows.mdx | 4 ++++ docs/pt-BR/learn/human-in-the-loop.mdx | 17 +++++++++++++++-- 9 files changed, 58 insertions(+), 8 deletions(-) diff --git a/docs/en/concepts/flows.mdx b/docs/en/concepts/flows.mdx index 6e9977512..f0335177d 100644 --- a/docs/en/concepts/flows.mdx +++ b/docs/en/concepts/flows.mdx @@ -574,6 +574,10 @@ When you run this Flow, the output will change based on the random boolean value ### Human in the Loop (human feedback) + +The `@human_feedback` decorator requires **CrewAI version 1.8.0 or higher**. + + The `@human_feedback` decorator enables human-in-the-loop workflows by pausing flow execution to collect feedback from a human. This is useful for approval gates, quality review, and decision points that require human judgment. ```python Code diff --git a/docs/en/learn/human-feedback-in-flows.mdx b/docs/en/learn/human-feedback-in-flows.mdx index 3c90c0730..60588657a 100644 --- a/docs/en/learn/human-feedback-in-flows.mdx +++ b/docs/en/learn/human-feedback-in-flows.mdx @@ -7,6 +7,10 @@ mode: "wide" ## Overview + +The `@human_feedback` decorator requires **CrewAI version 1.8.0 or higher**. Make sure to update your installation before using this feature. + + The `@human_feedback` decorator enables human-in-the-loop (HITL) workflows directly within CrewAI Flows. It allows you to pause flow execution, present output to a human for review, collect their feedback, and optionally route to different listeners based on the feedback outcome. This is particularly valuable for: diff --git a/docs/en/learn/human-in-the-loop.mdx b/docs/en/learn/human-in-the-loop.mdx index 7a74ebb08..02e327045 100644 --- a/docs/en/learn/human-in-the-loop.mdx +++ b/docs/en/learn/human-in-the-loop.mdx @@ -11,10 +11,10 @@ Human-in-the-Loop (HITL) is a powerful approach that combines artificial intelli CrewAI offers two main approaches for implementing human-in-the-loop workflows: -| Approach | Best For | Integration | -|----------|----------|-------------| -| **Flow-based** (`@human_feedback` decorator) | Local development, console-based review, synchronous workflows | [Human Feedback in Flows](/en/learn/human-feedback-in-flows) | -| **Webhook-based** (Enterprise) | Production deployments, async workflows, external integrations (Slack, Teams, etc.) | This guide | +| Approach | Best For | Integration | Version | +|----------|----------|-------------|---------| +| **Flow-based** (`@human_feedback` decorator) | Local development, console-based review, synchronous workflows | [Human Feedback in Flows](/en/learn/human-feedback-in-flows) | **1.8.0+** | +| **Webhook-based** (Enterprise) | Production deployments, async workflows, external integrations (Slack, Teams, etc.) | This guide | - | If you're building flows and want to add human review steps with routing based on feedback, check out the [Human Feedback in Flows](/en/learn/human-feedback-in-flows) guide for the `@human_feedback` decorator. diff --git a/docs/ko/concepts/flows.mdx b/docs/ko/concepts/flows.mdx index 328211e85..13f7d6933 100644 --- a/docs/ko/concepts/flows.mdx +++ b/docs/ko/concepts/flows.mdx @@ -567,6 +567,10 @@ Fourth method running ### Human in the Loop (인간 피드백) + +`@human_feedback` 데코레이터는 **CrewAI 버전 1.8.0 이상**이 필요합니다. + + `@human_feedback` 데코레이터는 인간의 피드백을 수집하기 위해 플로우 실행을 일시 중지하는 human-in-the-loop 워크플로우를 가능하게 합니다. 이는 승인 게이트, 품질 검토, 인간의 판단이 필요한 결정 지점에 유용합니다. ```python Code diff --git a/docs/ko/learn/human-feedback-in-flows.mdx b/docs/ko/learn/human-feedback-in-flows.mdx index 89cccde1f..6ba92c37e 100644 --- a/docs/ko/learn/human-feedback-in-flows.mdx +++ b/docs/ko/learn/human-feedback-in-flows.mdx @@ -7,6 +7,10 @@ mode: "wide" ## 개요 + +`@human_feedback` 데코레이터는 **CrewAI 버전 1.8.0 이상**이 필요합니다. 이 기능을 사용하기 전에 설치를 업데이트하세요. + + `@human_feedback` 데코레이터는 CrewAI Flow 내에서 직접 human-in-the-loop(HITL) 워크플로우를 가능하게 합니다. Flow 실행을 일시 중지하고, 인간에게 검토를 위해 출력을 제시하고, 피드백을 수집하고, 선택적으로 피드백 결과에 따라 다른 리스너로 라우팅할 수 있습니다. 이는 특히 다음과 같은 경우에 유용합니다: diff --git a/docs/ko/learn/human-in-the-loop.mdx b/docs/ko/learn/human-in-the-loop.mdx index b504dbbc9..9ccdcb231 100644 --- a/docs/ko/learn/human-in-the-loop.mdx +++ b/docs/ko/learn/human-in-the-loop.mdx @@ -5,9 +5,22 @@ icon: "user-check" mode: "wide" --- -휴먼 인 더 루프(HITL, Human-in-the-Loop)는 인공지능과 인간의 전문 지식을 결합하여 의사결정을 강화하고 작업 결과를 향상시키는 강력한 접근 방식입니다. 이 가이드에서는 CrewAI 내에서 HITL을 구현하는 방법을 안내합니다. +휴먼 인 더 루프(HITL, Human-in-the-Loop)는 인공지능과 인간의 전문 지식을 결합하여 의사결정을 강화하고 작업 결과를 향상시키는 강력한 접근 방식입니다. CrewAI는 필요에 따라 HITL을 구현하는 여러 가지 방법을 제공합니다. -## HITL 워크플로우 설정 +## HITL 접근 방식 선택 + +CrewAI는 human-in-the-loop 워크플로우를 구현하기 위한 두 가지 주요 접근 방식을 제공합니다: + +| 접근 방식 | 적합한 용도 | 통합 | 버전 | +|----------|----------|-------------|---------| +| **Flow 기반** (`@human_feedback` 데코레이터) | 로컬 개발, 콘솔 기반 검토, 동기식 워크플로우 | [Flow에서 인간 피드백](/ko/learn/human-feedback-in-flows) | **1.8.0+** | +| **Webhook 기반** (Enterprise) | 프로덕션 배포, 비동기 워크플로우, 외부 통합 (Slack, Teams 등) | 이 가이드 | - | + + +Flow를 구축하면서 피드백을 기반으로 라우팅하는 인간 검토 단계를 추가하려면 `@human_feedback` 데코레이터에 대한 [Flow에서 인간 피드백](/ko/learn/human-feedback-in-flows) 가이드를 참조하세요. + + +## Webhook 기반 HITL 워크플로우 설정 diff --git a/docs/pt-BR/concepts/flows.mdx b/docs/pt-BR/concepts/flows.mdx index c32642d6e..2cac627b2 100644 --- a/docs/pt-BR/concepts/flows.mdx +++ b/docs/pt-BR/concepts/flows.mdx @@ -309,6 +309,10 @@ Ao executar esse Flow, a saída será diferente dependendo do valor booleano ale ### Human in the Loop (feedback humano) + +O decorador `@human_feedback` requer **CrewAI versão 1.8.0 ou superior**. + + O decorador `@human_feedback` permite fluxos de trabalho human-in-the-loop, pausando a execução do flow para coletar feedback de um humano. Isso é útil para portões de aprovação, revisão de qualidade e pontos de decisão que requerem julgamento humano. ```python Code diff --git a/docs/pt-BR/learn/human-feedback-in-flows.mdx b/docs/pt-BR/learn/human-feedback-in-flows.mdx index fbe9512dc..c847bf31a 100644 --- a/docs/pt-BR/learn/human-feedback-in-flows.mdx +++ b/docs/pt-BR/learn/human-feedback-in-flows.mdx @@ -7,6 +7,10 @@ mode: "wide" ## Visão Geral + +O decorador `@human_feedback` requer **CrewAI versão 1.8.0 ou superior**. Certifique-se de atualizar sua instalação antes de usar este recurso. + + O decorador `@human_feedback` permite fluxos de trabalho human-in-the-loop (HITL) diretamente nos CrewAI Flows. Ele permite pausar a execução do flow, apresentar a saída para um humano revisar, coletar seu feedback e, opcionalmente, rotear para diferentes listeners com base no resultado do feedback. Isso é particularmente valioso para: diff --git a/docs/pt-BR/learn/human-in-the-loop.mdx b/docs/pt-BR/learn/human-in-the-loop.mdx index 9d3d15f5b..07528027c 100644 --- a/docs/pt-BR/learn/human-in-the-loop.mdx +++ b/docs/pt-BR/learn/human-in-the-loop.mdx @@ -5,9 +5,22 @@ icon: "user-check" mode: "wide" --- -Human-in-the-Loop (HITL) é uma abordagem poderosa que combina a inteligência artificial com a experiência humana para aprimorar a tomada de decisões e melhorar os resultados das tarefas. Este guia mostra como implementar HITL dentro da CrewAI. +Human-in-the-Loop (HITL) é uma abordagem poderosa que combina a inteligência artificial com a experiência humana para aprimorar a tomada de decisões e melhorar os resultados das tarefas. CrewAI oferece várias maneiras de implementar HITL dependendo das suas necessidades. -## Configurando Workflows HITL +## Escolhendo Sua Abordagem HITL + +CrewAI oferece duas abordagens principais para implementar workflows human-in-the-loop: + +| Abordagem | Melhor Para | Integração | Versão | +|----------|----------|-------------|---------| +| **Baseada em Flow** (decorador `@human_feedback`) | Desenvolvimento local, revisão via console, workflows síncronos | [Feedback Humano em Flows](/pt-BR/learn/human-feedback-in-flows) | **1.8.0+** | +| **Baseada em Webhook** (Enterprise) | Deployments em produção, workflows assíncronos, integrações externas (Slack, Teams, etc.) | Este guia | - | + + +Se você está construindo flows e deseja adicionar etapas de revisão humana com roteamento baseado em feedback, confira o guia [Feedback Humano em Flows](/pt-BR/learn/human-feedback-in-flows) para o decorador `@human_feedback`. + + +## Configurando Workflows HITL Baseados em Webhook