mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-04 22:49:23 +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>
252 lines
10 KiB
Plaintext
252 lines
10 KiB
Plaintext
---
|
|
title: حاجز الهلوسة
|
|
description: "منع واكتشاف هلوسات الذكاء الاصطناعي في مهام CrewAI"
|
|
icon: "shield-check"
|
|
mode: "wide"
|
|
---
|
|
|
|
## نظرة عامة
|
|
|
|
حاجز الهلوسة هو ميزة مؤسسية تتحقق من المحتوى المولّد بالذكاء الاصطناعي لضمان أنه مبني على الحقائق ولا يحتوي على هلوسات. يحلل مخرجات المهام مقابل سياق مرجعي ويوفر ملاحظات مفصلة عند اكتشاف محتوى محتمل الهلوسة.
|
|
|
|
## ما هي الهلوسات؟
|
|
|
|
تحدث هلوسات الذكاء الاصطناعي عندما تولّد نماذج اللغة محتوى يبدو معقولاً لكنه غير صحيح من الناحية الواقعية أو غير مدعوم بالسياق المقدم. يساعد حاجز الهلوسة في منع هذه المشكلات من خلال:
|
|
|
|
- مقارنة المخرجات مع السياق المرجعي
|
|
- تقييم الأمانة للمادة المصدرية
|
|
- توفير ملاحظات مفصلة حول المحتوى المشكل
|
|
- دعم عتبات مخصصة لصرامة التحقق
|
|
|
|
## الاستخدام الأساسي
|
|
|
|
### إعداد الحاجز
|
|
|
|
```python
|
|
from crewai.tasks.hallucination_guardrail import HallucinationGuardrail
|
|
from crewai import LLM
|
|
|
|
# الاستخدام الأساسي - سيستخدم expected_output للمهمة كسياق
|
|
guardrail = HallucinationGuardrail(
|
|
llm=LLM(model="gpt-4o-mini")
|
|
)
|
|
|
|
# مع سياق مرجعي صريح
|
|
context_guardrail = HallucinationGuardrail(
|
|
context="AI helps with various tasks including analysis and generation.",
|
|
llm=LLM(model="gpt-4o-mini")
|
|
)
|
|
```
|
|
|
|
### الإضافة إلى المهام
|
|
|
|
```python
|
|
from crewai import Task
|
|
|
|
# إنشاء مهمتك مع الحاجز
|
|
task = Task(
|
|
description="Write a summary about AI capabilities",
|
|
expected_output="A factual summary based on the provided context",
|
|
agent=my_agent,
|
|
guardrail=guardrail # إضافة الحاجز للتحقق من المخرجات
|
|
)
|
|
```
|
|
|
|
## التهيئة المتقدمة
|
|
|
|
### التحقق بعتبة مخصصة
|
|
|
|
للتحقق الأكثر صرامة، يمكنك تعيين عتبة أمانة مخصصة (مقياس 0-10):
|
|
|
|
```python
|
|
# حاجز صارم يتطلب درجة أمانة عالية
|
|
strict_guardrail = HallucinationGuardrail(
|
|
context="Quantum computing uses qubits that exist in superposition states.",
|
|
llm=LLM(model="gpt-4o-mini"),
|
|
threshold=8.0 # يتطلب درجة >= 8 لاجتياز التحقق
|
|
)
|
|
```
|
|
|
|
### تضمين سياق استجابة الأدوات
|
|
|
|
عندما تستخدم مهمتك أدوات، يمكنك تضمين استجابات الأدوات لتحقق أكثر دقة:
|
|
|
|
```python
|
|
# حاجز مع سياق استجابة الأدوات
|
|
weather_guardrail = HallucinationGuardrail(
|
|
context="Current weather information for the requested location",
|
|
llm=LLM(model="gpt-4o-mini"),
|
|
tool_response="Weather API returned: Temperature 22°C, Humidity 65%, Clear skies"
|
|
)
|
|
```
|
|
|
|
## كيف يعمل
|
|
|
|
### عملية التحقق
|
|
|
|
1. **تحليل السياق**: يقارن الحاجز مخرجات المهمة مع السياق المرجعي المقدم
|
|
2. **تسجيل الأمانة**: يستخدم مقيّمًا داخليًا لتعيين درجة أمانة (0-10)
|
|
3. **تحديد الحكم**: يحدد ما إذا كان المحتوى أمينًا أو يحتوي على هلوسات
|
|
4. **التحقق من العتبة**: إذا تم تعيين عتبة مخصصة، يتحقق مقابل تلك الدرجة
|
|
5. **توليد الملاحظات**: يوفر أسبابًا مفصلة عند فشل التحقق
|
|
|
|
### منطق التحقق
|
|
|
|
- **الوضع الافتراضي**: يستخدم التحقق المبني على الحكم (FAITHFUL مقابل HALLUCINATED)
|
|
- **وضع العتبة**: يتطلب أن تلبي درجة الأمانة العتبة المحددة أو تتجاوزها
|
|
- **معالجة الأخطاء**: يتعامل بسلاسة مع أخطاء التقييم ويوفر ملاحظات إعلامية
|
|
|
|
## نتائج الحاجز
|
|
|
|
يعيد الحاجز نتائج منظمة تشير إلى حالة التحقق:
|
|
|
|
```python
|
|
# مثال على هيكل نتيجة الحاجز
|
|
{
|
|
"valid": False,
|
|
"feedback": "Content appears to be hallucinated (score: 4.2/10, verdict: HALLUCINATED). The output contains information not supported by the provided context."
|
|
}
|
|
```
|
|
|
|
### خصائص النتيجة
|
|
|
|
- **valid**: قيمة منطقية تشير إلى ما إذا اجتازت المخرجات التحقق
|
|
- **feedback**: شرح مفصل عند فشل التحقق، يتضمن:
|
|
- درجة الأمانة
|
|
- تصنيف الحكم
|
|
- أسباب محددة للفشل
|
|
|
|
## التكامل مع نظام المهام
|
|
|
|
### التحقق التلقائي
|
|
|
|
عند إضافة حاجز إلى مهمة، يتحقق تلقائيًا من المخرجات قبل اعتبار المهمة مكتملة:
|
|
|
|
```python
|
|
# تدفق التحقق من مخرجات المهمة
|
|
task_output = agent.execute_task(task)
|
|
validation_result = guardrail(task_output)
|
|
|
|
if validation_result.valid:
|
|
# المهمة تكتمل بنجاح
|
|
return task_output
|
|
else:
|
|
# المهمة تفشل مع ملاحظات التحقق
|
|
raise ValidationError(validation_result.feedback)
|
|
```
|
|
|
|
### تتبع الأحداث
|
|
|
|
يتكامل الحاجز مع نظام أحداث CrewAI لتوفير المراقبة:
|
|
|
|
- **بدء التحقق**: عند بدء تقييم الحاجز
|
|
- **اكتمال التحقق**: عند انتهاء التقييم بالنتائج
|
|
- **فشل التحقق**: عند حدوث أخطاء تقنية أثناء التقييم
|
|
|
|
## أفضل الممارسات
|
|
|
|
### إرشادات السياق
|
|
|
|
<Steps>
|
|
<Step title="توفير سياق شامل">
|
|
أدرج جميع المعلومات الواقعية ذات الصلة التي يجب أن يبني عليها الذكاء الاصطناعي مخرجاته:
|
|
|
|
```python
|
|
context = """
|
|
Company XYZ was founded in 2020 and specializes in renewable energy solutions.
|
|
They have 150 employees and generated $50M revenue in 2023.
|
|
Their main products include solar panels and wind turbines.
|
|
"""
|
|
```
|
|
</Step>
|
|
|
|
<Step title="الحفاظ على صلة السياق">
|
|
أدرج فقط المعلومات المرتبطة مباشرة بالمهمة لتجنب الارتباك:
|
|
|
|
```python
|
|
# جيد: سياق مركّز
|
|
context = "The current weather in New York is 18°C with light rain."
|
|
|
|
# تجنب: معلومات غير ذات صلة
|
|
context = "The weather is 18°C. The city has 8 million people. Traffic is heavy."
|
|
```
|
|
</Step>
|
|
|
|
<Step title="تحديث السياق بانتظام">
|
|
تأكد من أن السياق المرجعي يعكس معلومات حالية ودقيقة.
|
|
</Step>
|
|
</Steps>
|
|
|
|
### اختيار العتبة
|
|
|
|
<Steps>
|
|
<Step title="البدء بالتحقق الافتراضي">
|
|
ابدأ بدون عتبات مخصصة لفهم الأداء الأساسي.
|
|
</Step>
|
|
|
|
<Step title="الضبط بناءً على المتطلبات">
|
|
- **محتوى عالي الأهمية**: استخدم عتبة 8-10 للدقة القصوى
|
|
- **محتوى عام**: استخدم عتبة 6-7 للتحقق المتوازن
|
|
- **محتوى إبداعي**: استخدم عتبة 4-5 أو التحقق الافتراضي المبني على الحكم
|
|
</Step>
|
|
|
|
<Step title="المراقبة والتكرار">
|
|
تتبع نتائج التحقق واضبط العتبات بناءً على الإيجابيات/السلبيات الكاذبة.
|
|
</Step>
|
|
</Steps>
|
|
|
|
## اعتبارات الأداء
|
|
|
|
### التأثير على زمن التنفيذ
|
|
|
|
- **عبء التحقق**: يضيف كل حاجز حوالي 1-3 ثوانٍ لكل مهمة
|
|
- **كفاءة LLM**: اختر نماذج فعالة للتقييم (مثل gpt-4o-mini)
|
|
|
|
### تحسين التكلفة
|
|
|
|
- **اختيار النموذج**: استخدم نماذج أصغر وفعالة لتقييم الحاجز
|
|
- **حجم السياق**: اجعل السياق المرجعي موجزًا لكن شاملًا
|
|
- **التخزين المؤقت**: فكّر في تخزين نتائج التحقق مؤقتًا للمحتوى المتكرر
|
|
|
|
## استكشاف الأخطاء وإصلاحها
|
|
|
|
<Accordion title="فشل التحقق دائمًا">
|
|
**الأسباب المحتملة:**
|
|
- السياق مقيّد جدًا أو غير مرتبط بمخرجات المهمة
|
|
- العتبة معينة عالية جدًا لنوع المحتوى
|
|
- السياق المرجعي يحتوي على معلومات قديمة
|
|
|
|
**الحلول:**
|
|
- مراجعة وتحديث السياق ليتطابق مع متطلبات المهمة
|
|
- خفض العتبة أو استخدام التحقق الافتراضي المبني على الحكم
|
|
- التأكد من أن السياق حالي ودقيق
|
|
</Accordion>
|
|
|
|
<Accordion title="إيجابيات كاذبة (محتوى صالح يُعلّم كغير صالح)">
|
|
**الأسباب المحتملة:**
|
|
- العتبة عالية جدًا للمهام الإبداعية أو التفسيرية
|
|
- السياق لا يغطي جميع الجوانب الصالحة للمخرجات
|
|
- نموذج التقييم محافظ بشكل مفرط
|
|
|
|
**الحلول:**
|
|
- خفض العتبة أو استخدام التحقق الافتراضي
|
|
- توسيع السياق ليشمل محتوى مقبول أوسع
|
|
- الاختبار مع نماذج تقييم مختلفة
|
|
</Accordion>
|
|
|
|
<Accordion title="أخطاء التقييم">
|
|
**الأسباب المحتملة:**
|
|
- مشكلات في الاتصال بالشبكة
|
|
- نموذج LLM غير متاح أو محدود المعدل
|
|
- مخرجات مهمة أو سياق غير صالح
|
|
|
|
**الحلول:**
|
|
- التحقق من الاتصال بالشبكة وحالة خدمة LLM
|
|
- تنفيذ منطق إعادة المحاولة للأعطال المؤقتة
|
|
- التحقق من تنسيق مخرجات المهمة قبل تقييم الحاجز
|
|
</Accordion>
|
|
|
|
<Card title="هل تحتاج مساعدة؟" icon="headset" href="mailto:support@crewai.com">
|
|
تواصل مع فريق الدعم للمساعدة في تهيئة حاجز الهلوسة أو استكشاف الأخطاء وإصلاحها.
|
|
</Card>
|