mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-05 06:59:23 +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>
135 lines
4.5 KiB
Plaintext
135 lines
4.5 KiB
Plaintext
---
|
|
title: البصمات الرقمية
|
|
description: تعلم كيفية استخدام نظام البصمات الرقمية في CrewAI لتحديد وتتبع المكونات بشكل فريد طوال دورة حياتها.
|
|
icon: fingerprint
|
|
mode: "wide"
|
|
---
|
|
|
|
## نظرة عامة
|
|
|
|
توفر البصمات الرقمية في CrewAI طريقة لتحديد وتتبع المكونات بشكل فريد طوال دورة حياتها. يتلقى كل `Agent` و`Crew` و`Task` بصمة رقمية فريدة تلقائيًا عند الإنشاء، ولا يمكن تجاوزها يدويًا.
|
|
|
|
يمكن استخدام هذه البصمات لـ:
|
|
- تدقيق وتتبع استخدام المكونات
|
|
- ضمان سلامة هوية المكونات
|
|
- إرفاق بيانات وصفية بالمكونات
|
|
- إنشاء سلسلة عمليات قابلة للتتبع
|
|
|
|
## كيف تعمل البصمات الرقمية
|
|
|
|
البصمة الرقمية هي نسخة من فئة `Fingerprint` من وحدة `crewai.security`. تحتوي كل بصمة على:
|
|
|
|
- سلسلة UUID: معرّف فريد للمكون يتم إنشاؤه تلقائيًا ولا يمكن تعيينه يدويًا
|
|
- طابع زمني للإنشاء: متى تم إنشاء البصمة، يُعيَّن تلقائيًا ولا يمكن تعديله يدويًا
|
|
- بيانات وصفية: قاموس معلومات إضافية يمكن تخصيصه
|
|
|
|
تُنشأ البصمات الرقمية وتُعيَّن تلقائيًا عند إنشاء المكون. يكشف كل مكون بصمته من خلال خاصية للقراءة فقط.
|
|
|
|
## الاستخدام الأساسي
|
|
|
|
### الوصول إلى البصمات الرقمية
|
|
|
|
```python
|
|
from crewai import Agent, Crew, Task
|
|
|
|
# Create components - fingerprints are automatically generated
|
|
agent = Agent(
|
|
role="Data Scientist",
|
|
goal="Analyze data",
|
|
backstory="Expert in data analysis"
|
|
)
|
|
|
|
crew = Crew(
|
|
agents=[agent],
|
|
tasks=[]
|
|
)
|
|
|
|
task = Task(
|
|
description="Analyze customer data",
|
|
expected_output="Insights from data analysis",
|
|
agent=agent
|
|
)
|
|
|
|
# Access the fingerprints
|
|
agent_fingerprint = agent.fingerprint
|
|
crew_fingerprint = crew.fingerprint
|
|
task_fingerprint = task.fingerprint
|
|
|
|
# Print the UUID strings
|
|
print(f"Agent fingerprint: {agent_fingerprint.uuid_str}")
|
|
print(f"Crew fingerprint: {crew_fingerprint.uuid_str}")
|
|
print(f"Task fingerprint: {task_fingerprint.uuid_str}")
|
|
```
|
|
|
|
### العمل مع البيانات الوصفية للبصمة
|
|
|
|
يمكنك إضافة بيانات وصفية إلى البصمات لسياق إضافي:
|
|
|
|
```python
|
|
# Add metadata to the agent's fingerprint
|
|
agent.security_config.fingerprint.metadata = {
|
|
"version": "1.0",
|
|
"department": "Data Science",
|
|
"project": "Customer Analysis"
|
|
}
|
|
|
|
# Access the metadata
|
|
print(f"Agent metadata: {agent.fingerprint.metadata}")
|
|
```
|
|
|
|
## استمرارية البصمة
|
|
|
|
صُممت البصمات لتبقى ثابتة دون تغيير طوال دورة حياة المكون. إذا عدّلت مكونًا، تظل البصمة كما هي:
|
|
|
|
```python
|
|
original_fingerprint = agent.fingerprint.uuid_str
|
|
|
|
# Modify the agent
|
|
agent.goal = "New goal for analysis"
|
|
|
|
# The fingerprint remains unchanged
|
|
assert agent.fingerprint.uuid_str == original_fingerprint
|
|
```
|
|
|
|
## البصمات الحتمية
|
|
|
|
بينما لا يمكنك تعيين UUID والطابع الزمني مباشرة، يمكنك إنشاء بصمات حتمية باستخدام طريقة `generate` مع بذرة:
|
|
|
|
```python
|
|
from crewai.security import Fingerprint
|
|
|
|
# Create a deterministic fingerprint using a seed string
|
|
deterministic_fingerprint = Fingerprint.generate(seed="my-agent-id")
|
|
|
|
# The same seed always produces the same fingerprint
|
|
same_fingerprint = Fingerprint.generate(seed="my-agent-id")
|
|
assert deterministic_fingerprint.uuid_str == same_fingerprint.uuid_str
|
|
|
|
# You can also set metadata
|
|
custom_fingerprint = Fingerprint.generate(
|
|
seed="my-agent-id",
|
|
metadata={"version": "1.0"}
|
|
)
|
|
```
|
|
|
|
## الاستخدام المتقدم
|
|
|
|
### هيكل البصمة
|
|
|
|
لكل بصمة الهيكل التالي:
|
|
|
|
```python
|
|
from crewai.security import Fingerprint
|
|
|
|
fingerprint = agent.fingerprint
|
|
|
|
# UUID string - the unique identifier (auto-generated)
|
|
uuid_str = fingerprint.uuid_str # e.g., "123e4567-e89b-12d3-a456-426614174000"
|
|
|
|
# Creation timestamp (auto-generated)
|
|
created_at = fingerprint.created_at # A datetime object
|
|
|
|
# Metadata - for additional information (can be customized)
|
|
metadata = fingerprint.metadata # A dictionary, defaults to {}
|
|
```
|