mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 13:48:09 +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>
207 lines
8.9 KiB
Plaintext
207 lines
8.9 KiB
Plaintext
---
|
|
title: تقييم Patronus AI
|
|
description: راقب وقيّم أداء وكلاء CrewAI باستخدام منصة التقييم الشاملة من Patronus AI لمخرجات LLM وسلوكيات الوكلاء.
|
|
icon: shield-check
|
|
mode: "wide"
|
|
---
|
|
|
|
# تقييم Patronus AI
|
|
|
|
## نظرة عامة
|
|
|
|
يوفر [Patronus AI](https://patronus.ai) إمكانيات تقييم ومراقبة شاملة لوكلاء CrewAI، مما يمكّنك من تقييم مخرجات النماذج وسلوكيات الوكلاء والأداء العام للنظام. يتيح لك هذا التكامل تنفيذ سير عمل تقييم مستمر يساعد في الحفاظ على الجودة والموثوقية في بيئات الإنتاج.
|
|
|
|
## الميزات الرئيسية
|
|
|
|
- **التقييم الآلي**: تقييم فوري لمخرجات وسلوكيات الوكلاء
|
|
- **معايير مخصصة**: حدد معايير تقييم محددة مصممة لحالات الاستخدام الخاصة بك
|
|
- **مراقبة الأداء**: تتبع مقاييس أداء الوكلاء بمرور الوقت
|
|
- **ضمان الجودة**: ضمان جودة مخرجات متسقة عبر سيناريوهات مختلفة
|
|
- **السلامة والامتثال**: مراقبة المشكلات المحتملة وانتهاكات السياسات
|
|
|
|
## أدوات التقييم
|
|
|
|
يوفر Patronus ثلاث أدوات تقييم رئيسية لحالات استخدام مختلفة:
|
|
|
|
1. **PatronusEvalTool**: يسمح للوكلاء باختيار المقيّم والمعايير الأنسب لمهمة التقييم.
|
|
2. **PatronusPredefinedCriteriaEvalTool**: يستخدم مقيّماً ومعايير محددة مسبقاً من قبل المستخدم.
|
|
3. **PatronusLocalEvaluatorTool**: يستخدم دوال تقييم مخصصة محددة من قبل المستخدم.
|
|
|
|
## التثبيت
|
|
|
|
لاستخدام هذه الأدوات، تحتاج إلى تثبيت حزمة Patronus:
|
|
|
|
```shell
|
|
uv add patronus
|
|
```
|
|
|
|
ستحتاج أيضاً إلى إعداد مفتاح API الخاص بـ Patronus كمتغير بيئة:
|
|
|
|
```shell
|
|
export PATRONUS_API_KEY="your_patronus_api_key"
|
|
```
|
|
|
|
## خطوات البدء
|
|
|
|
لاستخدام أدوات تقييم Patronus بفعالية، اتبع الخطوات التالية:
|
|
|
|
1. **تثبيت Patronus**: ثبّت حزمة Patronus باستخدام الأمر أعلاه.
|
|
2. **إعداد مفتاح API**: عيّن مفتاح API الخاص بـ Patronus كمتغير بيئة.
|
|
3. **اختيار الأداة المناسبة**: حدد أداة تقييم Patronus المناسبة بناءً على احتياجاتك.
|
|
4. **إعداد الأداة**: هيئ الأداة بالمعاملات اللازمة.
|
|
|
|
## أمثلة
|
|
|
|
### استخدام PatronusEvalTool
|
|
|
|
يوضح المثال التالي كيفية استخدام `PatronusEvalTool`، التي تسمح للوكلاء باختيار المقيّم والمعايير الأنسب:
|
|
|
|
```python Code
|
|
from crewai import Agent, Task, Crew
|
|
from crewai_tools import PatronusEvalTool
|
|
|
|
# Initialize the tool
|
|
patronus_eval_tool = PatronusEvalTool()
|
|
|
|
# Define an agent that uses the tool
|
|
coding_agent = Agent(
|
|
role="Coding Agent",
|
|
goal="Generate high quality code and verify that the output is code",
|
|
backstory="An experienced coder who can generate high quality python code.",
|
|
tools=[patronus_eval_tool],
|
|
verbose=True,
|
|
)
|
|
|
|
# Example task to generate and evaluate code
|
|
generate_code_task = Task(
|
|
description="Create a simple program to generate the first N numbers in the Fibonacci sequence. Select the most appropriate evaluator and criteria for evaluating your output.",
|
|
expected_output="Program that generates the first N numbers in the Fibonacci sequence.",
|
|
agent=coding_agent,
|
|
)
|
|
|
|
# Create and run the crew
|
|
crew = Crew(agents=[coding_agent], tasks=[generate_code_task])
|
|
result = crew.kickoff()
|
|
```
|
|
|
|
### استخدام PatronusPredefinedCriteriaEvalTool
|
|
|
|
يوضح المثال التالي كيفية استخدام `PatronusPredefinedCriteriaEvalTool`، التي تستخدم مقيّماً ومعايير محددة مسبقاً:
|
|
|
|
```python Code
|
|
from crewai import Agent, Task, Crew
|
|
from crewai_tools import PatronusPredefinedCriteriaEvalTool
|
|
|
|
# Initialize the tool with predefined criteria
|
|
patronus_eval_tool = PatronusPredefinedCriteriaEvalTool(
|
|
evaluators=[{"evaluator": "judge", "criteria": "contains-code"}]
|
|
)
|
|
|
|
# Define an agent that uses the tool
|
|
coding_agent = Agent(
|
|
role="Coding Agent",
|
|
goal="Generate high quality code",
|
|
backstory="An experienced coder who can generate high quality python code.",
|
|
tools=[patronus_eval_tool],
|
|
verbose=True,
|
|
)
|
|
|
|
# Example task to generate code
|
|
generate_code_task = Task(
|
|
description="Create a simple program to generate the first N numbers in the Fibonacci sequence.",
|
|
expected_output="Program that generates the first N numbers in the Fibonacci sequence.",
|
|
agent=coding_agent,
|
|
)
|
|
|
|
# Create and run the crew
|
|
crew = Crew(agents=[coding_agent], tasks=[generate_code_task])
|
|
result = crew.kickoff()
|
|
```
|
|
|
|
### استخدام PatronusLocalEvaluatorTool
|
|
|
|
يوضح المثال التالي كيفية استخدام `PatronusLocalEvaluatorTool`، التي تستخدم دوال تقييم مخصصة:
|
|
|
|
```python Code
|
|
from crewai import Agent, Task, Crew
|
|
from crewai_tools import PatronusLocalEvaluatorTool
|
|
from patronus import Client, EvaluationResult
|
|
import random
|
|
|
|
# Initialize the Patronus client
|
|
client = Client()
|
|
|
|
# Register a custom evaluator
|
|
@client.register_local_evaluator("random_evaluator")
|
|
def random_evaluator(**kwargs):
|
|
score = random.random()
|
|
return EvaluationResult(
|
|
score_raw=score,
|
|
pass_=score >= 0.5,
|
|
explanation="example explanation",
|
|
)
|
|
|
|
# Initialize the tool with the custom evaluator
|
|
patronus_eval_tool = PatronusLocalEvaluatorTool(
|
|
patronus_client=client,
|
|
evaluator="random_evaluator",
|
|
evaluated_model_gold_answer="example label",
|
|
)
|
|
|
|
# Define an agent that uses the tool
|
|
coding_agent = Agent(
|
|
role="Coding Agent",
|
|
goal="Generate high quality code",
|
|
backstory="An experienced coder who can generate high quality python code.",
|
|
tools=[patronus_eval_tool],
|
|
verbose=True,
|
|
)
|
|
|
|
# Example task to generate code
|
|
generate_code_task = Task(
|
|
description="Create a simple program to generate the first N numbers in the Fibonacci sequence.",
|
|
expected_output="Program that generates the first N numbers in the Fibonacci sequence.",
|
|
agent=coding_agent,
|
|
)
|
|
|
|
# Create and run the crew
|
|
crew = Crew(agents=[coding_agent], tasks=[generate_code_task])
|
|
result = crew.kickoff()
|
|
```
|
|
|
|
## المعاملات
|
|
|
|
### PatronusEvalTool
|
|
|
|
لا تتطلب `PatronusEvalTool` أي معاملات أثناء التهيئة. تقوم تلقائياً بجلب المقيّمين والمعايير المتاحة من API الخاص بـ Patronus.
|
|
|
|
### PatronusPredefinedCriteriaEvalTool
|
|
|
|
تقبل `PatronusPredefinedCriteriaEvalTool` المعاملات التالية أثناء التهيئة:
|
|
|
|
- **evaluators**: مطلوب. قائمة من القواميس تحتوي على المقيّم والمعايير المراد استخدامها. مثال: `[{"evaluator": "judge", "criteria": "contains-code"}]`.
|
|
|
|
### PatronusLocalEvaluatorTool
|
|
|
|
تقبل `PatronusLocalEvaluatorTool` المعاملات التالية أثناء التهيئة:
|
|
|
|
- **patronus_client**: مطلوب. مثيل عميل Patronus.
|
|
- **evaluator**: اختياري. اسم المقيّم المحلي المسجل للاستخدام. القيمة الافتراضية هي سلسلة نصية فارغة.
|
|
- **evaluated_model_gold_answer**: اختياري. الإجابة المرجعية للاستخدام في التقييم. القيمة الافتراضية هي سلسلة نصية فارغة.
|
|
|
|
## الاستخدام
|
|
|
|
عند استخدام أدوات تقييم Patronus، تقدم مدخلات النموذج ومخرجاته وسياقه، وتعيد الأداة نتائج التقييم من API الخاص بـ Patronus.
|
|
|
|
بالنسبة لـ `PatronusEvalTool` و`PatronusPredefinedCriteriaEvalTool`، المعاملات التالية مطلوبة عند استدعاء الأداة:
|
|
|
|
- **evaluated_model_input**: وصف مهمة الوكيل بنص بسيط.
|
|
- **evaluated_model_output**: مخرجات الوكيل للمهمة.
|
|
- **evaluated_model_retrieved_context**: سياق الوكيل.
|
|
|
|
بالنسبة لـ `PatronusLocalEvaluatorTool`، نفس المعاملات مطلوبة، لكن المقيّم والإجابة المرجعية يتم تحديدهما أثناء التهيئة.
|
|
|
|
## الخلاصة
|
|
|
|
توفر أدوات تقييم Patronus طريقة قوية لتقييم وتسجيل درجات مدخلات ومخرجات النماذج باستخدام منصة Patronus AI. من خلال تمكين الوكلاء من تقييم مخرجاتهم أو مخرجات وكلاء آخرين، يمكن لهذه الأدوات المساعدة في تحسين جودة وموثوقية سير عمل CrewAI.
|