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>
233 lines
8.9 KiB
Plaintext
233 lines
8.9 KiB
Plaintext
---
|
|
title: Braintrust
|
|
description: تكامل Braintrust مع CrewAI باستخدام تتبع وتقييم OpenTelemetry
|
|
icon: magnifying-glass-chart
|
|
mode: "wide"
|
|
---
|
|
|
|
# تكامل Braintrust
|
|
|
|
يوضح هذا الدليل كيفية دمج **Braintrust** مع **CrewAI** باستخدام OpenTelemetry للتتبع والتقييم الشامل. بنهاية هذا الدليل، ستتمكن من تتبع وكلاء CrewAI ومراقبة أدائهم وتقييم مخرجاتهم باستخدام منصة المراقبة القوية من Braintrust.
|
|
|
|
> **ما هو Braintrust؟** [Braintrust](https://www.braintrust.dev) هو منصة تقييم ومراقبة للذكاء الاصطناعي توفر تتبعاً شاملاً وتقييماً ومراقبة لتطبيقات الذكاء الاصطناعي مع تتبع تجارب مدمج وتحليلات أداء.
|
|
|
|
## البدء
|
|
|
|
سنمر عبر مثال بسيط لاستخدام CrewAI ودمجه مع Braintrust عبر OpenTelemetry للمراقبة والتقييم الشامل.
|
|
|
|
### الخطوة 1: تثبيت الاعتماديات
|
|
|
|
```bash
|
|
uv add braintrust[otel] crewai crewai-tools opentelemetry-instrumentation-openai opentelemetry-instrumentation-crewai python-dotenv
|
|
```
|
|
|
|
### الخطوة 2: إعداد متغيرات البيئة
|
|
|
|
قم بإعداد مفاتيح API لـ Braintrust وإعداد OpenTelemetry لإرسال التتبعات إلى Braintrust. ستحتاج إلى مفتاح API من Braintrust ومفتاح API من OpenAI.
|
|
|
|
```python
|
|
import os
|
|
from getpass import getpass
|
|
|
|
# Get your Braintrust credentials
|
|
BRAINTRUST_API_KEY = getpass("🔑 Enter your Braintrust API Key: ")
|
|
|
|
# Get API keys for services
|
|
OPENAI_API_KEY = getpass("🔑 Enter your OpenAI API key: ")
|
|
|
|
# Set environment variables
|
|
os.environ["BRAINTRUST_API_KEY"] = BRAINTRUST_API_KEY
|
|
os.environ["BRAINTRUST_PARENT"] = "project_name:crewai-demo"
|
|
os.environ["OPENAI_API_KEY"] = OPENAI_API_KEY
|
|
```
|
|
|
|
### الخطوة 3: تهيئة OpenTelemetry مع Braintrust
|
|
|
|
قم بتهيئة أداة Braintrust OpenTelemetry لبدء التقاط التتبعات وإرسالها إلى Braintrust.
|
|
|
|
```python
|
|
import os
|
|
from typing import Any, Dict
|
|
|
|
from braintrust.otel import BraintrustSpanProcessor
|
|
from crewai import Agent, Crew, Task
|
|
from crewai.llm import LLM
|
|
from opentelemetry import trace
|
|
from opentelemetry.instrumentation.crewai import CrewAIInstrumentor
|
|
from opentelemetry.instrumentation.openai import OpenAIInstrumentor
|
|
from opentelemetry.sdk.trace import TracerProvider
|
|
|
|
def setup_tracing() -> None:
|
|
"""Setup OpenTelemetry tracing with Braintrust."""
|
|
current_provider = trace.get_tracer_provider()
|
|
if isinstance(current_provider, TracerProvider):
|
|
provider = current_provider
|
|
else:
|
|
provider = TracerProvider()
|
|
trace.set_tracer_provider(provider)
|
|
|
|
provider.add_span_processor(BraintrustSpanProcessor())
|
|
CrewAIInstrumentor().instrument(tracer_provider=provider)
|
|
OpenAIInstrumentor().instrument(tracer_provider=provider)
|
|
|
|
|
|
setup_tracing()
|
|
```
|
|
|
|
### الخطوة 4: إنشاء تطبيق CrewAI
|
|
|
|
سننشئ تطبيق CrewAI حيث يتعاون وكيلان للبحث وكتابة مقال مدونة حول تطورات الذكاء الاصطناعي، مع تفعيل التتبع الشامل.
|
|
|
|
```python
|
|
from crewai import Agent, Crew, Process, Task
|
|
from crewai_tools import SerperDevTool
|
|
|
|
def create_crew() -> Crew:
|
|
"""Create a crew with multiple agents for comprehensive tracing."""
|
|
llm = LLM(model="gpt-4o-mini")
|
|
search_tool = SerperDevTool()
|
|
|
|
researcher = Agent(
|
|
role="Senior Research Analyst",
|
|
goal="Uncover cutting-edge developments in AI and data science",
|
|
backstory="""You work at a leading tech think tank.
|
|
Your expertise lies in identifying emerging trends.
|
|
You have a knack for dissecting complex data and presenting actionable insights.""",
|
|
verbose=True,
|
|
allow_delegation=False,
|
|
llm=llm,
|
|
tools=[search_tool],
|
|
)
|
|
|
|
writer = Agent(
|
|
role="Tech Content Strategist",
|
|
goal="Craft compelling content on tech advancements",
|
|
backstory="""You are a renowned Content Strategist, known for your insightful and engaging articles.
|
|
You transform complex concepts into compelling narratives.""",
|
|
verbose=True,
|
|
allow_delegation=True,
|
|
llm=llm,
|
|
)
|
|
|
|
research_task = Task(
|
|
description="""Conduct a comprehensive analysis of the latest advancements in {topic}.
|
|
Identify key trends, breakthrough technologies, and potential industry impacts.""",
|
|
expected_output="Full analysis report in bullet points",
|
|
agent=researcher,
|
|
)
|
|
|
|
writing_task = Task(
|
|
description="""Using the insights provided, develop an engaging blog
|
|
post that highlights the most significant {topic} advancements.
|
|
Your post should be informative yet accessible, catering to a tech-savvy audience.
|
|
Make it sound cool, avoid complex words so it doesn't sound like AI.""",
|
|
expected_output="Full blog post of at least 4 paragraphs",
|
|
agent=writer,
|
|
context=[research_task],
|
|
)
|
|
|
|
crew = Crew(
|
|
agents=[researcher, writer],
|
|
tasks=[research_task, writing_task],
|
|
verbose=True,
|
|
process=Process.sequential
|
|
)
|
|
|
|
return crew
|
|
|
|
def run_crew():
|
|
"""Run the crew and return results."""
|
|
crew = create_crew()
|
|
result = crew.kickoff(inputs={"topic": "AI developments"})
|
|
return result
|
|
|
|
if __name__ == "__main__":
|
|
result = run_crew()
|
|
print(result)
|
|
```
|
|
|
|
### الخطوة 5: عرض التتبعات في Braintrust
|
|
|
|
بعد تشغيل طاقمك، يمكنك عرض تتبعات شاملة في Braintrust من خلال وجهات نظر مختلفة:
|
|
|
|
<Tabs>
|
|
<Tab title="التتبع">
|
|
<Frame>
|
|
<img src="/images/braintrust-trace-view.png" alt="عرض تتبع Braintrust"/>
|
|
</Frame>
|
|
</Tab>
|
|
|
|
<Tab title="الجدول الزمني">
|
|
<Frame>
|
|
<img src="/images/braintrust-timeline-view.png" alt="عرض الجدول الزمني Braintrust"/>
|
|
</Frame>
|
|
</Tab>
|
|
|
|
<Tab title="المحادثة">
|
|
<Frame>
|
|
<img src="/images/braintrust-thread-view.png" alt="عرض المحادثة Braintrust"/>
|
|
</Frame>
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
### الخطوة 6: التقييم عبر SDK (التجارب)
|
|
|
|
يمكنك أيضاً تشغيل التقييمات باستخدام Braintrust Eval SDK. هذا مفيد لمقارنة الإصدارات أو تسجيل المخرجات. فيما يلي مثال Python باستخدام فئة `Eval`:
|
|
|
|
```python
|
|
# eval_crew.py
|
|
from braintrust import Eval
|
|
from autoevals import Levenshtein
|
|
|
|
def evaluate_crew_task(input_data):
|
|
"""Task function that wraps our crew for evaluation."""
|
|
crew = create_crew()
|
|
result = crew.kickoff(inputs={"topic": input_data["topic"]})
|
|
return str(result)
|
|
|
|
Eval(
|
|
"AI Research Crew",
|
|
{
|
|
"data": lambda: [
|
|
{"topic": "artificial intelligence trends 2024"},
|
|
{"topic": "machine learning breakthroughs"},
|
|
{"topic": "AI ethics and governance"},
|
|
],
|
|
"task": evaluate_crew_task,
|
|
"scores": [Levenshtein],
|
|
},
|
|
)
|
|
```
|
|
|
|
قم بإعداد مفتاح API الخاص بك وشغّل:
|
|
|
|
```bash
|
|
export BRAINTRUST_API_KEY="YOUR_API_KEY"
|
|
braintrust eval eval_crew.py
|
|
```
|
|
|
|
راجع [دليل Braintrust Eval SDK](https://www.braintrust.dev/docs/start/eval-sdk) لمزيد من التفاصيل.
|
|
|
|
### الميزات الرئيسية لتكامل Braintrust
|
|
|
|
- **تتبع شامل**: تتبع جميع تفاعلات الوكلاء واستخدام الأدوات واستدعاءات LLM
|
|
- **مراقبة الأداء**: مراقبة أوقات التنفيذ واستخدام الرموز ومعدلات النجاح
|
|
- **تتبع التجارب**: مقارنة إعدادات الطاقم والنماذج المختلفة
|
|
- **التقييم الآلي**: إعداد مقاييس تقييم مخصصة لمخرجات الطاقم
|
|
- **تتبع الأخطاء**: مراقبة وتصحيح حالات الفشل عبر عمليات تنفيذ الطاقم
|
|
- **تحليل التكاليف**: تتبع استخدام الرموز والتكاليف المرتبطة
|
|
|
|
### معلومات التوافق
|
|
- Python 3.8+
|
|
- CrewAI >= 0.86.0
|
|
- Braintrust >= 0.1.0
|
|
- OpenTelemetry SDK >= 1.31.0
|
|
|
|
### المراجع
|
|
- [وثائق Braintrust](https://www.braintrust.dev/docs) - نظرة عامة على منصة Braintrust
|
|
- [تكامل Braintrust CrewAI](https://www.braintrust.dev/docs/integrations/crew-ai) - دليل التكامل الرسمي مع CrewAI
|
|
- [Braintrust Eval SDK](https://www.braintrust.dev/docs/start/eval-sdk) - تشغيل التجارب عبر SDK
|
|
- [وثائق CrewAI](https://docs.crewai.com/) - نظرة عامة على إطار عمل CrewAI
|
|
- [وثائق OpenTelemetry](https://opentelemetry.io/docs/) - دليل OpenTelemetry
|
|
- [Braintrust GitHub](https://github.com/braintrustdata/braintrust) - الكود المصدري لـ Braintrust SDK
|