mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 13:48:09 +00:00
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>
223 lines
10 KiB
Plaintext
223 lines
10 KiB
Plaintext
---
|
|
title: ابنِ أول Flow لك
|
|
description: تعلم كيفية إنشاء سير عمل منظمة قائمة على الأحداث مع تحكم دقيق في التنفيذ.
|
|
icon: diagram-project
|
|
mode: "wide"
|
|
---
|
|
|
|
## التحكم في سير عمل AI مع Flows
|
|
|
|
تمثل CrewAI Flows المستوى التالي في تنسيق AI - الجمع بين القوة التعاونية لفرق Agents AI مع دقة ومرونة البرمجة الإجرائية. بينما تتفوق Crews في تعاون الـ Agents، تمنحك Flows تحكمًا دقيقًا في كيفية ووقت تفاعل المكونات المختلفة لنظام AI.
|
|
|
|
في هذا الدليل، سنمشي عبر إنشاء CrewAI Flow قوي ينشئ دليلًا تعليميًا شاملاً حول أي موضوع.
|
|
|
|
### ما يجعل Flows قوية
|
|
|
|
تمكّنك Flows من:
|
|
|
|
1. **الجمع بين أنماط تفاعل AI مختلفة** - استخدام Crews للمهام التعاونية المعقدة واستدعاءات LLM المباشرة للعمليات الأبسط والكود العادي للمنطق الإجرائي
|
|
2. **بناء أنظمة قائمة على الأحداث** - تحديد كيفية استجابة المكونات لأحداث وتغييرات بيانات محددة
|
|
3. **الحفاظ على الحالة عبر المكونات** - مشاركة وتحويل البيانات بين أجزاء مختلفة من تطبيقك
|
|
4. **التكامل مع الأنظمة الخارجية** - ربط سير عمل AI بسلاسة مع قواعد البيانات وواجهات API وواجهات المستخدم
|
|
5. **إنشاء مسارات تنفيذ معقدة** - تصميم فروع شرطية ومعالجة متوازية وسير عمل ديناميكية
|
|
|
|
### المتطلبات المسبقة
|
|
|
|
قبل البدء، تأكد من:
|
|
|
|
1. تثبيت CrewAI باتباع [دليل التثبيت](/ar/installation)
|
|
2. إعداد مفتاح API لنموذج LLM في بيئتك، باتباع [دليل إعداد LLM](/ar/concepts/llms#setting-up-your-llm)
|
|
3. فهم أساسي لـ Python
|
|
|
|
## الخطوة 1: إنشاء مشروع CrewAI Flow جديد
|
|
|
|
```bash
|
|
crewai create flow guide_creator_flow
|
|
cd guide_creator_flow
|
|
```
|
|
|
|
<Frame caption="نظرة عامة على إطار عمل CrewAI">
|
|
<img src="/images/flows.png" alt="نظرة عامة على إطار عمل CrewAI" />
|
|
</Frame>
|
|
|
|
## الخطوة 2: فهم هيكل المشروع
|
|
|
|
يستخدم الـ crew المبدئي المضمّن في مشروع Flow بنية Python/YAML الكلاسيكية. لاستخدام crew بنمط JSON-first داخل Flow، أنشئ `crew.jsonc` و `agents/*.jsonc` داخل مجلد الـ crew وحمّله عبر `crewai.project.load_crew` كما في [Flows](/ar/concepts/flows#building-your-crews).
|
|
|
|
```
|
|
guide_creator_flow/
|
|
├── .gitignore
|
|
├── pyproject.toml
|
|
├── README.md
|
|
├── .env
|
|
└── src/
|
|
└── guide_creator_flow/
|
|
├── __init__.py
|
|
├── main.py
|
|
├── crews/
|
|
│ └── poem_crew/
|
|
│ ├── config/
|
|
│ │ ├── agents.yaml
|
|
│ │ └── tasks.yaml
|
|
│ └── poem_crew.py
|
|
└── tools/
|
|
└── custom_tool.py
|
|
```
|
|
|
|
يوفر هذا الهيكل فصلاً واضحًا بين مكونات Flow المختلفة. سنعدّل هذا الهيكل لإنشاء Flow منشئ الدليل.
|
|
|
|
## الخطوة 3: إضافة Crew كتابة المحتوى
|
|
|
|
```bash
|
|
crewai flow add-crew content-crew
|
|
```
|
|
|
|
## الخطوة 4: تهيئة Crew كتابة المحتوى
|
|
|
|
سنهيئ crew كتابة المحتوى باستخدام JSONC. سنعرّف Agent للكتابة وAgent للمراجعة، ثم نحمّل `crew.jsonc` من خطوة Flow.
|
|
|
|
1. أنشئ `src/guide_creator_flow/crews/content_crew/agents/content_writer.jsonc`:
|
|
|
|
```jsonc
|
|
{
|
|
"role": "Educational Content Writer",
|
|
"goal": "Create engaging, informative content that thoroughly explains the assigned topic and provides valuable insights to the reader.",
|
|
"backstory": "You are a talented educational writer who explains complex concepts in accessible language and organizes information clearly.",
|
|
"llm": "provider/model-id",
|
|
"settings": {
|
|
"verbose": true
|
|
}
|
|
}
|
|
```
|
|
|
|
2. أنشئ `src/guide_creator_flow/crews/content_crew/agents/content_reviewer.jsonc`:
|
|
|
|
```jsonc
|
|
{
|
|
"role": "Educational Content Reviewer and Editor",
|
|
"goal": "Ensure content is accurate, comprehensive, well-structured, and consistent with previously written sections.",
|
|
"backstory": "You are a meticulous editor with an eye for detail, clarity, and coherence.",
|
|
"llm": "provider/model-id",
|
|
"settings": {
|
|
"verbose": true
|
|
}
|
|
}
|
|
```
|
|
|
|
استبدل `provider/model-id` بالنموذج الذي تستخدمه، مثل `openai/gpt-4o` أو `gemini/gemini-2.0-flash-001` أو `anthropic/claude-sonnet-4-6`.
|
|
|
|
3. أنشئ `src/guide_creator_flow/crews/content_crew/crew.jsonc`:
|
|
|
|
```jsonc
|
|
{
|
|
"name": "Content Crew",
|
|
"agents": ["content_writer", "content_reviewer"],
|
|
"tasks": [
|
|
{
|
|
"name": "write_section_task",
|
|
"description": "Write a comprehensive section on the topic: \"{section_title}\".\n\nSection description: {section_description}\nTarget audience: {audience_level} level learners\n\nYour content should begin with a brief introduction, explain key concepts clearly with examples, include practical applications where appropriate, end with a summary, and be approximately 500-800 words.\n\nPreviously written sections:\n{previous_sections}",
|
|
"expected_output": "A well-structured, comprehensive section in Markdown format that thoroughly explains the topic and is appropriate for the target audience.",
|
|
"agent": "content_writer",
|
|
"markdown": true
|
|
},
|
|
{
|
|
"name": "review_section_task",
|
|
"description": "Review and improve this section on \"{section_title}\":\n\n{draft_content}\n\nTarget audience: {audience_level} level learners\nPreviously written sections:\n{previous_sections}\n\nFix errors, improve clarity, verify consistency, enhance structure, and add missing key information.",
|
|
"expected_output": "An improved, polished version of the section that maintains the original structure but enhances clarity, accuracy, and consistency.",
|
|
"agent": "content_reviewer",
|
|
"context": ["write_section_task"],
|
|
"markdown": true
|
|
}
|
|
],
|
|
"process": "sequential",
|
|
"verbose": true
|
|
}
|
|
```
|
|
|
|
4. استبدل `src/guide_creator_flow/crews/content_crew/content_crew.py` بمحمل صغير:
|
|
|
|
```python
|
|
from pathlib import Path
|
|
|
|
from crewai.project import load_crew
|
|
|
|
|
|
def kickoff_content_crew(inputs: dict):
|
|
crew, default_inputs = load_crew(Path(__file__).with_name("crew.jsonc"))
|
|
return crew.kickoff(inputs={**default_inputs, **inputs})
|
|
```
|
|
|
|
## الخطوة 5: إنشاء Flow
|
|
|
|
الآن الجزء المثير - إنشاء Flow الذي سينسّق عملية إنشاء الدليل بالكامل. راجع الملف الإنجليزي الأصلي للكود الكامل لـ `main.py` حيث أن الكود يبقى كما هو.
|
|
|
|
## الخطوة 6: إعداد متغيرات البيئة
|
|
|
|
أنشئ ملف `.env` في جذر مشروعك بمفاتيح API. راجع [دليل إعداد LLM](/ar/concepts/llms#setting-up-your-llm) لتفاصيل تهيئة المزود.
|
|
|
|
```sh .env
|
|
OPENAI_API_KEY=your_openai_api_key
|
|
# or
|
|
GEMINI_API_KEY=your_gemini_api_key
|
|
# or
|
|
ANTHROPIC_API_KEY=your_anthropic_api_key
|
|
```
|
|
|
|
## الخطوة 7: تثبيت التبعيات
|
|
|
|
```bash
|
|
crewai install
|
|
```
|
|
|
|
## الخطوة 8: تشغيل Flow
|
|
|
|
```bash
|
|
crewai flow kickoff
|
|
```
|
|
|
|
عند تشغيل هذا الأمر، ستشاهد Flow يعمل:
|
|
1. سيطلب منك موضوعًا ومستوى الجمهور
|
|
2. سينشئ مخططًا منظمًا لدليلك
|
|
3. سيعالج كل قسم مع تعاون الكاتب والمراجع
|
|
4. أخيرًا سيجمع كل شيء في دليل شامل
|
|
|
|
## الخطوة 9: تصوير Flow
|
|
|
|
```bash
|
|
crewai flow plot
|
|
```
|
|
|
|
سينشئ ملف HTML يوضح هيكل Flow بما في ذلك العلاقات بين الخطوات المختلفة.
|
|
|
|
## الخطوة 10: مراجعة المخرجات
|
|
|
|
بمجرد اكتمال Flow، ستجد ملفين في مجلد `output`:
|
|
|
|
1. `guide_outline.json`: يحتوي على المخطط المنظم للدليل
|
|
2. `complete_guide.md`: الدليل الشامل بجميع الأقسام
|
|
|
|
## الميزات الرئيسية الموضّحة
|
|
|
|
يوضح Flow منشئ الدليل عدة ميزات قوية لـ CrewAI:
|
|
|
|
1. **تفاعل المستخدم**: يجمع Flow مدخلات مباشرة من المستخدم
|
|
2. **استدعاءات LLM المباشرة**: يستخدم فئة LLM لتفاعلات AI فعّالة وأحادية الغرض
|
|
3. **بيانات منظمة مع Pydantic**: يستخدم نماذج Pydantic لضمان سلامة الأنواع
|
|
4. **معالجة تسلسلية مع سياق**: يكتب الأقسام بالترتيب ويوفر الأقسام السابقة كسياق
|
|
5. **Crews متعددة الـ Agents**: يستفيد من Agents متخصصة (كاتب ومراجع) لإنشاء المحتوى
|
|
6. **إدارة الحالة**: يحافظ على الحالة عبر خطوات العملية المختلفة
|
|
7. **بنية قائمة على الأحداث**: يستخدم مزخرف `@listen` للاستجابة للأحداث
|
|
|
|
## الخطوات التالية
|
|
|
|
1. جرّب هياكل Flow أكثر تعقيدًا وأنماطًا
|
|
2. جرّب استخدام `@router()` لإنشاء فروع شرطية
|
|
3. استكشف دوال `and_` و`or_` لتنفيذ متوازٍ أكثر تعقيدًا
|
|
4. اربط Flow بواجهات API خارجية وقواعد بيانات وواجهات مستخدم
|
|
5. ادمج عدة Crews متخصصة في Flow واحد
|
|
6. أنشئ تطبيقات دردشة متعددة الجولات مع [تدفقات المحادثة](/ar/guides/flows/conversational-flows) (`kickoff` لكل رسالة، `ChatSession`، تأجيل التتبع)
|
|
|
|
<Check>
|
|
تهانينا! لقد بنيت بنجاح أول CrewAI Flow يجمع بين الكود العادي واستدعاءات LLM المباشرة ومعالجة Crew لإنشاء دليل شامل. هذه المهارات الأساسية تمكّنك من إنشاء تطبيقات AI متطورة بشكل متزايد.
|
|
</Check>
|