mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-04 22:49:23 +00:00
a237ebabba
* 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>
179 lines
6.2 KiB
Plaintext
179 lines
6.2 KiB
Plaintext
---
|
|
title: "تشغيل الطاقم"
|
|
description: "تشغيل طاقم على CrewAI AMP"
|
|
icon: "flag-checkered"
|
|
mode: "wide"
|
|
---
|
|
|
|
## نظرة عامة
|
|
|
|
بمجرد نشر طاقمك على منصة CrewAI AMP، يمكنك بدء عمليات التنفيذ عبر واجهة الويب أو API. يغطي هذا الدليل كلا النهجين.
|
|
|
|
## الطريقة 1: استخدام واجهة الويب
|
|
|
|
### الخطوة 1: الانتقال إلى طاقمك المنشور
|
|
|
|
1. سجّل الدخول إلى [CrewAI AMP](https://app.crewai.com)
|
|
2. انقر على اسم الطاقم من قائمة مشاريعك
|
|
3. ستنتقل إلى صفحة تفاصيل الطاقم
|
|
|
|
<Frame></Frame>
|
|
|
|
### الخطوة 2: بدء التنفيذ
|
|
|
|
من صفحة تفاصيل طاقمك، لديك خياران لبدء التنفيذ:
|
|
|
|
#### الخيار أ: التشغيل السريع
|
|
|
|
1. انقر على رابط `Kickoff` في قسم Test Endpoints
|
|
2. أدخل معاملات الإدخال المطلوبة لطاقمك في محرر JSON
|
|
3. انقر على زر `Send Request`
|
|
|
|
<Frame></Frame>
|
|
|
|
#### الخيار ب: استخدام الواجهة المرئية
|
|
|
|
1. انقر على علامة تبويب `Run` في صفحة تفاصيل الطاقم
|
|
2. أدخل المدخلات المطلوبة في حقول النموذج
|
|
3. انقر على زر `Run Crew`
|
|
|
|
<Frame></Frame>
|
|
|
|
### الخطوة 3: مراقبة تقدم التنفيذ
|
|
|
|
بعد بدء التنفيذ:
|
|
|
|
1. ستتلقى استجابة تحتوي على `kickoff_id` - **انسخ هذا المعرّف**
|
|
2. هذا المعرّف ضروري لتتبع تنفيذك
|
|
|
|
<Frame></Frame>
|
|
|
|
### الخطوة 4: التحقق من حالة التنفيذ
|
|
|
|
لمراقبة تقدم تنفيذك:
|
|
|
|
1. انقر على نقطة نهاية "Status" في قسم Test Endpoints
|
|
2. الصق `kickoff_id` في الحقل المخصص
|
|
3. انقر على زر "Get Status"
|
|
|
|
<Frame></Frame>
|
|
|
|
ستعرض استجابة الحالة:
|
|
|
|
- حالة التنفيذ الحالية (`running`، `completed`، إلخ.)
|
|
- تفاصيل حول المهام الجارية
|
|
- أي مخرجات أُنتجت حتى الآن
|
|
|
|
### الخطوة 5: عرض النتائج النهائية
|
|
|
|
بمجرد اكتمال التنفيذ:
|
|
|
|
1. ستتغير الحالة إلى `completed`
|
|
2. يمكنك عرض نتائج ومخرجات التنفيذ الكاملة
|
|
3. لعرض أكثر تفصيلاً، تحقق من علامة تبويب `Executions` في صفحة تفاصيل الطاقم
|
|
|
|
## الطريقة 2: استخدام API
|
|
|
|
يمكنك أيضاً تشغيل الطواقم برمجياً باستخدام REST API لـ CrewAI AMP.
|
|
|
|
### المصادقة
|
|
|
|
جميع طلبات API تتطلب رمز حامل للمصادقة:
|
|
|
|
```bash
|
|
curl -H "Authorization: Bearer YOUR_CREW_TOKEN" https://your-crew-url.crewai.com
|
|
```
|
|
|
|
رمز الحامل متاح في علامة تبويب Status في صفحة تفاصيل طاقمك.
|
|
|
|
### التحقق من صحة الطاقم
|
|
|
|
قبل تنفيذ العمليات، يمكنك التحقق من أن طاقمك يعمل بشكل صحيح:
|
|
|
|
```bash
|
|
curl -H "Authorization: Bearer YOUR_CREW_TOKEN" https://your-crew-url.crewai.com
|
|
```
|
|
|
|
ستعيد الاستجابة الناجحة رسالة تشير إلى أن الطاقم يعمل:
|
|
|
|
```
|
|
Healthy%
|
|
```
|
|
|
|
### الخطوة 1: استرداد المدخلات المطلوبة
|
|
|
|
أولاً، حدد المدخلات التي يتطلبها طاقمك:
|
|
|
|
```bash
|
|
curl -X GET \
|
|
-H "Authorization: Bearer YOUR_CREW_TOKEN" \
|
|
https://your-crew-url.crewai.com/inputs
|
|
```
|
|
|
|
ستكون الاستجابة كائن JSON يحتوي على مصفوفة من معاملات الإدخال المطلوبة، على سبيل المثال:
|
|
|
|
```json
|
|
{ "inputs": ["topic", "current_year"] }
|
|
```
|
|
|
|
يوضح هذا المثال أن هذا الطاقم المحدد يتطلب مدخلين: `topic` و`current_year`.
|
|
|
|
### الخطوة 2: بدء التنفيذ
|
|
|
|
ابدأ التنفيذ بتقديم المدخلات المطلوبة:
|
|
|
|
```bash
|
|
curl -X POST \
|
|
-H "Content-Type: application/json" \
|
|
-H "Authorization: Bearer YOUR_CREW_TOKEN" \
|
|
-d '{"inputs": {"topic": "AI Agent Frameworks", "current_year": "2025"}}' \
|
|
https://your-crew-url.crewai.com/kickoff
|
|
```
|
|
|
|
ستتضمن الاستجابة `kickoff_id` الذي ستحتاجه للتتبع:
|
|
|
|
```json
|
|
{ "kickoff_id": "abcd1234-5678-90ef-ghij-klmnopqrstuv" }
|
|
```
|
|
|
|
### الخطوة 3: التحقق من حالة التنفيذ
|
|
|
|
راقب تقدم التنفيذ باستخدام kickoff_id:
|
|
|
|
```bash
|
|
curl -X GET \
|
|
-H "Authorization: Bearer YOUR_CREW_TOKEN" \
|
|
https://your-crew-url.crewai.com/status/abcd1234-5678-90ef-ghij-klmnopqrstuv
|
|
```
|
|
|
|
## التعامل مع عمليات التنفيذ
|
|
|
|
### عمليات التنفيذ طويلة المدة
|
|
|
|
لعمليات التنفيذ التي قد تستغرق وقتاً طويلاً:
|
|
|
|
1. فكّر في تنفيذ آلية استعلام دوري للتحقق من الحالة بشكل دوري
|
|
2. استخدم webhooks (إذا كانت متاحة) للإشعار عند اكتمال التنفيذ
|
|
3. نفّذ معالجة الأخطاء للمهلات الزمنية المحتملة
|
|
|
|
### سياق التنفيذ
|
|
|
|
يتضمن سياق التنفيذ:
|
|
|
|
- المدخلات المقدمة عند التشغيل
|
|
- متغيرات البيئة المُهيأة أثناء النشر
|
|
- أي حالة محفوظة بين المهام
|
|
|
|
### تصحيح أخطاء عمليات التنفيذ الفاشلة
|
|
|
|
إذا فشل التنفيذ:
|
|
|
|
1. تحقق من علامة تبويب "Executions" للسجلات المفصلة
|
|
2. راجع علامة تبويب "Traces" لتفاصيل التنفيذ خطوة بخطوة
|
|
3. ابحث عن استجابات LLM واستخدام الأدوات في تفاصيل التتبع
|
|
|
|
<Card title="تحتاج مساعدة؟" icon="headset" href="mailto:support@crewai.com">
|
|
تواصل مع فريق الدعم للمساعدة في مشاكل التنفيذ أو أسئلة حول
|
|
منصة Enterprise.
|
|
</Card>
|