mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 13:48:09 +00:00
* feat: adopt directory-based docs versioning with Edge channel 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> * style: resolve linter issues --------- Co-authored-by: Cursor <cursoragent@cursor.com>
229 lines
9.9 KiB
Plaintext
229 lines
9.9 KiB
Plaintext
---
|
|
title: إتقان إدارة حالة Flow
|
|
description: دليل شامل لإدارة الحالة وحفظها والاستفادة منها في CrewAI Flows لبناء تطبيقات AI قوية.
|
|
icon: diagram-project
|
|
mode: "wide"
|
|
---
|
|
|
|
## فهم قوة الحالة في Flows
|
|
|
|
إدارة الحالة هي العمود الفقري لأي سير عمل AI متطور. في CrewAI Flows، يتيح لك نظام الحالة الحفاظ على السياق ومشاركة البيانات بين الخطوات وبناء منطق تطبيق معقد. إتقان إدارة الحالة ضروري لإنشاء تطبيقات AI موثوقة وقابلة للصيانة وقوية.
|
|
|
|
### لماذا تهم إدارة الحالة
|
|
|
|
تمكّنك إدارة الحالة الفعّالة من:
|
|
|
|
1. **الحفاظ على السياق عبر خطوات التنفيذ** - تمرير المعلومات بسلاسة بين مراحل سير العمل المختلفة
|
|
2. **بناء منطق شرطي معقد** - اتخاذ قرارات بناءً على البيانات المتراكمة
|
|
3. **إنشاء تطبيقات مستمرة** - حفظ واستعادة تقدم سير العمل
|
|
4. **معالجة الأخطاء بلطف** - تنفيذ أنماط استرداد لتطبيقات أكثر قوة
|
|
5. **توسيع تطبيقاتك** - دعم سير العمل المعقدة بتنظيم بيانات مناسب
|
|
6. **تمكين التطبيقات الحوارية** - تخزين والوصول إلى سجل المحادثات للتفاعلات الواعية بالسياق
|
|
|
|
للدردشة متعددة الجولات (`kickoff` لكل سطر مستخدم، `ChatState`، توجيه النية، تأجيل التتبع، و`ChatSession`)، راجع [تدفقات المحادثة](/ar/guides/flows/conversational-flows).
|
|
|
|
## أساسيات إدارة الحالة
|
|
|
|
### نهجان لإدارة الحالة
|
|
|
|
يوفر CrewAI طريقتين لإدارة الحالة في Flows:
|
|
|
|
1. **الحالة غير المنظمة** - استخدام كائنات شبيهة بالقاموس للمرونة
|
|
2. **الحالة المنظمة** - استخدام نماذج Pydantic لسلامة الأنواع والتحقق
|
|
|
|
### مثال الحالة غير المنظمة
|
|
|
|
```python
|
|
from crewai.flow.flow import Flow, listen, start
|
|
|
|
class UnstructuredStateFlow(Flow):
|
|
@start()
|
|
def initialize_data(self):
|
|
self.state["user_name"] = "Alex"
|
|
self.state["preferences"] = {"theme": "dark", "language": "English"}
|
|
self.state["items"] = []
|
|
return "Initialized"
|
|
|
|
@listen(initialize_data)
|
|
def process_data(self, previous_result):
|
|
user = self.state["user_name"]
|
|
self.state["items"].append("item1")
|
|
self.state["processed"] = True
|
|
return "Processed"
|
|
|
|
flow = UnstructuredStateFlow()
|
|
result = flow.kickoff()
|
|
```
|
|
|
|
### مثال الحالة المنظمة
|
|
|
|
```python
|
|
from crewai.flow.flow import Flow, listen, start
|
|
from pydantic import BaseModel, Field
|
|
from typing import List, Dict, Optional
|
|
|
|
class AppState(BaseModel):
|
|
user_name: str = ""
|
|
items: List[str] = []
|
|
processed: bool = False
|
|
completion_percentage: float = 0.0
|
|
|
|
class StructuredStateFlow(Flow[AppState]):
|
|
@start()
|
|
def initialize_data(self):
|
|
self.state.user_name = "Taylor"
|
|
return "Initialized"
|
|
|
|
@listen(initialize_data)
|
|
def process_data(self, previous_result):
|
|
self.state.items.append("item1")
|
|
self.state.processed = True
|
|
self.state.completion_percentage = 50.0
|
|
return "Processed"
|
|
|
|
flow = StructuredStateFlow()
|
|
result = flow.kickoff()
|
|
```
|
|
|
|
### فوائد الحالة المنظمة
|
|
|
|
1. **سلامة الأنواع** - اكتشاف أخطاء الأنواع في وقت التطوير
|
|
2. **توثيق ذاتي** - نموذج الحالة يوثّق بوضوح البيانات المتاحة
|
|
3. **التحقق** - التحقق التلقائي من أنواع البيانات والقيود
|
|
4. **دعم IDE** - إكمال تلقائي وتوثيق مضمّن
|
|
5. **قيم افتراضية** - تعريف بدائل سهلة للبيانات المفقودة
|
|
|
|
## حفظ حالة Flow
|
|
|
|
يوفر مزخرف `@persist()` حفظ حالة تلقائي عند نقاط رئيسية في التنفيذ.
|
|
|
|
```python
|
|
from crewai.flow.flow import Flow, listen, start
|
|
from crewai.flow.persistence import persist
|
|
from pydantic import BaseModel
|
|
|
|
class CounterState(BaseModel):
|
|
value: int = 0
|
|
|
|
@persist()
|
|
class PersistentCounterFlow(Flow[CounterState]):
|
|
@start()
|
|
def increment(self):
|
|
self.state.value += 1
|
|
return self.state.value
|
|
|
|
@listen(increment)
|
|
def double(self, value):
|
|
self.state.value = value * 2
|
|
return self.state.value
|
|
```
|
|
|
|
#### تفرع الحالة المستمرة
|
|
|
|
يدعم `@persist` نمطين متميزين للترطيب في `kickoff` / `kickoff_async`. استخدم **استئناف** (`inputs["id"]`) لمواصلة نفس النسب؛ استخدم **تفرع** (`restore_from_state_id`) لبدء نسبٍ جديد من لقطة:
|
|
|
|
| | `state.id` بعد kickoff | كتابات `@persist` تذهب إلى |
|
|
|---|---|---|
|
|
| `inputs["id"]` (استئناف) | المعرّف المقدم | المعرّف المقدم (يمد التاريخ) |
|
|
| `restore_from_state_id` (تفرع) | معرّف جديد، أو `inputs["id"]` إذا ثُبّت | المعرّف الجديد (المصدر محفوظ) |
|
|
|
|
```python
|
|
from crewai.flow.flow import Flow, start
|
|
from crewai.flow.persistence import persist
|
|
from pydantic import BaseModel
|
|
|
|
class CounterState(BaseModel):
|
|
id: str = ""
|
|
counter: int = 0
|
|
|
|
@persist
|
|
class CounterFlow(Flow[CounterState]):
|
|
@start()
|
|
def step(self):
|
|
self.state.counter += 1
|
|
|
|
# التشغيل 1: حالة جديدة، العداد 0 -> 1
|
|
flow_1 = CounterFlow()
|
|
flow_1.kickoff()
|
|
|
|
# التفرع: الترطيب من أحدث لقطة لـ flow_1، لكن الكتابة تحت state.id جديد
|
|
flow_2 = CounterFlow()
|
|
flow_2.kickoff(restore_from_state_id=flow_1.state.id)
|
|
# يبدأ flow_2 بـ counter=1 (مرطّب)، ثم تزيده step() إلى 2.
|
|
# تاريخ flow_uuid لـ flow_1 لم يتغيّر.
|
|
```
|
|
|
|
ملاحظات السلوك:
|
|
|
|
- `restore_from_state_id` غير موجود في الاستمرارية → يعود kickoff بصمت إلى السلوك الافتراضي (يعكس سلوك `inputs["id"]` عند عدم العثور عليه). لا يُطلق أي استثناء.
|
|
- الجمع بين `restore_from_state_id` و `from_checkpoint` يطلق `ValueError` — يستهدفان نظامي حالة مختلفين (`@persist` مقابل Checkpointing) ولا يمكن الجمع بينهما.
|
|
- `restore_from_state_id=None` (افتراضي) متطابق بايت ببايت مع kickoff بدون المعامل.
|
|
- تثبيت `inputs["id"]` أثناء التفرع يعني أن التشغيل الجديد يشارك مفتاح الاستمرارية مع تدفق آخر — عادةً ما تريد فقط `restore_from_state_id`.
|
|
|
|
## أنماط حالة متقدمة
|
|
|
|
### المنطق الشرطي المبني على الحالة
|
|
|
|
```python
|
|
from crewai.flow.flow import Flow, listen, router, start
|
|
from pydantic import BaseModel
|
|
|
|
class PaymentState(BaseModel):
|
|
amount: float = 0.0
|
|
is_approved: bool = False
|
|
retry_count: int = 0
|
|
|
|
class PaymentFlow(Flow[PaymentState]):
|
|
@start()
|
|
def process_payment(self):
|
|
self.state.amount = 100.0
|
|
self.state.is_approved = self.state.amount < 1000
|
|
return "Payment processed"
|
|
|
|
@router(process_payment)
|
|
def check_approval(self, previous_result):
|
|
if self.state.is_approved:
|
|
return "approved"
|
|
elif self.state.retry_count < 3:
|
|
return "retry"
|
|
else:
|
|
return "rejected"
|
|
|
|
@listen("approved")
|
|
def handle_approval(self):
|
|
return f"Payment of ${self.state.amount} approved!"
|
|
|
|
@listen("retry")
|
|
def handle_retry(self):
|
|
self.state.retry_count += 1
|
|
return "Retry initiated"
|
|
|
|
@listen("rejected")
|
|
def handle_rejection(self):
|
|
return f"Payment of ${self.state.amount} rejected after {self.state.retry_count} retries."
|
|
```
|
|
|
|
## أفضل الممارسات لإدارة الحالة
|
|
|
|
1. **اجعل الحالة مركّزة** - صمم الحالة لتحتوي فقط على ما هو ضروري
|
|
2. **استخدم الحالة المنظمة للـ Flows المعقدة** - مع نمو التعقيد تصبح الحالة المنظمة أكثر قيمة
|
|
3. **وثّق انتقالات الحالة** - للـ Flows المعقدة، وثّق كيف تتغير الحالة عبر التنفيذ
|
|
4. **عالج أخطاء الحالة بلطف** - طبّق معالجة أخطاء للوصول إلى الحالة
|
|
5. **استخدم الحالة لتتبع التقدم** - استفد من الحالة لتتبع التقدم في Flows طويلة التشغيل
|
|
6. **استخدم العمليات غير المتغيرة عند الإمكان** - خاصة مع الحالة المنظمة
|
|
|
|
## الخلاصة
|
|
|
|
إتقان إدارة الحالة في CrewAI Flows يمنحك القدرة على بناء تطبيقات AI متطورة وقوية تحافظ على السياق وتتخذ قرارات معقدة وتقدم نتائج متسقة.
|
|
|
|
<Check>
|
|
لقد أتقنت الآن مفاهيم وممارسات إدارة الحالة في CrewAI Flows! بهذه المعرفة، يمكنك إنشاء سير عمل AI قوية تحافظ على السياق بفعالية وتشارك البيانات بين الخطوات وتبني منطق تطبيق متطور.
|
|
</Check>
|
|
|
|
## الخطوات التالية
|
|
|
|
- جرّب الحالة المنظمة وغير المنظمة في Flows
|
|
- جرّب تطبيق حفظ الحالة لسير العمل طويلة التشغيل
|
|
- استكشف [بناء أول Crew](/ar/guides/crews/first-crew) لمعرفة كيف تعمل Crews وFlows معًا
|
|
- اطلع على [توثيق مرجع Flow](/ar/concepts/flows) لمزيد من الميزات المتقدمة
|