mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 13:48:09 +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>
169 lines
6.3 KiB
Plaintext
169 lines
6.3 KiB
Plaintext
---
|
|
title: تكامل Microsoft Word
|
|
description: "إنشاء المستندات وإدارتها مع تكامل Microsoft Word لـ CrewAI."
|
|
icon: "file-word"
|
|
mode: "wide"
|
|
---
|
|
|
|
## نظرة عامة
|
|
|
|
مكّن وكلاءك من إنشاء وقراءة وإدارة مستندات Word والملفات النصية في OneDrive أو SharePoint. أتمت إنشاء المستندات، واسترجع المحتوى، وأدر خصائص المستندات، وبسّط سير عمل المستندات باستخدام الأتمتة المدعومة بالذكاء الاصطناعي.
|
|
|
|
## المتطلبات الأساسية
|
|
|
|
قبل استخدام تكامل Microsoft Word، تأكد من توفر ما يلي:
|
|
|
|
- حساب [CrewAI AMP](https://app.crewai.com) مع اشتراك فعّال
|
|
- حساب Microsoft مع إمكانية الوصول إلى Word وOneDrive/SharePoint
|
|
- ربط حساب Microsoft الخاص بك عبر [صفحة التكاملات](https://app.crewai.com/crewai_plus/connectors)
|
|
|
|
## إعداد تكامل Microsoft Word
|
|
|
|
### 1. ربط حساب Microsoft الخاص بك
|
|
|
|
1. انتقل إلى [تكاملات CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
|
|
2. ابحث عن **Microsoft Word** في قسم تكاملات المصادقة
|
|
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="microsoft_word/get_documents">
|
|
**الوصف:** الحصول على جميع مستندات Word من OneDrive أو SharePoint.
|
|
|
|
**المعاملات:**
|
|
- `top` (integer, اختياري): عدد العناصر المراد إرجاعها (الحد الأدنى 1، الحد الأقصى 999).
|
|
- `filter` (string, اختياري): تصفية النتائج باستخدام صيغة OData.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_word/create_text_document">
|
|
**الوصف:** إنشاء مستند نصي (.txt) مع محتوى. يُنصح به لإنشاء المحتوى برمجياً.
|
|
|
|
**المعاملات:**
|
|
- `file_name` (string, مطلوب): اسم المستند النصي (يجب أن ينتهي بـ .txt).
|
|
- `content` (string, اختياري): المحتوى النصي للمستند.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_word/get_document_content">
|
|
**الوصف:** الحصول على محتوى مستند (يعمل بشكل أفضل مع الملفات النصية).
|
|
|
|
**المعاملات:**
|
|
- `file_id` (string, مطلوب): معرّف المستند.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_word/get_document_properties">
|
|
**الوصف:** الحصول على خصائص وبيانات وصفية لمستند.
|
|
|
|
**المعاملات:**
|
|
- `file_id` (string, مطلوب): معرّف المستند.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_word/delete_document">
|
|
**الوصف:** حذف مستند.
|
|
|
|
**المعاملات:**
|
|
- `file_id` (string, مطلوب): معرّف المستند المراد حذفه.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_word/copy_document">
|
|
**الوصف:** نسخ مستند إلى موقع جديد في OneDrive.
|
|
|
|
**المعاملات:**
|
|
- `file_id` (string, مطلوب): معرّف المستند المراد نسخه
|
|
- `name` (string, اختياري): الاسم الجديد للمستند المنسوخ
|
|
- `parent_id` (string, اختياري): معرّف مجلد الوجهة (الافتراضي هو الجذر)
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_word/move_document">
|
|
**الوصف:** نقل مستند إلى موقع جديد في OneDrive.
|
|
|
|
**المعاملات:**
|
|
- `file_id` (string, مطلوب): معرّف المستند المراد نقله
|
|
- `parent_id` (string, مطلوب): معرّف مجلد الوجهة
|
|
- `name` (string, اختياري): الاسم الجديد للمستند المنقول
|
|
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## أمثلة الاستخدام
|
|
|
|
### إعداد Agent أساسي لـ Microsoft Word
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew
|
|
|
|
# Create an agent with Microsoft Word capabilities
|
|
word_agent = Agent(
|
|
role="Document Manager",
|
|
goal="Manage Word documents and text files efficiently",
|
|
backstory="An AI assistant specialized in Microsoft Word document operations and content management.",
|
|
apps=['microsoft_word'] # All Word actions will be available
|
|
)
|
|
|
|
# Task to create a new text document
|
|
create_doc_task = Task(
|
|
description="Create a new text document named 'meeting_notes.txt' with content 'Meeting Notes from January 2024: Key discussion points and action items.'",
|
|
agent=word_agent,
|
|
expected_output="New text document 'meeting_notes.txt' created successfully."
|
|
)
|
|
|
|
# Run the task
|
|
crew = Crew(
|
|
agents=[word_agent],
|
|
tasks=[create_doc_task]
|
|
)
|
|
|
|
crew.kickoff()
|
|
```
|
|
|
|
## استكشاف الأخطاء وإصلاحها
|
|
|
|
### المشاكل الشائعة
|
|
|
|
**أخطاء المصادقة**
|
|
|
|
- تأكد من أن حساب Microsoft الخاص بك لديه الصلاحيات اللازمة للوصول إلى الملفات (`Files.Read.All`, `Files.ReadWrite.All`).
|
|
|
|
**مشاكل إنشاء الملفات**
|
|
|
|
- عند إنشاء مستندات نصية، تأكد من أن `file_name` ينتهي بامتداد `.txt`.
|
|
- تحقق من أن لديك صلاحيات الكتابة للموقع المستهدف.
|
|
|
|
### الحصول على المساعدة
|
|
|
|
<Card title="تحتاج مساعدة؟" icon="headset" href="mailto:support@crewai.com">
|
|
تواصل مع فريق الدعم للحصول على المساعدة في إعداد تكامل Microsoft Word
|
|
أو استكشاف الأخطاء وإصلاحها.
|
|
</Card>
|