mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 21:28:10 +00:00
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>
168 lines
7.7 KiB
Plaintext
168 lines
7.7 KiB
Plaintext
---
|
|
title: تكامل LangDB
|
|
description: إدارة وتأمين وتحسين سير عمل CrewAI مع بوابة LangDB AI — الوصول إلى أكثر من 350 نموذجاً وتوجيه تلقائي وتحسين التكاليف ومراقبة كاملة.
|
|
icon: database
|
|
mode: "wide"
|
|
---
|
|
|
|
# مقدمة
|
|
|
|
توفر [بوابة LangDB AI](https://langdb.ai) واجهات API متوافقة مع OpenAI للاتصال بنماذج لغة كبيرة متعددة وتعمل كمنصة مراقبة تجعل تتبع سير عمل CrewAI شاملاً وسهلاً مع توفير الوصول إلى أكثر من 350 نموذج لغة. مع استدعاء `init()` واحد، يتم التقاط جميع تفاعلات الوكلاء وتنفيذ المهام واستدعاءات LLM، مما يوفر مراقبة شاملة وبنية تحتية جاهزة للإنتاج لتطبيقاتك.
|
|
|
|
<Frame caption="مثال تتبع LangDB CrewAI">
|
|
<img src="/images/langdb-1.png" alt="مثال تتبع LangDB CrewAI" />
|
|
</Frame>
|
|
|
|
**تحقق من:** [عرض مثال التتبع المباشر](https://app.langdb.ai/sharing/threads/3becbfed-a1be-ae84-ea3c-4942867a3e22)
|
|
|
|
## الميزات
|
|
|
|
### قدرات بوابة AI
|
|
- **الوصول إلى أكثر من 350 LLM**: الاتصال بجميع نماذج اللغة الرئيسية من خلال تكامل واحد
|
|
- **النماذج الافتراضية**: إنشاء إعدادات نماذج مخصصة مع معاملات وقواعد توجيه محددة
|
|
- **MCP الافتراضي**: تفعيل التوافق والتكامل مع أنظمة MCP لتعزيز اتصال الوكلاء
|
|
- **حواجز الحماية**: تنفيذ تدابير السلامة وضوابط الامتثال لسلوك الوكلاء
|
|
|
|
### المراقبة والتتبع
|
|
- **تتبع تلقائي**: استدعاء `init()` واحد يلتقط جميع تفاعلات CrewAI
|
|
- **رؤية شاملة**: مراقبة سير عمل الوكلاء من البداية إلى النهاية
|
|
- **تتبع استخدام الأدوات**: تتبع الأدوات التي يستخدمها الوكلاء ونتائجها
|
|
- **مراقبة استدعاءات النماذج**: رؤى مفصلة لتفاعلات LLM
|
|
- **تحليلات الأداء**: مراقبة زمن الاستجابة واستخدام الرموز والتكاليف
|
|
- **دعم التصحيح**: تنفيذ خطوة بخطوة لاستكشاف الأخطاء
|
|
- **المراقبة في الوقت الفعلي**: لوحة معلومات التتبعات والمقاييس الحية
|
|
|
|
## تعليمات الإعداد
|
|
|
|
<Steps>
|
|
<Step title="تثبيت LangDB">
|
|
ثبّت عميل LangDB مع علامة ميزة CrewAI:
|
|
```bash
|
|
pip install 'pylangdb[crewai]'
|
|
```
|
|
</Step>
|
|
<Step title="تعيين متغيرات البيئة">
|
|
قم بإعداد بيانات اعتماد LangDB:
|
|
```bash
|
|
export LANGDB_API_KEY="<your_langdb_api_key>"
|
|
export LANGDB_PROJECT_ID="<your_langdb_project_id>"
|
|
export LANGDB_API_BASE_URL='https://api.us-east-1.langdb.ai'
|
|
```
|
|
</Step>
|
|
<Step title="تهيئة التتبع">
|
|
استورد وهيّئ LangDB قبل إعداد كود CrewAI:
|
|
```python
|
|
from pylangdb.crewai import init
|
|
# Initialize LangDB
|
|
init()
|
|
```
|
|
</Step>
|
|
<Step title="إعداد CrewAI مع LangDB">
|
|
قم بإعداد LLM مع رؤوس LangDB:
|
|
```python
|
|
from crewai import Agent, Task, Crew, LLM
|
|
import os
|
|
|
|
# Configure LLM with LangDB headers
|
|
llm = LLM(
|
|
model="openai/gpt-4o",
|
|
api_key=os.getenv("LANGDB_API_KEY"),
|
|
base_url=os.getenv("LANGDB_API_BASE_URL"),
|
|
extra_headers={"x-project-id": os.getenv("LANGDB_PROJECT_ID")}
|
|
)
|
|
```
|
|
</Step>
|
|
</Steps>
|
|
|
|
## مثال سريع للبدء
|
|
|
|
```python
|
|
import os
|
|
from pylangdb.crewai import init
|
|
from crewai import Agent, Task, Crew, LLM
|
|
|
|
init()
|
|
|
|
def create_llm(model):
|
|
return LLM(
|
|
model=model,
|
|
api_key=os.environ.get("LANGDB_API_KEY"),
|
|
base_url=os.environ.get("LANGDB_API_BASE_URL"),
|
|
extra_headers={"x-project-id": os.environ.get("LANGDB_PROJECT_ID")}
|
|
)
|
|
|
|
researcher = Agent(
|
|
role="Research Specialist",
|
|
goal="Research topics thoroughly",
|
|
backstory="Expert researcher with skills in finding information",
|
|
llm=create_llm("openai/gpt-4o"),
|
|
verbose=True
|
|
)
|
|
|
|
task = Task(
|
|
description="Research the given topic and provide a comprehensive summary",
|
|
agent=researcher,
|
|
expected_output="Detailed research summary with key findings"
|
|
)
|
|
|
|
crew = Crew(agents=[researcher], tasks=[task])
|
|
result = crew.kickoff()
|
|
print(result)
|
|
```
|
|
|
|
## عرض التتبعات في LangDB
|
|
|
|
بعد تشغيل تطبيق CrewAI، يمكنك عرض تتبعات مفصلة في لوحة معلومات LangDB:
|
|
|
|
<Frame caption="لوحة معلومات تتبع LangDB">
|
|
<img src="/images/langdb-2.png" alt="لوحة معلومات تتبع LangDB تعرض سير عمل CrewAI" />
|
|
</Frame>
|
|
|
|
### ما ستراه
|
|
|
|
- **تفاعلات الوكلاء**: التدفق الكامل لمحادثات الوكلاء وتسليم المهام
|
|
- **استخدام الأدوات**: الأدوات التي تم استدعاؤها ومدخلاتها ومخرجاتها
|
|
- **استدعاءات النماذج**: تفاعلات LLM المفصلة مع المطالبات والاستجابات
|
|
- **مقاييس الأداء**: تتبع زمن الاستجابة واستخدام الرموز والتكاليف
|
|
- **الجدول الزمني للتنفيذ**: عرض خطوة بخطوة لسير العمل بالكامل
|
|
|
|
## استكشاف الأخطاء وإصلاحها
|
|
|
|
### المشاكل الشائعة
|
|
|
|
- **عدم ظهور تتبعات**: تأكد من استدعاء `init()` قبل أي استيرادات CrewAI
|
|
- **أخطاء المصادقة**: تحقق من مفتاح API ومعرف المشروع في LangDB
|
|
|
|
## الموارد
|
|
|
|
<CardGroup cols={3}>
|
|
<Card title="وثائق LangDB" icon="book" href="https://docs.langdb.ai">
|
|
الوثائق والأدلة الرسمية لـ LangDB
|
|
</Card>
|
|
<Card title="أدلة LangDB" icon="graduation-cap" href="https://docs.langdb.ai/guides">
|
|
برامج تعليمية خطوة بخطوة لبناء وكلاء AI
|
|
</Card>
|
|
<Card title="أمثلة GitHub" icon="github" href="https://github.com/langdb/langdb-samples/tree/main/examples/crewai">
|
|
أمثلة تكامل CrewAI الكاملة
|
|
</Card>
|
|
<Card title="لوحة معلومات LangDB" icon="chart-line" href="https://app.langdb.ai">
|
|
الوصول إلى تتبعاتك وتحليلاتك
|
|
</Card>
|
|
<Card title="كتالوج النماذج" icon="list" href="https://app.langdb.ai/models">
|
|
تصفح أكثر من 350 نموذج لغة متاح
|
|
</Card>
|
|
<Card title="ميزات المؤسسات" icon="building" href="https://docs.langdb.ai/enterprise">
|
|
خيارات الاستضافة الذاتية وقدرات المؤسسات
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## الخطوات التالية
|
|
|
|
غطى هذا الدليل أساسيات دمج بوابة LangDB AI مع CrewAI. لتعزيز سير عمل الذكاء الاصطناعي بشكل أكبر، استكشف:
|
|
|
|
- **النماذج الافتراضية**: إنشاء إعدادات نماذج مخصصة مع استراتيجيات توجيه
|
|
- **حواجز الحماية والسلامة**: تنفيذ تصفية المحتوى وضوابط الامتثال
|
|
- **النشر في الإنتاج**: إعداد خطط احتياطية وإعادة المحاولة وتوازن الأحمال
|
|
|
|
لمزيد من الميزات المتقدمة وحالات الاستخدام، زُر [وثائق LangDB](https://docs.langdb.ai) أو استكشف [كتالوج النماذج](https://app.langdb.ai/models) لاكتشاف جميع النماذج المتاحة.
|