mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 13:18:10 +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>
222 lines
9.4 KiB
Plaintext
222 lines
9.4 KiB
Plaintext
---
|
|
title: "تكامل Maxim"
|
|
description: "بدء مراقبة وتقييم ومراقبة الوكلاء"
|
|
icon: "infinity"
|
|
mode: "wide"
|
|
---
|
|
|
|
# نظرة عامة على Maxim
|
|
|
|
يوفر Maxim AI مراقبة شاملة للوكلاء وتقييماً ومراقبة لتطبيقات CrewAI. مع تكامل Maxim بسطر واحد، يمكنك بسهولة تتبع وتحليل تفاعلات الوكلاء ومقاييس الأداء والمزيد.
|
|
|
|
## الميزات
|
|
|
|
### إدارة المطالبات
|
|
|
|
تمكّنك قدرات إدارة المطالبات في Maxim من إنشاء وتنظيم وتحسين المطالبات لوكلاء CrewAI. بدلاً من ترميز التعليمات مباشرة، استفد من SDK الخاص بـ Maxim لاسترداد وتطبيق مطالبات مُدارة بالإصدارات ديناميكياً.
|
|
|
|
<Tabs>
|
|
<Tab title="ساحة المطالبات">
|
|
أنشئ وصقل وجرّب وانشر مطالباتك عبر الساحة. نظّم مطالباتك باستخدام المجلدات والإصدارات، وجرّب مع حالات العالم الحقيقي عن طريق ربط الأدوات والسياق، وانشر بناءً على منطق مخصص.
|
|
|
|
<img src='https://raw.githubusercontent.com/akmadan/crewAI/docs_maxim_observability/docs/images/maxim_playground.png'> </img>
|
|
</Tab>
|
|
<Tab title="إصدارات المطالبات">
|
|
مع بناء الفرق لتطبيقات الذكاء الاصطناعي، يُعد جزء كبير من التجريب هو التكرار على هيكل المطالبات. للتعاون بفعالية وتنظيم التغييرات بوضوح، يسمح Maxim بإصدارات المطالبات ومقارنة التشغيلات عبر الإصدارات.
|
|
|
|
<img src='https://raw.githubusercontent.com/akmadan/crewAI/docs_maxim_observability/docs/images/maxim_versions.png'> </img>
|
|
</Tab>
|
|
<Tab title="مقارنة المطالبات">
|
|
التكرار على المطالبات أثناء تطوير تطبيق الذكاء الاصطناعي يحتاج تجارب عبر النماذج وهياكل المطالبات وغيرها. لمقارنة الإصدارات واتخاذ قرارات مستنيرة، تسمح ساحة المقارنة بعرض جنب إلى جنب للنتائج.
|
|
|
|
## **لماذا تستخدم مقارنة المطالبات؟**
|
|
|
|
تجمع مقارنة المطالبات عدة مطالبات فردية في عرض واحد، مما يمكّن من نهج مبسط لسير عمل متنوع:
|
|
|
|
1. **مقارنة النماذج**: تقييم أداء نماذج مختلفة على نفس المطالبة.
|
|
2. **تحسين المطالبات**: مقارنة إصدارات مختلفة لتحديد الصياغة الأكثر فعالية.
|
|
3. **اتساق عبر النماذج**: ضمان مخرجات متسقة عبر نماذج مختلفة لنفس المطالبة.
|
|
4. **قياس الأداء**: تحليل مقاييس مثل زمن الاستجابة والتكلفة وعدد الرموز عبر نماذج ومطالبات مختلفة.
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
### المراقبة والتقييمات
|
|
|
|
يوفر Maxim AI مراقبة وتقييماً شاملاً لوكلاء CrewAI، مما يساعدك في فهم ما يحدث بالضبط أثناء كل تنفيذ.
|
|
|
|
<Tabs>
|
|
<Tab title="تتبع الوكلاء">
|
|
تتبع دورة حياة وكيلك الكاملة، بما في ذلك استدعاءات الأدوات ومسارات الوكلاء وتدفقات القرار بسهولة.
|
|
|
|
<img src='https://raw.githubusercontent.com/akmadan/crewAI/docs_maxim_observability/docs/images/maxim_agent_tracking.png'> </img>
|
|
</Tab>
|
|
<Tab title="التحليلات + التقييمات">
|
|
شغّل تقييمات مفصلة على التتبعات الكاملة أو العقد الفردية مع دعم لـ:
|
|
|
|
- التفاعلات متعددة الخطوات وتحليل التتبع الدقيق
|
|
- تقييمات على مستوى الجلسة
|
|
- محاكاة لاختبار العالم الحقيقي
|
|
|
|
<img src='https://raw.githubusercontent.com/akmadan/crewAI/docs_maxim_observability/docs/images/maxim_trace_eval.png'> </img>
|
|
|
|
<CardGroup cols={3}>
|
|
<Card title="تقييمات تلقائية على السجلات" icon="e" href="https://www.getmaxim.ai/docs/observe/how-to/evaluate-logs/auto-evaluation">
|
|
<p>
|
|
تقييم السجلات الملتقطة تلقائياً من واجهة المستخدم بناءً على المرشحات والعينات
|
|
</p>
|
|
</Card>
|
|
<Card title="تقييمات بشرية على السجلات" icon="hand" href="https://www.getmaxim.ai/docs/observe/how-to/evaluate-logs/human-evaluation">
|
|
<p>
|
|
استخدام التقييم البشري أو التصنيف لتقييم جودة سجلاتك
|
|
</p>
|
|
</Card>
|
|
<Card title="تقييمات على مستوى العقد" icon="road" href="https://www.getmaxim.ai/docs/observe/how-to/evaluate-logs/node-level-evaluation">
|
|
<p>
|
|
تقييم أي مكون من تتبعك أو سجلك للحصول على رؤى حول سلوك وكيلك
|
|
</p>
|
|
</Card>
|
|
</CardGroup>
|
|
---
|
|
</Tab>
|
|
<Tab title="التنبيهات">
|
|
عيّن حدوداً على **الأخطاء والتكلفة واستخدام الرموز وتغذية المستخدم الراجعة وزمن الاستجابة** واحصل على تنبيهات فورية عبر Slack أو PagerDuty.
|
|
|
|
<img src='https://raw.githubusercontent.com/akmadan/crewAI/docs_maxim_observability/docs/images/maxim_alerts_1.png'> </img>
|
|
</Tab>
|
|
<Tab title="لوحات المعلومات">
|
|
تصور التتبعات عبر الزمن ومقاييس الاستخدام وزمن الاستجابة ومعدلات الأخطاء بسهولة.
|
|
|
|
<img src='https://raw.githubusercontent.com/akmadan/crewAI/docs_maxim_observability/docs/images/maxim_dashboard_1.png'> </img>
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## البدء
|
|
|
|
### المتطلبات الأساسية
|
|
|
|
- إصدار Python >= 3.10
|
|
- حساب Maxim ([سجّل هنا](https://getmaxim.ai/))
|
|
- توليد مفتاح API من Maxim
|
|
- مشروع CrewAI
|
|
|
|
### التثبيت
|
|
|
|
ثبّت Maxim SDK عبر pip:
|
|
|
|
```python
|
|
pip install maxim-py
|
|
```
|
|
|
|
أو أضفه إلى ملف `requirements.txt`:
|
|
|
|
```
|
|
maxim-py
|
|
```
|
|
|
|
### الإعداد الأساسي
|
|
|
|
### 1. إعداد متغيرات البيئة
|
|
|
|
```python
|
|
### Environment Variables Setup
|
|
|
|
# Create a `.env` file in your project root:
|
|
|
|
# Maxim API Configuration
|
|
MAXIM_API_KEY=your_api_key_here
|
|
MAXIM_LOG_REPO_ID=your_repo_id_here
|
|
```
|
|
|
|
### 2. استيراد الحزم المطلوبة
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew, Process
|
|
from maxim import Maxim
|
|
from maxim.logger.crewai import instrument_crewai
|
|
```
|
|
|
|
### 3. تهيئة Maxim بمفتاح API
|
|
|
|
```python {8}
|
|
# Instrument CrewAI with just one line
|
|
instrument_crewai(Maxim().logger())
|
|
```
|
|
|
|
### 4. إنشاء وتشغيل تطبيق CrewAI كالمعتاد
|
|
|
|
```python
|
|
# Create your agent
|
|
researcher = Agent(
|
|
role='Senior Research Analyst',
|
|
goal='Uncover cutting-edge developments in AI',
|
|
backstory="You are an expert researcher at a tech think tank...",
|
|
verbose=True,
|
|
llm=llm
|
|
)
|
|
|
|
# Define the task
|
|
research_task = Task(
|
|
description="Research the latest AI advancements...",
|
|
expected_output="",
|
|
agent=researcher
|
|
)
|
|
|
|
# Configure and run the crew
|
|
crew = Crew(
|
|
agents=[researcher],
|
|
tasks=[research_task],
|
|
verbose=True
|
|
)
|
|
|
|
try:
|
|
result = crew.kickoff()
|
|
finally:
|
|
maxim.cleanup() # Ensure cleanup happens even if errors occur
|
|
```
|
|
|
|
هذا كل شيء! سيتم الآن تسجيل جميع تفاعلات وكلاء CrewAI وستكون متاحة في لوحة معلومات Maxim.
|
|
|
|
تحقق من دفتر Google Colab هذا كمرجع سريع - [الدفتر](https://colab.research.google.com/drive/1ZKIZWsmgQQ46n8TH9zLsT1negKkJA6K8?usp=sharing)
|
|
|
|
## عرض تتبعاتك
|
|
|
|
بعد تشغيل تطبيق CrewAI:
|
|
|
|
1. سجل الدخول إلى [لوحة معلومات Maxim](https://app.getmaxim.ai/login)
|
|
2. انتقل إلى مستودعك
|
|
3. اعرض تتبعات الوكلاء المفصلة، بما في ذلك:
|
|
- محادثات الوكلاء
|
|
- أنماط استخدام الأدوات
|
|
- مقاييس الأداء
|
|
- تحليلات التكاليف
|
|
|
|
<img src='https://raw.githubusercontent.com/akmadan/crewAI/docs_maxim_observability/docs/images/crewai_traces.gif'> </img>
|
|
|
|
## استكشاف الأخطاء وإصلاحها
|
|
|
|
### المشاكل الشائعة
|
|
|
|
- **عدم ظهور تتبعات**: تأكد من صحة مفتاح API ومعرف المستودع
|
|
- تأكد من استدعاء **`instrument_crewai()`** **_قبل_** تشغيل طاقمك
|
|
- عيّن `debug=True` في استدعاء `instrument_crewai()` لإظهار أي أخطاء داخلية:
|
|
|
|
```python
|
|
instrument_crewai(logger, debug=True)
|
|
```
|
|
- أعدّ وكلاءك مع `verbose=True` لالتقاط سجلات مفصلة
|
|
- تحقق مرة أخرى من أن `instrument_crewai()` يُستدعى **قبل** إنشاء أو تنفيذ الوكلاء
|
|
|
|
## الموارد
|
|
|
|
<CardGroup cols="3">
|
|
<Card title="وثائق CrewAI" icon="book" href="https://docs.crewai.com/">
|
|
وثائق CrewAI الرسمية
|
|
</Card>
|
|
<Card title="وثائق Maxim" icon="book" href="https://getmaxim.ai/docs">
|
|
وثائق Maxim الرسمية
|
|
</Card>
|
|
<Card title="Maxim Github" icon="github" href="https://github.com/maximhq">
|
|
Maxim Github
|
|
</Card>
|
|
</CardGroup>
|