mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 13:18:10 +00:00
a237ebabba
* 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>
173 lines
4.7 KiB
Plaintext
173 lines
4.7 KiB
Plaintext
---
|
|
title: بث Webhook
|
|
description: "استخدام بث Webhook لإرسال الأحداث إلى webhook الخاص بك"
|
|
icon: "webhook"
|
|
mode: "wide"
|
|
---
|
|
|
|
## نظرة عامة
|
|
|
|
يتيح لك بث أحداث Enterprise تلقي تحديثات webhook في الوقت الفعلي حول طواقمك وتدفقاتك المنشورة على CrewAI AMP، مثل استدعاءات النماذج واستخدام الأدوات وخطوات التدفق.
|
|
|
|
## الاستخدام
|
|
|
|
عند استخدام Kickoff API، أضف كائن `webhooks` إلى طلبك، على سبيل المثال:
|
|
|
|
```json
|
|
{
|
|
"inputs": { "foo": "bar" },
|
|
"webhooks": {
|
|
"events": ["crew_kickoff_started", "llm_call_started"],
|
|
"url": "https://your.endpoint/webhook",
|
|
"realtime": false,
|
|
"authentication": {
|
|
"strategy": "bearer",
|
|
"token": "my-secret-token"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
إذا تم تعيين `realtime` إلى `true`، يتم تسليم كل حدث بشكل فردي وفوري، على حساب أداء الطاقم/التدفق.
|
|
|
|
## تنسيق Webhook
|
|
|
|
يرسل كل webhook قائمة بالأحداث:
|
|
|
|
```json
|
|
{
|
|
"events": [
|
|
{
|
|
"id": "event-id",
|
|
"execution_id": "crew-run-id",
|
|
"timestamp": "2025-02-16T10:58:44.965Z",
|
|
"type": "llm_call_started",
|
|
"data": {
|
|
"model": "gpt-4",
|
|
"messages": [
|
|
{ "role": "system", "content": "You are an assistant." },
|
|
{ "role": "user", "content": "Summarize this article." }
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
يختلف هيكل كائن `data` حسب نوع الحدث. راجع [قائمة الأحداث](https://github.com/crewAIInc/crewAI/tree/main/lib/crewai/src/crewai/events/types) على GitHub.
|
|
|
|
نظراً لأن الطلبات تُرسل عبر HTTP، لا يمكن ضمان ترتيب الأحداث. إذا كنت تحتاج الترتيب، استخدم حقل `timestamp`.
|
|
|
|
## الأحداث المدعومة
|
|
|
|
يدعم CrewAI كلاً من أحداث النظام والأحداث المخصصة في بث أحداث Enterprise. تُرسل هذه الأحداث إلى نقطة نهاية webhook المُهيأة أثناء تنفيذ الطاقم والتدفق.
|
|
|
|
### أحداث التدفق:
|
|
|
|
- `flow_created`
|
|
- `flow_started`
|
|
- `flow_finished`
|
|
- `flow_plot`
|
|
- `method_execution_started`
|
|
- `method_execution_finished`
|
|
- `method_execution_failed`
|
|
|
|
### أحداث الوكيل:
|
|
|
|
- `agent_execution_started`
|
|
- `agent_execution_completed`
|
|
- `agent_execution_error`
|
|
- `lite_agent_execution_started`
|
|
- `lite_agent_execution_completed`
|
|
- `lite_agent_execution_error`
|
|
- `agent_logs_started`
|
|
- `agent_logs_execution`
|
|
- `agent_evaluation_started`
|
|
- `agent_evaluation_completed`
|
|
- `agent_evaluation_failed`
|
|
|
|
### أحداث الطاقم:
|
|
|
|
- `crew_kickoff_started`
|
|
- `crew_kickoff_completed`
|
|
- `crew_kickoff_failed`
|
|
- `crew_train_started`
|
|
- `crew_train_completed`
|
|
- `crew_train_failed`
|
|
- `crew_test_started`
|
|
- `crew_test_completed`
|
|
- `crew_test_failed`
|
|
- `crew_test_result`
|
|
|
|
### أحداث المهام:
|
|
|
|
- `task_started`
|
|
- `task_completed`
|
|
- `task_failed`
|
|
- `task_evaluation`
|
|
|
|
### أحداث استخدام الأدوات:
|
|
|
|
- `tool_usage_started`
|
|
- `tool_usage_finished`
|
|
- `tool_usage_error`
|
|
- `tool_validate_input_error`
|
|
- `tool_selection_error`
|
|
- `tool_execution_error`
|
|
|
|
### أحداث LLM:
|
|
|
|
- `llm_call_started`
|
|
- `llm_call_completed`
|
|
- `llm_call_failed`
|
|
- `llm_stream_chunk`
|
|
|
|
### أحداث حواجز LLM:
|
|
|
|
- `llm_guardrail_started`
|
|
- `llm_guardrail_completed`
|
|
|
|
### أحداث الذاكرة:
|
|
|
|
- `memory_query_started`
|
|
- `memory_query_completed`
|
|
- `memory_query_failed`
|
|
- `memory_save_started`
|
|
- `memory_save_completed`
|
|
- `memory_save_failed`
|
|
- `memory_retrieval_started`
|
|
- `memory_retrieval_completed`
|
|
|
|
### أحداث المعرفة:
|
|
|
|
- `knowledge_search_query_started`
|
|
- `knowledge_search_query_completed`
|
|
- `knowledge_search_query_failed`
|
|
- `knowledge_query_started`
|
|
- `knowledge_query_completed`
|
|
- `knowledge_query_failed`
|
|
|
|
### أحداث الاستدلال:
|
|
|
|
- `agent_reasoning_started`
|
|
- `agent_reasoning_completed`
|
|
- `agent_reasoning_failed`
|
|
|
|
تتطابق أسماء الأحداث مع ناقل الأحداث الداخلي. راجع GitHub للقائمة الكاملة للأحداث.
|
|
|
|
يمكنك إصدار أحداثك المخصصة الخاصة، وسيتم تسليمها عبر تدفق webhook جنباً إلى جنب مع أحداث النظام.
|
|
|
|
<CardGroup>
|
|
<Card
|
|
title="GitHub"
|
|
icon="github"
|
|
href="https://github.com/crewAIInc/crewAI/tree/main/src/crewai/utilities/events"
|
|
>
|
|
القائمة الكاملة للأحداث
|
|
</Card>
|
|
<Card title="تحتاج مساعدة؟" icon="headset" href="mailto:support@crewai.com">
|
|
تواصل مع فريق الدعم للمساعدة في تكامل webhook أو
|
|
استكشاف الأخطاء.
|
|
</Card>
|
|
</CardGroup>
|