mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 21:28:10 +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>
281 lines
9.3 KiB
Plaintext
281 lines
9.3 KiB
Plaintext
---
|
|
title: تكامل Box
|
|
description: "تخزين الملفات وإدارة المستندات مع تكامل Box لـ CrewAI."
|
|
icon: "box"
|
|
mode: "wide"
|
|
---
|
|
|
|
## نظرة عامة
|
|
|
|
مكّن وكلاءك من إدارة الملفات والمجلدات والمستندات عبر Box. ارفع الملفات، ونظّم هياكل المجلدات، وابحث في المحتوى، وبسّط إدارة مستندات فريقك باستخدام الأتمتة المدعومة بالذكاء الاصطناعي.
|
|
|
|
## المتطلبات الأساسية
|
|
|
|
قبل استخدام تكامل Box، تأكد من توفر ما يلي:
|
|
|
|
- حساب [CrewAI AMP](https://app.crewai.com) مع اشتراك فعّال
|
|
- حساب Box بالصلاحيات المناسبة
|
|
- ربط حساب Box الخاص بك عبر [صفحة التكاملات](https://app.crewai.com/crewai_plus/connectors)
|
|
|
|
## إعداد تكامل Box
|
|
|
|
### 1. ربط حساب Box الخاص بك
|
|
|
|
1. انتقل إلى [تكاملات CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
|
|
2. ابحث عن **Box** في قسم تكاملات المصادقة
|
|
3. انقر على **Connect** وأكمل عملية OAuth
|
|
4. امنح الصلاحيات اللازمة لإدارة الملفات والمجلدات
|
|
5. انسخ رمز المؤسسة من [إعدادات التكامل](https://app.crewai.com/crewai_plus/settings/integrations)
|
|
|
|
### 2. تثبيت الحزمة المطلوبة
|
|
|
|
```bash
|
|
uv add crewai-tools
|
|
```
|
|
|
|
### 3. إعداد متغير البيئة
|
|
|
|
<Note>
|
|
لاستخدام التكاملات مع `Agent(apps=[])`, يجب تعيين متغير البيئة
|
|
`CREWAI_PLATFORM_INTEGRATION_TOKEN` برمز المؤسسة الخاص بك.
|
|
</Note>
|
|
|
|
```bash
|
|
export CREWAI_PLATFORM_INTEGRATION_TOKEN="your_enterprise_token"
|
|
```
|
|
|
|
أو أضفه إلى ملف `.env`:
|
|
|
|
```
|
|
CREWAI_PLATFORM_INTEGRATION_TOKEN=your_enterprise_token
|
|
```
|
|
|
|
## الإجراءات المتاحة
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="box/save_file">
|
|
**الوصف:** حفظ ملف من عنوان URL في Box.
|
|
|
|
**المعاملات:**
|
|
- `fileAttributes` (object, مطلوب): السمات - بيانات وصفية للملف تشمل الاسم والمجلد الأصلي والطوابع الزمنية.
|
|
```json
|
|
{
|
|
"content_created_at": "2012-12-12T10:53:43-08:00",
|
|
"content_modified_at": "2012-12-12T10:53:43-08:00",
|
|
"name": "qwerty.png",
|
|
"parent": { "id": "1234567" }
|
|
}
|
|
```
|
|
- `file` (string, مطلوب): عنوان URL للملف - يجب أن يكون حجم الملفات أقل من 50 ميجابايت. (مثال: "https://picsum.photos/200/300").
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="box/save_file_from_object">
|
|
**الوصف:** حفظ ملف في Box.
|
|
|
|
**المعاملات:**
|
|
- `file` (string, مطلوب): الملف - يقبل كائن ملف يحتوي على بيانات الملف. يجب أن يكون حجم الملفات أقل من 50 ميجابايت.
|
|
- `fileName` (string, مطلوب): اسم الملف (مثال: "qwerty.png").
|
|
- `folder` (string, اختياري): المجلد - استخدم إعدادات سير عمل بوابة الاتصال للسماح للمستخدمين باختيار وجهة مجلد الملف. يستخدم المجلد الجذري افتراضياً إذا تُرك فارغاً.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="box/get_file_by_id">
|
|
**الوصف:** الحصول على ملف بواسطة المعرّف في Box.
|
|
|
|
**المعاملات:**
|
|
- `fileId` (string, مطلوب): معرّف الملف - المعرّف الفريد الذي يمثل ملفاً. (مثال: "12345").
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="box/list_files">
|
|
**الوصف:** عرض قائمة الملفات في Box.
|
|
|
|
**المعاملات:**
|
|
- `folderId` (string, مطلوب): معرّف المجلد - المعرّف الفريد الذي يمثل مجلداً. (مثال: "0").
|
|
- `filterFormula` (object, اختياري): فلتر بصيغة التعبير العادي المنفصل - OR لمجموعات AND من شروط فردية.
|
|
```json
|
|
{
|
|
"operator": "OR",
|
|
"conditions": [
|
|
{
|
|
"operator": "AND",
|
|
"conditions": [
|
|
{
|
|
"field": "direction",
|
|
"operator": "$stringExactlyMatches",
|
|
"value": "ASC"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="box/create_folder">
|
|
**الوصف:** إنشاء مجلد في Box.
|
|
|
|
**المعاملات:**
|
|
- `folderName` (string, مطلوب): الاسم - اسم المجلد الجديد. (مثال: "New Folder").
|
|
- `folderParent` (object, مطلوب): المجلد الأصلي - المجلد الأصلي الذي سيُنشأ فيه المجلد الجديد.
|
|
```json
|
|
{
|
|
"id": "123456"
|
|
}
|
|
```
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="box/move_folder">
|
|
**الوصف:** نقل مجلد في Box.
|
|
|
|
**المعاملات:**
|
|
- `folderId` (string, مطلوب): معرّف المجلد - المعرّف الفريد الذي يمثل مجلداً. (مثال: "0").
|
|
- `folderName` (string, مطلوب): الاسم - اسم المجلد. (مثال: "New Folder").
|
|
- `folderParent` (object, مطلوب): المجلد الأصلي - وجهة المجلد الأصلي الجديد.
|
|
```json
|
|
{
|
|
"id": "123456"
|
|
}
|
|
```
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="box/get_folder_by_id">
|
|
**الوصف:** الحصول على مجلد بواسطة المعرّف في Box.
|
|
|
|
**المعاملات:**
|
|
- `folderId` (string, مطلوب): معرّف المجلد - المعرّف الفريد الذي يمثل مجلداً. (مثال: "0").
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="box/search_folders">
|
|
**الوصف:** البحث في المجلدات في Box.
|
|
|
|
**المعاملات:**
|
|
- `folderId` (string, مطلوب): معرّف المجلد - المجلد المراد البحث فيه.
|
|
- `filterFormula` (object, اختياري): فلتر بصيغة التعبير العادي المنفصل - OR لمجموعات AND من شروط فردية.
|
|
```json
|
|
{
|
|
"operator": "OR",
|
|
"conditions": [
|
|
{
|
|
"operator": "AND",
|
|
"conditions": [
|
|
{
|
|
"field": "sort",
|
|
"operator": "$stringExactlyMatches",
|
|
"value": "name"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="box/delete_folder">
|
|
**الوصف:** حذف مجلد في Box.
|
|
|
|
**المعاملات:**
|
|
- `folderId` (string, مطلوب): معرّف المجلد - المعرّف الفريد الذي يمثل مجلداً. (مثال: "0").
|
|
- `recursive` (boolean, اختياري): تكراري - حذف مجلد غير فارغ بحذف المجلد وجميع محتوياته تكرارياً.
|
|
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## أمثلة الاستخدام
|
|
|
|
### إعداد Agent أساسي لـ Box
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew
|
|
from crewai import Agent, Task, Crew
|
|
|
|
# Create an agent with Box capabilities
|
|
box_agent = Agent(
|
|
role="Document Manager",
|
|
goal="Manage files and folders in Box efficiently",
|
|
backstory="An AI assistant specialized in document management and file organization.",
|
|
apps=['box'] # All Box actions will be available
|
|
)
|
|
|
|
# Task to create a folder structure
|
|
create_structure_task = Task(
|
|
description="Create a folder called 'Project Files' in the root directory and upload a document from URL",
|
|
agent=box_agent,
|
|
expected_output="Folder created and file uploaded successfully"
|
|
)
|
|
|
|
# Run the task
|
|
crew = Crew(
|
|
agents=[box_agent],
|
|
tasks=[create_structure_task]
|
|
)
|
|
|
|
crew.kickoff()
|
|
```
|
|
|
|
### تصفية أدوات Box محددة
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew
|
|
|
|
# Create agent with specific Box actions only
|
|
file_organizer_agent = Agent(
|
|
role="File Organizer",
|
|
goal="Organize and manage file storage efficiently",
|
|
backstory="An AI assistant that focuses on file organization and storage management.",
|
|
apps=['box/create_folder', 'box/save_file', 'box/list_files'] # Specific Box actions
|
|
)
|
|
|
|
# Task to organize files
|
|
organization_task = Task(
|
|
description="Create a folder structure for the marketing team and organize existing files",
|
|
agent=file_organizer_agent,
|
|
expected_output="Folder structure created and files organized"
|
|
)
|
|
|
|
crew = Crew(
|
|
agents=[file_organizer_agent],
|
|
tasks=[organization_task]
|
|
)
|
|
|
|
crew.kickoff()
|
|
```
|
|
|
|
### إدارة الملفات المتقدمة
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew
|
|
|
|
file_manager = Agent(
|
|
role="File Manager",
|
|
goal="Maintain organized file structure and manage document lifecycle",
|
|
backstory="An experienced file manager who ensures documents are properly organized and accessible.",
|
|
apps=['box']
|
|
)
|
|
|
|
# Complex task involving multiple Box operations
|
|
management_task = Task(
|
|
description="""
|
|
1. List all files in the root folder
|
|
2. Create monthly archive folders for the current year
|
|
3. Move old files to appropriate archive folders
|
|
4. Generate a summary report of the file organization
|
|
""",
|
|
agent=file_manager,
|
|
expected_output="Files organized into archive structure with summary report"
|
|
)
|
|
|
|
crew = Crew(
|
|
agents=[file_manager],
|
|
tasks=[management_task]
|
|
)
|
|
|
|
crew.kickoff()
|
|
```
|