mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 13:48:09 +00:00
93dafe2637
Switch docs.crewai.com from navigation-only versioning (every version selector entry rendered the same docs/<lang>/* source files) to Mintlify's directory-based versioning so each version selector entry renders its own snapshot. Add an "Edge" channel under docs/edge/<lang>/* that always reflects main HEAD for unreleased work, eliminating pre-release leakage onto frozen release labels. External links to canonical /<lang>/* URLs are preserved via wildcard redirects that always land on the current default version. Layout: - docs/edge/<lang>/* rolling source (you edit here) - docs/edge/enterprise-api.*.yaml - docs/v<X.Y.Z>/<lang>/* frozen, immutable snapshots - docs/v<X.Y.Z>/enterprise-api.*.yaml - docs/images/ shared, append-only - docs/docs.json nav + redirects URLs follow the Mintlify-idiomatic shape: /edge/<lang>/<page> for Edge, /v<X.Y.Z>/<lang>/<page> for every frozen snapshot. The wildcard redirects /<lang>/:slug* -> /<default>/<lang>/:slug* keep stale links working, and every freeze rewrites them (plus all per-section/per-page redirects) so destinations always resolve to the current default without depending on a second redirect hop. Release flow integration (devtools release): - New module crewai_devtools.docs_versioning.freeze() materialises docs/v<X.Y.Z>/ from docs/edge/, rewrites openapi: refs inside the snapshot, inserts the version into every language block in docs.json, and refreshes all redirect destinations. - _update_docs_and_create_pr() in cli.py now calls that freeze during Phase 2 of devtools release. Edge changelogs are updated first (so the snapshot freeze picks them up), then the snapshot is staged alongside docs.json, branched as docs/freeze-v<X.Y.Z>, and the PR is titled [docs-freeze] docs: snapshot and changelog for v<X.Y.Z> — the title prefix the new CI guard reads. - The PR still gates tag, GitHub release, PyPI publish, and the enterprise release as before; no new PRs are added. - Pre-releases (1.X.YaN, 1.X.YbN, ...) skip the snapshot — they ride Edge — and the docs PR title omits the [docs-freeze] prefix. - docs_check (AI-generated docs scaffolding) writes to docs/edge/<lang>/* so newly-generated unreleased docs land in Edge and never accidentally touch a frozen snapshot. Migration scripts (one-shot): - scripts/docs/freeze_historical_versions.py reconstructs all 16 historical snapshots (v1.10.0 .. v1.14.7) from git tags via git archive | tar, rewriting openapi: MDX refs so each snapshot reads its own enterprise-api YAML rather than the live one. - scripts/docs/prefix_version_paths.py one-shot-migrates docs.json: rewrites every page path in 16 versioned blocks to point under docs/v<X.Y.Z>/, inserts a new Edge entry per language, tags v1.14.7 as Latest (default), prunes pages whose target file doesn't exist in the snapshot (e.g. docs/ar/ didn't exist before v1.12.0), and writes the wildcard + per-section redirects. - scripts/docs/freeze_current_edge.py is now a thin CLI wrapper around docs_versioning.freeze for manual one-off freezes (e.g. retroactively snapshotting a forgotten release). CI guards (.github/workflows/docs-snapshots.yml): - Frozen snapshots under docs/v[0-9]*/ are immutable; only PRs whose title contains [docs-freeze] (i.e. release-cut PRs generated by devtools release or the manual wrapper) may modify them. - Images under docs/images/ are append-only since snapshots share a single image directory. Deleting or renaming an image breaks every historical snapshot that still references it. Restored docs/images/crewai-otel-export.png from PR #3673; it was deleted in PR #4908 but v1.10.0 / v1.10.1 snapshots still reference it. Restoring instead of editing the snapshots preserves historical rendering fidelity and validates the new append-only rule retroactively. Tests: - lib/devtools/tests/test_docs_versioning.py covers the freeze: file copy, openapi rewrite, version insertion, default demotion, redirect upserts, per-section redirect rewriting, idempotency, and invalid inputs. Verified locally with mintlify broken-links: 0 broken links across the full site (Edge + 16 frozen versions, 4 locales). AGENTS.md (repo root) is the contributor guide for the new model; RELEASING.md is the release-cut runbook; README's Contribution section links to both. Co-authored-by: Cursor <cursoragent@cursor.com>
81 lines
4.4 KiB
Plaintext
81 lines
4.4 KiB
Plaintext
---
|
|
title: "سير عمل التدخل البشري (HITL)"
|
|
description: "تعلم كيفية تنفيذ سير عمل التدخل البشري في CrewAI لتعزيز صنع القرار"
|
|
icon: "user-check"
|
|
mode: "wide"
|
|
---
|
|
|
|
التدخل البشري (HITL) هو نهج قوي يجمع بين الذكاء الاصطناعي والخبرة البشرية لتعزيز صنع القرار وتحسين نتائج المهام. يوفر CrewAI طرقًا متعددة لتنفيذ HITL حسب احتياجاتك.
|
|
|
|
## اختيار نهج HITL
|
|
|
|
يوفر CrewAI نهجين رئيسيين لتنفيذ سير عمل التدخل البشري:
|
|
|
|
| النهج | الأنسب لـ | التكامل | الإصدار |
|
|
|----------|----------|-------------|---------|
|
|
| **قائم على Flow** (مزخرف `@human_feedback`) | التطوير المحلي، المراجعة عبر وحدة التحكم، سير العمل المتزامن | [التغذية الراجعة البشرية في Flows](/ar/learn/human-feedback-in-flows) | **1.8.0+** |
|
|
| **قائم على Webhook** (المؤسسات) | نشر الإنتاج، سير العمل غير المتزامن، التكاملات الخارجية (Slack، Teams، إلخ) | هذا الدليل | - |
|
|
|
|
<Tip>
|
|
إذا كنت تبني Flows وتريد إضافة خطوات مراجعة بشرية مع توجيه بناءً على التعليقات، اطلع على دليل [التغذية الراجعة البشرية في Flows](/ar/learn/human-feedback-in-flows) لمزخرف `@human_feedback`.
|
|
</Tip>
|
|
|
|
## إعداد سير عمل HITL القائم على Webhook
|
|
|
|
<Steps>
|
|
<Step title="تهيئة المهمة">
|
|
أعدّ مهمتك مع تمكين إدخال بشري.
|
|
</Step>
|
|
|
|
<Step title="توفير عنوان Webhook URL">
|
|
عند تشغيل Crew، أدرج عنوان Webhook URL لإدخال بشري.
|
|
</Step>
|
|
|
|
<Step title="تلقي إشعار Webhook">
|
|
بمجرد إتمام Crew المهمة التي تتطلب إدخالاً بشريًا، ستتلقى إشعار Webhook.
|
|
</Step>
|
|
|
|
<Step title="مراجعة مخرجات المهمة">
|
|
سيتوقف النظام في حالة `Pending Human Input`. راجع مخرجات المهمة بعناية.
|
|
</Step>
|
|
|
|
<Step title="إرسال التغذية الراجعة البشرية">
|
|
استدعِ نقطة نهاية الاستئناف لـ Crew.
|
|
|
|
<Warning>
|
|
**مهم: يجب توفير عناوين Webhook URL مرة أخرى**:
|
|
يجب توفير نفس عناوين Webhook URL في استدعاء الاستئناف التي استخدمتها في استدعاء الانطلاق.
|
|
</Warning>
|
|
</Step>
|
|
|
|
<Step title="معالجة التعليقات السلبية">
|
|
إذا قدمت تعليقات سلبية، سيعيد Crew محاولة المهمة مع سياق إضافي من تعليقاتك.
|
|
</Step>
|
|
|
|
<Step title="استمرار التنفيذ">
|
|
عند إرسال تعليقات إيجابية، سيستمر التنفيذ إلى الخطوات التالية.
|
|
</Step>
|
|
</Steps>
|
|
|
|
## أفضل الممارسات
|
|
|
|
- **كن محددًا**: قدم تعليقات واضحة وقابلة للتنفيذ
|
|
- **ابقَ ذا صلة**: أدرج فقط معلومات تساعد في تحسين تنفيذ المهمة
|
|
- **كن في الوقت المناسب**: استجب لمطالبات HITL بسرعة لتجنب تأخير سير العمل
|
|
- **راجع بعناية**: تحقق من تعليقاتك قبل الإرسال لضمان الدقة
|
|
|
|
## حالات الاستخدام الشائعة
|
|
|
|
سير عمل HITL مفيدة بشكل خاص لـ:
|
|
- ضمان الجودة والتحقق
|
|
- سيناريوهات صنع القرار المعقدة
|
|
- العمليات الحساسة أو عالية المخاطر
|
|
- المهام الإبداعية التي تتطلب حكمًا بشريًا
|
|
- مراجعات الامتثال والتنظيم
|
|
|
|
## ميزات المؤسسات
|
|
|
|
<Card title="منصة إدارة HITL للـ Flow" icon="users-gear" href="/ar/enterprise/features/flow-hitl-management">
|
|
يوفر CrewAI Enterprise نظام إدارة HITL شامل لـ Flows مع مراجعة داخل المنصة وتعيين المستجيبين والأذونات وسياسات التصعيد وإدارة SLA والتوجيه الديناميكي والتحليلات الكاملة. [تعلم المزيد](/ar/enterprise/features/flow-hitl-management)
|
|
</Card>
|