mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 13:48:09 +00:00
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>
271 lines
11 KiB
Plaintext
271 lines
11 KiB
Plaintext
---
|
|
title: تكامل Microsoft SharePoint
|
|
description: "إدارة المواقع والقوائم والمستندات مع تكامل Microsoft SharePoint لـ CrewAI."
|
|
icon: "folder-tree"
|
|
mode: "wide"
|
|
---
|
|
|
|
## نظرة عامة
|
|
|
|
مكّن وكلاءك من الوصول إلى مواقع SharePoint والقوائم ومكتبات المستندات وإدارتها. استرجع معلومات المواقع، وأدر عناصر القوائم، وارفع الملفات ونظّمها، وبسّط سير عمل SharePoint باستخدام الأتمتة المدعومة بالذكاء الاصطناعي.
|
|
|
|
## المتطلبات الأساسية
|
|
|
|
قبل استخدام تكامل Microsoft SharePoint، تأكد من توفر ما يلي:
|
|
|
|
- حساب [CrewAI AMP](https://app.crewai.com) مع اشتراك فعّال
|
|
- حساب Microsoft 365 مع إمكانية الوصول إلى SharePoint
|
|
- ربط حساب Microsoft الخاص بك عبر [صفحة التكاملات](https://app.crewai.com/crewai_plus/connectors)
|
|
|
|
## إعداد تكامل Microsoft SharePoint
|
|
|
|
### 1. ربط حساب Microsoft الخاص بك
|
|
|
|
1. انتقل إلى [تكاملات CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
|
|
2. ابحث عن **Microsoft SharePoint** في قسم تكاملات المصادقة
|
|
3. انقر على **Connect** وأكمل عملية OAuth
|
|
4. امنح الصلاحيات اللازمة للوصول إلى مواقع SharePoint ومحتوياتها
|
|
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="microsoft_sharepoint/get_sites">
|
|
**الوصف:** الحصول على جميع مواقع SharePoint التي يمكن للمستخدم الوصول إليها.
|
|
|
|
**المعاملات:**
|
|
- `search` (string, اختياري): استعلام بحث لتصفية المواقع
|
|
- `top` (integer, اختياري): عدد العناصر المراد إرجاعها. الحد الأدنى: 1، الحد الأقصى: 999
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_sharepoint/get_site">
|
|
**الوصف:** الحصول على معلومات حول موقع SharePoint محدد.
|
|
|
|
**المعاملات:**
|
|
- `site_id` (string, مطلوب): معرّف موقع SharePoint
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_sharepoint/get_drives">
|
|
**الوصف:** عرض جميع مكتبات المستندات (drives) في موقع SharePoint.
|
|
|
|
**المعاملات:**
|
|
- `site_id` (string, مطلوب): معرّف موقع SharePoint الكامل
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_sharepoint/get_site_lists">
|
|
**الوصف:** الحصول على جميع القوائم في موقع SharePoint.
|
|
|
|
**المعاملات:**
|
|
- `site_id` (string, مطلوب): معرّف موقع SharePoint
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_sharepoint/get_list_items">
|
|
**الوصف:** الحصول على عناصر من قائمة SharePoint.
|
|
|
|
**المعاملات:**
|
|
- `site_id` (string, مطلوب): معرّف موقع SharePoint
|
|
- `list_id` (string, مطلوب): معرّف القائمة
|
|
- `expand` (string, اختياري): توسيع البيانات المرتبطة (مثال: 'fields')
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_sharepoint/create_list_item">
|
|
**الوصف:** إنشاء عنصر جديد في قائمة SharePoint.
|
|
|
|
**المعاملات:**
|
|
- `site_id` (string, مطلوب): معرّف موقع SharePoint
|
|
- `list_id` (string, مطلوب): معرّف القائمة
|
|
- `fields` (object, مطلوب): قيم الحقول للعنصر الجديد
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_sharepoint/update_list_item">
|
|
**الوصف:** تحديث عنصر في قائمة SharePoint.
|
|
|
|
**المعاملات:**
|
|
- `site_id` (string, مطلوب): معرّف موقع SharePoint
|
|
- `list_id` (string, مطلوب): معرّف القائمة
|
|
- `item_id` (string, مطلوب): معرّف العنصر المراد تحديثه
|
|
- `fields` (object, مطلوب): قيم الحقول المراد تحديثها
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_sharepoint/delete_list_item">
|
|
**الوصف:** حذف عنصر من قائمة SharePoint.
|
|
|
|
**المعاملات:**
|
|
- `site_id` (string, مطلوب): معرّف موقع SharePoint
|
|
- `list_id` (string, مطلوب): معرّف القائمة
|
|
- `item_id` (string, مطلوب): معرّف العنصر المراد حذفه
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_sharepoint/upload_file_to_library">
|
|
**الوصف:** رفع ملف إلى مكتبة مستندات SharePoint.
|
|
|
|
**المعاملات:**
|
|
- `site_id` (string, مطلوب): معرّف موقع SharePoint
|
|
- `file_path` (string, مطلوب): المسار حيث يتم رفع الملف
|
|
- `content` (string, مطلوب): محتوى الملف المراد رفعه
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_sharepoint/list_files">
|
|
**الوصف:** استرجاع الملفات والمجلدات من مكتبة مستندات SharePoint.
|
|
|
|
**المعاملات:**
|
|
- `site_id` (string, مطلوب): معرّف موقع SharePoint الكامل
|
|
- `drive_id` (string, مطلوب): معرّف مكتبة المستندات
|
|
- `folder_id` (string, اختياري): معرّف المجلد. الافتراضي: 'root'
|
|
- `top` (integer, اختياري): الحد الأقصى لعدد العناصر. الافتراضي: 50
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_sharepoint/search_files">
|
|
**الوصف:** البحث عن الملفات والمجلدات في مكتبة مستندات SharePoint بالكلمات المفتاحية.
|
|
|
|
**المعاملات:**
|
|
- `site_id` (string, مطلوب): معرّف موقع SharePoint الكامل
|
|
- `drive_id` (string, مطلوب): معرّف مكتبة المستندات
|
|
- `query` (string, مطلوب): كلمات البحث المفتاحية
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_sharepoint/delete_file">
|
|
**الوصف:** حذف ملف أو مجلد من مكتبة مستندات SharePoint.
|
|
|
|
**المعاملات:**
|
|
- `site_id` (string, مطلوب): معرّف موقع SharePoint الكامل
|
|
- `drive_id` (string, مطلوب): معرّف مكتبة المستندات
|
|
- `item_id` (string, مطلوب): المعرّف الفريد للملف أو المجلد المراد حذفه
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_sharepoint/create_folder">
|
|
**الوصف:** إنشاء مجلد جديد في مكتبة مستندات SharePoint.
|
|
|
|
**المعاملات:**
|
|
- `site_id` (string, مطلوب): معرّف موقع SharePoint الكامل
|
|
- `drive_id` (string, مطلوب): معرّف مكتبة المستندات
|
|
- `folder_name` (string, مطلوب): اسم المجلد الجديد
|
|
- `parent_id` (string, اختياري): معرّف المجلد الأصلي. الافتراضي: 'root'
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_sharepoint/download_file">
|
|
**الوصف:** تحميل محتوى ملف خام من مكتبة مستندات SharePoint.
|
|
|
|
**المعاملات:**
|
|
- `site_id` (string, مطلوب): معرّف موقع SharePoint الكامل
|
|
- `drive_id` (string, مطلوب): معرّف مكتبة المستندات
|
|
- `item_id` (string, مطلوب): المعرّف الفريد للملف المراد تحميله
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_sharepoint/copy_file">
|
|
**الوصف:** نسخ ملف أو مجلد إلى موقع جديد داخل SharePoint.
|
|
|
|
**المعاملات:**
|
|
- `site_id` (string, مطلوب): معرّف موقع SharePoint الكامل
|
|
- `drive_id` (string, مطلوب): معرّف مكتبة المستندات
|
|
- `item_id` (string, مطلوب): المعرّف الفريد للملف أو المجلد المراد نسخه
|
|
- `destination_folder_id` (string, مطلوب): معرّف مجلد الوجهة
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_sharepoint/move_file">
|
|
**الوصف:** نقل ملف أو مجلد إلى موقع جديد داخل SharePoint.
|
|
|
|
**المعاملات:**
|
|
- `site_id` (string, مطلوب): معرّف موقع SharePoint الكامل
|
|
- `drive_id` (string, مطلوب): معرّف مكتبة المستندات
|
|
- `item_id` (string, مطلوب): المعرّف الفريد للملف أو المجلد المراد نقله
|
|
- `destination_folder_id` (string, مطلوب): معرّف مجلد الوجهة
|
|
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## أمثلة الاستخدام
|
|
|
|
### إعداد Agent أساسي لـ SharePoint
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew
|
|
|
|
# Create an agent with SharePoint capabilities
|
|
sharepoint_agent = Agent(
|
|
role="SharePoint Manager",
|
|
goal="Manage SharePoint sites, lists, and documents efficiently",
|
|
backstory="An AI assistant specialized in SharePoint content management and collaboration.",
|
|
apps=['microsoft_sharepoint'] # All SharePoint actions will be available
|
|
)
|
|
|
|
# Task to organize SharePoint content
|
|
content_organization_task = Task(
|
|
description="List all accessible SharePoint sites and organize content by department",
|
|
agent=sharepoint_agent,
|
|
expected_output="SharePoint sites listed and content organized by department"
|
|
)
|
|
|
|
# Run the task
|
|
crew = Crew(
|
|
agents=[sharepoint_agent],
|
|
tasks=[content_organization_task]
|
|
)
|
|
|
|
crew.kickoff()
|
|
```
|
|
|
|
## استكشاف الأخطاء وإصلاحها
|
|
|
|
### المشاكل الشائعة
|
|
|
|
**أخطاء الصلاحيات**
|
|
|
|
- تأكد من أن حساب Microsoft الخاص بك لديه الصلاحيات المناسبة لمواقع SharePoint
|
|
- تحقق من أن اتصال OAuth يتضمن النطاقات المطلوبة (Sites.Read.All, Sites.ReadWrite.All)
|
|
|
|
**مشاكل معرّفات المواقع والقوائم**
|
|
|
|
- تحقق من صحة معرّفات المواقع والقوائم وصيغتها الصحيحة
|
|
- استخدم إجراءات get_sites وget_site_lists لاكتشاف المعرّفات الصالحة
|
|
|
|
**مشاكل الحقول والمخطط**
|
|
|
|
- تأكد من تطابق أسماء الحقول تماماً مع مخطط قائمة SharePoint
|
|
- تحقق من تضمين الحقول المطلوبة عند إنشاء أو تحديث عناصر القوائم
|
|
|
|
### الحصول على المساعدة
|
|
|
|
<Card title="تحتاج مساعدة؟" icon="headset" href="mailto:support@crewai.com">
|
|
تواصل مع فريق الدعم للحصول على المساعدة في إعداد تكامل Microsoft SharePoint
|
|
أو استكشاف الأخطاء وإصلاحها.
|
|
</Card>
|