mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 21:28: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>
131 lines
6.1 KiB
Plaintext
131 lines
6.1 KiB
Plaintext
---
|
|
title: تكامل Opik
|
|
description: تعرّف على كيفية استخدام Comet Opik لتصحيح الأخطاء وتقييم ومراقبة تطبيقات CrewAI الخاصة بك مع تتبع شامل وتقييمات آلية ولوحات معلومات جاهزة للإنتاج.
|
|
icon: meteor
|
|
mode: "wide"
|
|
---
|
|
|
|
# نظرة عامة على Opik
|
|
|
|
مع [Comet Opik](https://www.comet.com/docs/opik/)، يمكنك تصحيح الأخطاء وتقييم ومراقبة تطبيقات LLM وأنظمة RAG وسير العمل الوكيلي مع تتبع شامل وتقييمات آلية ولوحات معلومات جاهزة للإنتاج.
|
|
|
|
<Frame caption="لوحة معلومات Opik للوكلاء">
|
|
<img src="/images/opik-crewai-dashboard.png" alt="Opik agent monitoring example with CrewAI" />
|
|
</Frame>
|
|
|
|
يوفر Opik دعماً شاملاً لكل مرحلة من مراحل تطوير تطبيق CrewAI الخاص بك:
|
|
|
|
- **تسجيل التتبعات والنطاقات**: تتبع تلقائي لاستدعاءات LLM ومنطق التطبيق لتصحيح الأخطاء وتحليل أنظمة التطوير والإنتاج. أضف التعليقات التوضيحية يدوياً أو برمجياً، واعرض وقارن الاستجابات عبر المشاريع.
|
|
- **تقييم أداء تطبيق LLM**: قيّم وفقاً لمجموعة اختبار مخصصة وشغّل مقاييس تقييم مدمجة أو حدد مقاييسك الخاصة في SDK أو واجهة المستخدم.
|
|
- **الاختبار ضمن خط أنابيب CI/CD**: أنشئ خطوط أساس أداء موثوقة مع اختبارات وحدة LLM من Opik، المبنية على PyTest. شغّل تقييمات عبر الإنترنت للمراقبة المستمرة في الإنتاج.
|
|
- **مراقبة وتحليل بيانات الإنتاج**: افهم أداء نماذجك على بيانات غير مرئية في الإنتاج وأنشئ مجموعات بيانات لتكرارات التطوير الجديدة.
|
|
|
|
## الإعداد
|
|
يوفر Comet نسخة مستضافة من منصة Opik، أو يمكنك تشغيل المنصة محلياً.
|
|
|
|
لاستخدام النسخة المستضافة، ما عليك سوى [إنشاء حساب Comet مجاني](https://www.comet.com/signup?utm_medium=github&utm_source=crewai_docs) والحصول على مفتاح API الخاص بك.
|
|
|
|
لتشغيل منصة Opik محلياً، راجع [دليل التثبيت](https://www.comet.com/docs/opik/self-host/overview/) لمزيد من المعلومات.
|
|
|
|
في هذا الدليل سنستخدم مثال البدء السريع الخاص بـ CrewAI.
|
|
|
|
<Steps>
|
|
<Step title="تثبيت الحزم المطلوبة">
|
|
```shell
|
|
pip install crewai crewai-tools opik --upgrade
|
|
```
|
|
</Step>
|
|
<Step title="إعداد Opik">
|
|
```python
|
|
import opik
|
|
opik.configure(use_local=False)
|
|
```
|
|
</Step>
|
|
<Step title="إعداد البيئة">
|
|
أولاً، نقوم بإعداد مفاتيح API لمزود LLM كمتغيرات بيئة:
|
|
|
|
```python
|
|
import os
|
|
import getpass
|
|
|
|
if "OPENAI_API_KEY" not in os.environ:
|
|
os.environ["OPENAI_API_KEY"] = getpass.getpass("Enter your OpenAI API key: ")
|
|
```
|
|
</Step>
|
|
<Step title="استخدام CrewAI">
|
|
الخطوة الأولى هي إنشاء مشروعنا. سنستخدم مثالاً من وثائق CrewAI:
|
|
|
|
```python
|
|
from crewai import Agent, Crew, Task, Process
|
|
|
|
|
|
class YourCrewName:
|
|
def agent_one(self) -> Agent:
|
|
return Agent(
|
|
role="Data Analyst",
|
|
goal="Analyze data trends in the market",
|
|
backstory="An experienced data analyst with a background in economics",
|
|
verbose=True,
|
|
)
|
|
|
|
def agent_two(self) -> Agent:
|
|
return Agent(
|
|
role="Market Researcher",
|
|
goal="Gather information on market dynamics",
|
|
backstory="A diligent researcher with a keen eye for detail",
|
|
verbose=True,
|
|
)
|
|
|
|
def task_one(self) -> Task:
|
|
return Task(
|
|
name="Collect Data Task",
|
|
description="Collect recent market data and identify trends.",
|
|
expected_output="A report summarizing key trends in the market.",
|
|
agent=self.agent_one(),
|
|
)
|
|
|
|
def task_two(self) -> Task:
|
|
return Task(
|
|
name="Market Research Task",
|
|
description="Research factors affecting market dynamics.",
|
|
expected_output="An analysis of factors influencing the market.",
|
|
agent=self.agent_two(),
|
|
)
|
|
|
|
def crew(self) -> Crew:
|
|
return Crew(
|
|
agents=[self.agent_one(), self.agent_two()],
|
|
tasks=[self.task_one(), self.task_two()],
|
|
process=Process.sequential,
|
|
verbose=True,
|
|
)
|
|
|
|
```
|
|
|
|
الآن يمكننا استيراد متتبع Opik وتشغيل الطاقم:
|
|
|
|
```python
|
|
from opik.integrations.crewai import track_crewai
|
|
|
|
track_crewai(project_name="crewai-integration-demo")
|
|
|
|
my_crew = YourCrewName().crew()
|
|
result = my_crew.kickoff()
|
|
|
|
print(result)
|
|
```
|
|
بعد تشغيل تطبيق CrewAI، قم بزيارة تطبيق Opik لعرض:
|
|
- تتبعات LLM والنطاقات وبياناتها الوصفية
|
|
- تفاعلات الوكلاء وتدفق تنفيذ المهام
|
|
- مقاييس الأداء مثل زمن الاستجابة واستخدام الرموز المميزة
|
|
- مقاييس التقييم (مدمجة أو مخصصة)
|
|
</Step>
|
|
</Steps>
|
|
|
|
## الموارد
|
|
|
|
- [وثائق Opik](https://www.comet.com/docs/opik/)
|
|
- [Opik + CrewAI Colab](https://colab.research.google.com/github/comet-ml/opik/blob/main/apps/opik-documentation/documentation/docs/cookbook/crewai.ipynb)
|
|
- [X](https://x.com/cometml)
|
|
- [Slack](https://slack.comet.com/)
|