mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-22 07:15:10 +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>
156 lines
5.7 KiB
Plaintext
156 lines
5.7 KiB
Plaintext
---
|
|
title: 'مستودعات الوكلاء'
|
|
description: 'تعرّف على كيفية استخدام مستودعات الوكلاء لمشاركة وإعادة استخدام وكلائك عبر الفرق والمشاريع'
|
|
icon: 'people-group'
|
|
mode: "wide"
|
|
---
|
|
|
|
تتيح مستودعات الوكلاء لمستخدمي المؤسسات تخزين ومشاركة وإعادة استخدام تعريفات الوكلاء عبر الفرق والمشاريع. تُمكّن هذه الميزة المؤسسات من الاحتفاظ بمكتبة مركزية من الوكلاء الموحدين، مما يعزز الاتساق ويقلل من ازدواجية الجهود.
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
## فوائد مستودعات الوكلاء
|
|
|
|
- **التوحيد**: الحفاظ على تعريفات وكلاء متسقة عبر مؤسستك
|
|
- **إعادة الاستخدام**: إنشاء وكيل مرة واحدة واستخدامه في أطقم ومشاريع متعددة
|
|
- **الحوكمة**: تطبيق سياسات على مستوى المؤسسة لتهيئات الوكلاء
|
|
- **التعاون**: تمكين الفرق من المشاركة والبناء على عمل بعضهم البعض
|
|
|
|
## إنشاء واستخدام مستودعات الوكلاء
|
|
|
|
1. يجب أن يكون لديك حساب في CrewAI، جرّب [الخطة المجانية](https://app.crewai.com).
|
|
2. أنشئ وكلاء بأدوار وأهداف محددة لسير عملك.
|
|
3. هيّئ الأدوات والقدرات لكل مساعد متخصص.
|
|
4. انشر الوكلاء عبر المشاريع من خلال الواجهة المرئية أو تكامل API.
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
|
|
### تحميل الوكلاء من المستودعات
|
|
|
|
يمكنك تحميل الوكلاء من المستودعات في الكود باستخدام معامل `from_repository` للتشغيل محليًا:
|
|
|
|
```python
|
|
from crewai import Agent
|
|
|
|
# إنشاء وكيل بتحميله من مستودع
|
|
# يتم تحميل الوكيل بجميع إعداداته المحددة مسبقًا
|
|
researcher = Agent(
|
|
from_repository="market-research-agent"
|
|
)
|
|
```
|
|
|
|
### تجاوز إعدادات المستودع
|
|
|
|
يمكنك تجاوز إعدادات محددة من المستودع بتوفيرها في التهيئة:
|
|
|
|
```python
|
|
researcher = Agent(
|
|
from_repository="market-research-agent",
|
|
goal="Research the latest trends in AI development", # تجاوز هدف المستودع
|
|
verbose=True # إضافة إعداد غير موجود في المستودع
|
|
)
|
|
```
|
|
|
|
### مثال: إنشاء طاقم مع وكلاء المستودع
|
|
|
|
```python
|
|
from crewai import Crew, Agent, Task
|
|
|
|
# تحميل الوكلاء من المستودعات
|
|
researcher = Agent(
|
|
from_repository="market-research-agent"
|
|
)
|
|
|
|
writer = Agent(
|
|
from_repository="content-writer-agent"
|
|
)
|
|
|
|
# إنشاء المهام
|
|
research_task = Task(
|
|
description="Research the latest trends in AI",
|
|
agent=researcher
|
|
)
|
|
|
|
writing_task = Task(
|
|
description="Write a comprehensive report based on the research",
|
|
agent=writer
|
|
)
|
|
|
|
# إنشاء الطاقم
|
|
crew = Crew(
|
|
agents=[researcher, writer],
|
|
tasks=[research_task, writing_task],
|
|
verbose=True
|
|
)
|
|
|
|
# تشغيل الطاقم
|
|
result = crew.kickoff()
|
|
```
|
|
|
|
### مثال: استخدام `kickoff()` مع وكلاء المستودع
|
|
|
|
يمكنك أيضًا استخدام وكلاء المستودع مباشرة مع طريقة `kickoff()` للتفاعلات الأبسط:
|
|
|
|
```python
|
|
from crewai import Agent
|
|
from pydantic import BaseModel
|
|
from typing import List
|
|
|
|
# تعريف تنسيق مخرجات منظم
|
|
class MarketAnalysis(BaseModel):
|
|
key_trends: List[str]
|
|
opportunities: List[str]
|
|
recommendation: str
|
|
|
|
# تحميل وكيل من المستودع
|
|
analyst = Agent(
|
|
from_repository="market-analyst-agent",
|
|
verbose=True
|
|
)
|
|
|
|
# الحصول على استجابة حرة
|
|
result = analyst.kickoff("Analyze the AI market in 2025")
|
|
print(result.raw) # الوصول إلى الاستجابة الخام
|
|
|
|
# الحصول على مخرجات منظمة
|
|
structured_result = analyst.kickoff(
|
|
"Provide a structured analysis of the AI market in 2025",
|
|
response_format=MarketAnalysis
|
|
)
|
|
|
|
# الوصول إلى البيانات المنظمة
|
|
print(f"Key Trends: {structured_result.pydantic.key_trends}")
|
|
print(f"Recommendation: {structured_result.pydantic.recommendation}")
|
|
```
|
|
|
|
## أفضل الممارسات
|
|
|
|
1. **اصطلاح التسمية**: استخدم أسماء واضحة ووصفية لوكلاء المستودع
|
|
2. **التوثيق**: أدرج أوصافًا شاملة لكل وكيل
|
|
3. **إدارة الأدوات**: تأكد من توفر الأدوات المشار إليها بواسطة وكلاء المستودع في بيئتك
|
|
4. **التحكم في الوصول**: أدر الصلاحيات لضمان أن أعضاء الفريق المصرّح لهم فقط يمكنهم تعديل وكلاء المستودع
|
|
|
|
## إدارة المؤسسة
|
|
|
|
للتبديل بين المؤسسات أو عرض مؤسستك الحالية، استخدم واجهة سطر أوامر CrewAI:
|
|
|
|
```bash
|
|
# عرض المؤسسة الحالية
|
|
crewai org current
|
|
|
|
# التبديل إلى مؤسسة مختلفة
|
|
crewai org switch <org_id>
|
|
|
|
# عرض جميع المؤسسات المتاحة
|
|
crewai org list
|
|
```
|
|
|
|
<Note>
|
|
عند تحميل الوكلاء من المستودعات، يجب أن تكون مصادقًا ومتحولًا إلى المؤسسة الصحيحة. إذا تلقيت أخطاء، تحقق من حالة المصادقة وإعدادات المؤسسة باستخدام أوامر CLI أعلاه.
|
|
</Note>
|