mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 05:38:12 +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>
239 lines
9.3 KiB
Plaintext
239 lines
9.3 KiB
Plaintext
---
|
|
title: تكامل Google Drive
|
|
description: "تخزين الملفات وإدارتها مع تكامل Google Drive لـ CrewAI."
|
|
icon: "google"
|
|
mode: "wide"
|
|
---
|
|
|
|
## نظرة عامة
|
|
|
|
مكّن وكلاءك من إدارة الملفات والمجلدات عبر Google Drive. ارفع الملفات وحمّلها ونظّمها وشاركها، وأنشئ المجلدات، وبسّط سير عمل إدارة المستندات باستخدام الأتمتة المدعومة بالذكاء الاصطناعي.
|
|
|
|
## المتطلبات الأساسية
|
|
|
|
قبل استخدام تكامل Google Drive، تأكد من توفر ما يلي:
|
|
|
|
- حساب [CrewAI AMP](https://app.crewai.com) مع اشتراك فعّال
|
|
- حساب Google مع إمكانية الوصول إلى Google Drive
|
|
- ربط حساب Google الخاص بك عبر [صفحة التكاملات](https://app.crewai.com/crewai_plus/connectors)
|
|
|
|
## إعداد تكامل Google Drive
|
|
|
|
### 1. ربط حساب Google الخاص بك
|
|
|
|
1. انتقل إلى [تكاملات CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
|
|
2. ابحث عن **Google Drive** في قسم تكاملات المصادقة
|
|
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="google_drive/get_file">
|
|
**الوصف:** الحصول على ملف بواسطة المعرّف من Google Drive.
|
|
|
|
**المعاملات:**
|
|
- `file_id` (string, مطلوب): معرّف الملف المراد استرجاعه.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_drive/list_files">
|
|
**الوصف:** عرض قائمة الملفات في Google Drive.
|
|
|
|
**المعاملات:**
|
|
- `q` (string, اختياري): سلسلة استعلام لتصفية الملفات (مثال: "name contains 'report'").
|
|
- `page_size` (integer, اختياري): الحد الأقصى لعدد الملفات المُرجعة (الافتراضي: 100، الحد الأقصى: 1000).
|
|
- `page_token` (string, اختياري): رمز لاسترجاع الصفحة التالية من النتائج.
|
|
- `order_by` (string, اختياري): ترتيب الفرز (مثال: "name", "createdTime desc", "modifiedTime").
|
|
- `spaces` (string, اختياري): قائمة مفصولة بفواصل للمساحات المراد الاستعلام عنها (drive, appDataFolder, photos).
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_drive/upload_file">
|
|
**الوصف:** رفع ملف إلى Google Drive.
|
|
|
|
**المعاملات:**
|
|
- `name` (string, مطلوب): اسم الملف المراد إنشاؤه.
|
|
- `content` (string, مطلوب): محتوى الملف المراد رفعه.
|
|
- `mime_type` (string, اختياري): نوع MIME للملف (مثال: "text/plain", "application/pdf").
|
|
- `parent_folder_id` (string, اختياري): معرّف المجلد الأصلي حيث يجب إنشاء الملف.
|
|
- `description` (string, اختياري): وصف الملف.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_drive/download_file">
|
|
**الوصف:** تحميل ملف من Google Drive.
|
|
|
|
**المعاملات:**
|
|
- `file_id` (string, مطلوب): معرّف الملف المراد تحميله.
|
|
- `mime_type` (string, اختياري): نوع MIME للتصدير (مطلوب لمستندات Google Workspace).
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_drive/create_folder">
|
|
**الوصف:** إنشاء مجلد جديد في Google Drive.
|
|
|
|
**المعاملات:**
|
|
- `name` (string, مطلوب): اسم المجلد المراد إنشاؤه.
|
|
- `parent_folder_id` (string, اختياري): معرّف المجلد الأصلي حيث يجب إنشاء المجلد الجديد.
|
|
- `description` (string, اختياري): وصف المجلد.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_drive/delete_file">
|
|
**الوصف:** حذف ملف من Google Drive.
|
|
|
|
**المعاملات:**
|
|
- `file_id` (string, مطلوب): معرّف الملف المراد حذفه.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_drive/share_file">
|
|
**الوصف:** مشاركة ملف في Google Drive مع مستخدمين محددين أو جعله عاماً.
|
|
|
|
**المعاملات:**
|
|
- `file_id` (string, مطلوب): معرّف الملف المراد مشاركته.
|
|
- `role` (string, مطلوب): الدور الممنوح بهذا الإذن (reader, writer, commenter, owner).
|
|
- `type` (string, مطلوب): نوع المستفيد (user, group, domain, anyone).
|
|
- `email_address` (string, اختياري): عنوان البريد الإلكتروني للمستخدم أو المجموعة المراد المشاركة معهم (مطلوب لأنواع user/group).
|
|
- `domain` (string, اختياري): النطاق المراد المشاركة معه (مطلوب لنوع domain).
|
|
- `send_notification_email` (boolean, اختياري): ما إذا كان يجب إرسال بريد إلكتروني إشعاري (الافتراضي: true).
|
|
- `email_message` (string, اختياري): رسالة نصية مخصصة لتضمينها في البريد الإلكتروني الإشعاري.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="google_drive/update_file">
|
|
**الوصف:** تحديث ملف موجود في Google Drive.
|
|
|
|
**المعاملات:**
|
|
- `file_id` (string, مطلوب): معرّف الملف المراد تحديثه.
|
|
- `name` (string, اختياري): الاسم الجديد للملف.
|
|
- `content` (string, اختياري): المحتوى الجديد للملف.
|
|
- `mime_type` (string, اختياري): نوع MIME الجديد للملف.
|
|
- `description` (string, اختياري): الوصف الجديد للملف.
|
|
- `add_parents` (string, اختياري): قائمة مفصولة بفواصل لمعرّفات المجلدات الأصلية المراد إضافتها.
|
|
- `remove_parents` (string, اختياري): قائمة مفصولة بفواصل لمعرّفات المجلدات الأصلية المراد إزالتها.
|
|
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## أمثلة الاستخدام
|
|
|
|
### إعداد Agent أساسي لـ Google Drive
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew
|
|
|
|
# Create an agent with Google Drive capabilities
|
|
drive_agent = Agent(
|
|
role="File Manager",
|
|
goal="Manage files and folders in Google Drive efficiently",
|
|
backstory="An AI assistant specialized in document and file management.",
|
|
apps=['google_drive'] # All Google Drive actions will be available
|
|
)
|
|
|
|
# Task to organize files
|
|
organize_files_task = Task(
|
|
description="List all files in the root directory and organize them into appropriate folders",
|
|
agent=drive_agent,
|
|
expected_output="Summary of files organized with folder structure"
|
|
)
|
|
|
|
# Run the task
|
|
crew = Crew(
|
|
agents=[drive_agent],
|
|
tasks=[organize_files_task]
|
|
)
|
|
|
|
crew.kickoff()
|
|
```
|
|
|
|
### تصفية أدوات Google Drive المحددة
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew
|
|
|
|
# Create agent with specific Google Drive actions only
|
|
file_manager_agent = Agent(
|
|
role="Document Manager",
|
|
goal="Upload and manage documents efficiently",
|
|
backstory="An AI assistant that focuses on document upload and organization.",
|
|
apps=[
|
|
'google_drive/upload_file',
|
|
'google_drive/create_folder',
|
|
'google_drive/share_file'
|
|
] # Specific Google Drive actions
|
|
)
|
|
|
|
# Task to upload and share documents
|
|
document_task = Task(
|
|
description="Upload the quarterly report and share it with the finance team",
|
|
agent=file_manager_agent,
|
|
expected_output="Document uploaded and sharing permissions configured"
|
|
)
|
|
|
|
crew = Crew(
|
|
agents=[file_manager_agent],
|
|
tasks=[document_task]
|
|
)
|
|
|
|
crew.kickoff()
|
|
```
|
|
|
|
### إدارة الملفات المتقدمة
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew
|
|
|
|
file_organizer = Agent(
|
|
role="File Organizer",
|
|
goal="Maintain organized file structure and manage permissions",
|
|
backstory="An experienced file manager who ensures proper organization and access control.",
|
|
apps=['google_drive']
|
|
)
|
|
|
|
# Complex task involving multiple Google Drive operations
|
|
organization_task = Task(
|
|
description="""
|
|
1. List all files in the shared folder
|
|
2. Create folders for different document types (Reports, Presentations, Spreadsheets)
|
|
3. Move files to appropriate folders based on their type
|
|
4. Set appropriate sharing permissions for each folder
|
|
5. Create a summary document of the organization changes
|
|
""",
|
|
agent=file_organizer,
|
|
expected_output="Files organized into categorized folders with proper permissions and summary report"
|
|
)
|
|
|
|
crew = Crew(
|
|
agents=[file_organizer],
|
|
tasks=[organization_task]
|
|
)
|
|
|
|
crew.kickoff()
|
|
```
|