mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-03 22:19:27 +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>
228 lines
9.6 KiB
Plaintext
228 lines
9.6 KiB
Plaintext
---
|
|
title: تكامل Microsoft Outlook
|
|
description: "إدارة البريد الإلكتروني والتقويم وجهات الاتصال مع تكامل Microsoft Outlook لـ CrewAI."
|
|
icon: "envelope"
|
|
mode: "wide"
|
|
---
|
|
|
|
## نظرة عامة
|
|
|
|
مكّن وكلاءك من الوصول إلى رسائل Outlook الإلكترونية وأحداث التقويم وجهات الاتصال وإدارتها. أرسل رسائل البريد الإلكتروني، واسترجع الرسائل، وأدر أحداث التقويم، ونظّم جهات الاتصال باستخدام الأتمتة المدعومة بالذكاء الاصطناعي.
|
|
|
|
## المتطلبات الأساسية
|
|
|
|
قبل استخدام تكامل Microsoft Outlook، تأكد من توفر ما يلي:
|
|
|
|
- حساب [CrewAI AMP](https://app.crewai.com) مع اشتراك فعّال
|
|
- حساب Microsoft مع إمكانية الوصول إلى Outlook
|
|
- ربط حساب Microsoft الخاص بك عبر [صفحة التكاملات](https://app.crewai.com/crewai_plus/connectors)
|
|
|
|
## إعداد تكامل Microsoft Outlook
|
|
|
|
### 1. ربط حساب Microsoft الخاص بك
|
|
|
|
1. انتقل إلى [تكاملات CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
|
|
2. ابحث عن **Microsoft Outlook** في قسم تكاملات المصادقة
|
|
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_outlook/get_messages">
|
|
**الوصف:** الحصول على رسائل البريد الإلكتروني من صندوق بريد المستخدم.
|
|
|
|
**المعاملات:**
|
|
- `top` (integer, اختياري): عدد الرسائل (الحد الأقصى 1000). الافتراضي: `10`.
|
|
- `filter` (string, اختياري): تعبير فلتر OData (مثال: "isRead eq false").
|
|
- `search` (string, اختياري): سلسلة استعلام البحث.
|
|
- `orderby` (string, اختياري): الترتيب (مثال: "receivedDateTime desc"). الافتراضي: "receivedDateTime desc".
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_outlook/send_email">
|
|
**الوصف:** إرسال رسالة بريد إلكتروني.
|
|
|
|
**المعاملات:**
|
|
- `to_recipients` (array, مطلوب): مصفوفة عناوين المستلمين.
|
|
- `subject` (string, مطلوب): موضوع البريد الإلكتروني.
|
|
- `body` (string, مطلوب): محتوى البريد الإلكتروني.
|
|
- `body_type` (string, اختياري): نوع المحتوى. القيم: `Text`, `HTML`. الافتراضي: `HTML`.
|
|
- `importance` (string, اختياري): مستوى الأهمية. القيم: `low`, `normal`, `high`. الافتراضي: `normal`.
|
|
- `cc_recipients` (array, اختياري): مصفوفة عناوين النسخة الكربونية.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_outlook/get_calendar_events">
|
|
**الوصف:** الحصول على أحداث التقويم من تقويم المستخدم.
|
|
|
|
**المعاملات:**
|
|
- `top` (integer, اختياري): عدد الأحداث (الحد الأقصى 1000). الافتراضي: `10`.
|
|
- `filter` (string, اختياري): تعبير فلتر OData.
|
|
- `orderby` (string, اختياري): الترتيب. الافتراضي: "start/dateTime asc".
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_outlook/create_calendar_event">
|
|
**الوصف:** إنشاء حدث تقويم جديد.
|
|
|
|
**المعاملات:**
|
|
- `subject` (string, مطلوب): موضوع/عنوان الحدث.
|
|
- `start_datetime` (string, مطلوب): وقت البداية بصيغة ISO 8601.
|
|
- `end_datetime` (string, مطلوب): وقت النهاية بصيغة ISO 8601.
|
|
- `timezone` (string, اختياري): المنطقة الزمنية. الافتراضي: `UTC`.
|
|
- `location` (string, اختياري): موقع الحدث.
|
|
- `attendees` (array, اختياري): مصفوفة عناوين الحضور.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_outlook/get_contacts">
|
|
**الوصف:** الحصول على جهات الاتصال من دفتر عناوين المستخدم.
|
|
|
|
**المعاملات:**
|
|
- `top` (integer, اختياري): عدد جهات الاتصال (الحد الأقصى 1000). الافتراضي: `10`.
|
|
- `filter` (string, اختياري): تعبير فلتر OData.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_outlook/create_contact">
|
|
**الوصف:** إنشاء جهة اتصال جديدة في دفتر عناوين المستخدم.
|
|
|
|
**المعاملات:**
|
|
- `displayName` (string, مطلوب): اسم العرض لجهة الاتصال.
|
|
- `givenName` (string, اختياري): الاسم الأول.
|
|
- `surname` (string, اختياري): اسم العائلة.
|
|
- `emailAddresses` (array, اختياري): مصفوفة عناوين البريد الإلكتروني.
|
|
- `jobTitle` (string, اختياري): المسمى الوظيفي.
|
|
- `companyName` (string, اختياري): اسم الشركة.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_outlook/reply_to_email">
|
|
**الوصف:** الرد على رسالة بريد إلكتروني.
|
|
|
|
**المعاملات:**
|
|
- `message_id` (string, مطلوب): المعرّف الفريد للرسالة المراد الرد عليها.
|
|
- `comment` (string, مطلوب): محتوى الرد.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_outlook/forward_email">
|
|
**الوصف:** إعادة توجيه رسالة بريد إلكتروني.
|
|
|
|
**المعاملات:**
|
|
- `message_id` (string, مطلوب): المعرّف الفريد للرسالة المراد إعادة توجيهها.
|
|
- `to_recipients` (array, مطلوب): مصفوفة عناوين المستلمين.
|
|
- `comment` (string, اختياري): رسالة اختيارية لتضمينها فوق المحتوى المُعاد توجيهه.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_outlook/delete_message">
|
|
**الوصف:** حذف رسالة بريد إلكتروني.
|
|
|
|
**المعاملات:**
|
|
- `message_id` (string, مطلوب): المعرّف الفريد للرسالة المراد حذفها.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_outlook/update_event">
|
|
**الوصف:** تحديث حدث تقويم موجود.
|
|
|
|
**المعاملات:**
|
|
- `event_id` (string, مطلوب): المعرّف الفريد للحدث.
|
|
- `subject` (string, اختياري): الموضوع/العنوان الجديد.
|
|
- `start_time` (string, اختياري): وقت البداية الجديد بصيغة ISO 8601.
|
|
- `location` (string, اختياري): الموقع الجديد.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_outlook/delete_event">
|
|
**الوصف:** حذف حدث تقويم.
|
|
|
|
**المعاملات:**
|
|
- `event_id` (string, مطلوب): المعرّف الفريد للحدث المراد حذفه.
|
|
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## أمثلة الاستخدام
|
|
|
|
### إعداد Agent أساسي لـ Microsoft Outlook
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew
|
|
|
|
# Create an agent with Microsoft Outlook capabilities
|
|
outlook_agent = Agent(
|
|
role="Email Assistant",
|
|
goal="Manage emails, calendar events, and contacts efficiently",
|
|
backstory="An AI assistant specialized in Microsoft Outlook operations and communication management.",
|
|
apps=['microsoft_outlook'] # All Outlook actions will be available
|
|
)
|
|
|
|
# Task to send an email
|
|
send_email_task = Task(
|
|
description="Send an email to 'colleague@example.com' with subject 'Project Update' and body 'Hi, here is the latest project update. Best regards.'",
|
|
agent=outlook_agent,
|
|
expected_output="Email sent successfully to colleague@example.com"
|
|
)
|
|
|
|
# Run the task
|
|
crew = Crew(
|
|
agents=[outlook_agent],
|
|
tasks=[send_email_task]
|
|
)
|
|
|
|
crew.kickoff()
|
|
```
|
|
|
|
## استكشاف الأخطاء وإصلاحها
|
|
|
|
### المشاكل الشائعة
|
|
|
|
**أخطاء المصادقة**
|
|
|
|
- تأكد من أن حساب Microsoft الخاص بك لديه الصلاحيات اللازمة للوصول إلى البريد والتقويم وجهات الاتصال.
|
|
- النطاقات المطلوبة تشمل: `Mail.Read`, `Mail.Send`, `Calendars.ReadWrite`, `Contacts.ReadWrite`.
|
|
|
|
**مشاكل إرسال البريد الإلكتروني**
|
|
|
|
- تأكد من توفير `to_recipients` و`subject` و`body` لـ `send_email`.
|
|
- تحقق من صحة صيغة عناوين البريد الإلكتروني.
|
|
|
|
**إنشاء أحداث التقويم**
|
|
|
|
- تأكد من توفير `subject` و`start_datetime` و`end_datetime`.
|
|
- استخدم صيغة ISO 8601 المناسبة لحقول التاريخ والوقت.
|
|
|
|
### الحصول على المساعدة
|
|
|
|
<Card title="تحتاج مساعدة؟" icon="headset" href="mailto:support@crewai.com">
|
|
تواصل مع فريق الدعم للحصول على المساعدة في إعداد تكامل Microsoft Outlook
|
|
أو استكشاف الأخطاء وإصلاحها.
|
|
</Card>
|