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>
268 lines
9.4 KiB
Plaintext
268 lines
9.4 KiB
Plaintext
---
|
|
title: الملفات
|
|
description: تمرير الصور وملفات PDF والصوت والفيديو والنصوص إلى وكلائك للمعالجة متعددة الوسائط.
|
|
icon: file-image
|
|
---
|
|
|
|
## نظرة عامة
|
|
|
|
يدعم CrewAI مدخلات الملفات متعددة الوسائط الأصلية، مما يتيح لك تمرير الصور وملفات PDF والصوت والفيديو والنصوص مباشرة إلى وكلائك. يتم تنسيق الملفات تلقائيًا وفقًا لمتطلبات API لكل مزود LLM.
|
|
|
|
<Note type="info" title="اعتمادية اختيارية">
|
|
يتطلب دعم الملفات حزمة `crewai-files` الاختيارية. ثبّتها بـ:
|
|
|
|
```bash
|
|
uv add 'crewai[file-processing]'
|
|
```
|
|
</Note>
|
|
|
|
<Note type="warning" title="وصول مبكر">
|
|
واجهة معالجة الملفات حاليًا في مرحلة الوصول المبكر.
|
|
</Note>
|
|
|
|
## أنواع الملفات
|
|
|
|
يدعم CrewAI خمسة أنواع ملفات محددة بالإضافة إلى فئة `File` العامة التي تكتشف النوع تلقائيًا:
|
|
|
|
| النوع | الفئة | حالات الاستخدام |
|
|
|:-----|:------|:----------|
|
|
| **صورة** | `ImageFile` | صور، لقطات شاشة، مخططات، رسوم بيانية |
|
|
| **PDF** | `PDFFile` | مستندات، تقارير، أوراق بحثية |
|
|
| **صوت** | `AudioFile` | تسجيلات صوتية، بودكاست، اجتماعات |
|
|
| **فيديو** | `VideoFile` | تسجيلات شاشة، عروض تقديمية |
|
|
| **نص** | `TextFile` | ملفات كود، سجلات، ملفات بيانات |
|
|
| **عام** | `File` | اكتشاف تلقائي للنوع من المحتوى |
|
|
|
|
```python
|
|
from crewai_files import File, ImageFile, PDFFile, AudioFile, VideoFile, TextFile
|
|
|
|
image = ImageFile(source="screenshot.png")
|
|
pdf = PDFFile(source="report.pdf")
|
|
audio = AudioFile(source="meeting.mp3")
|
|
video = VideoFile(source="demo.mp4")
|
|
text = TextFile(source="data.csv")
|
|
|
|
file = File(source="document.pdf")
|
|
```
|
|
|
|
## مصادر الملفات
|
|
|
|
يقبل معامل `source` أنواع إدخال متعددة ويكتشف تلقائيًا المعالج المناسب:
|
|
|
|
### من مسار
|
|
|
|
```python
|
|
from crewai_files import ImageFile
|
|
|
|
image = ImageFile(source="./images/chart.png")
|
|
```
|
|
|
|
### من عنوان URL
|
|
|
|
```python
|
|
from crewai_files import ImageFile
|
|
|
|
image = ImageFile(source="https://example.com/image.png")
|
|
```
|
|
|
|
### من بايتات
|
|
|
|
```python
|
|
from crewai_files import ImageFile, FileBytes
|
|
|
|
image_bytes = download_image_from_api()
|
|
image = ImageFile(source=FileBytes(data=image_bytes, filename="downloaded.png"))
|
|
image = ImageFile(source=image_bytes)
|
|
```
|
|
|
|
## استخدام الملفات
|
|
|
|
يمكن تمرير الملفات على مستويات متعددة، حيث تأخذ المستويات الأكثر تحديدًا الأولوية.
|
|
|
|
### مع الأطقم
|
|
|
|
مرر الملفات عند تشغيل طاقم:
|
|
|
|
```python
|
|
from crewai import Crew
|
|
from crewai_files import ImageFile
|
|
|
|
crew = Crew(agents=[analyst], tasks=[analysis_task])
|
|
|
|
result = crew.kickoff(
|
|
inputs={"topic": "Q4 Sales"},
|
|
input_files={
|
|
"chart": ImageFile(source="sales_chart.png"),
|
|
"report": PDFFile(source="quarterly_report.pdf"),
|
|
}
|
|
)
|
|
```
|
|
|
|
### مع المهام
|
|
|
|
أرفق الملفات بمهام محددة:
|
|
|
|
```python
|
|
from crewai import Task
|
|
from crewai_files import ImageFile
|
|
|
|
task = Task(
|
|
description="Analyze the sales chart and identify trends in {chart}",
|
|
expected_output="A summary of key trends",
|
|
input_files={
|
|
"chart": ImageFile(source="sales_chart.png"),
|
|
}
|
|
)
|
|
```
|
|
|
|
### مع التدفقات
|
|
|
|
مرر الملفات إلى التدفقات، والتي تنتقل تلقائيًا إلى الأطقم:
|
|
|
|
```python
|
|
from crewai.flow.flow import Flow, start
|
|
from crewai_files import ImageFile
|
|
|
|
class AnalysisFlow(Flow):
|
|
@start()
|
|
def analyze(self):
|
|
return self.analysis_crew.kickoff()
|
|
|
|
flow = AnalysisFlow()
|
|
result = flow.kickoff(
|
|
input_files={"image": ImageFile(source="data.png")}
|
|
)
|
|
```
|
|
|
|
### مع الوكلاء المستقلين
|
|
|
|
مرر الملفات مباشرة إلى تشغيل الوكيل:
|
|
|
|
```python
|
|
from crewai import Agent
|
|
from crewai_files import ImageFile
|
|
|
|
agent = Agent(
|
|
role="Image Analyst",
|
|
goal="Analyze images",
|
|
backstory="Expert at visual analysis",
|
|
llm="gpt-4o",
|
|
)
|
|
|
|
result = agent.kickoff(
|
|
messages="What's in this image?",
|
|
input_files={"photo": ImageFile(source="photo.jpg")},
|
|
)
|
|
```
|
|
|
|
## أولوية الملفات
|
|
|
|
عند تمرير الملفات على مستويات متعددة، تتجاوز المستويات الأكثر تحديدًا المستويات الأوسع:
|
|
|
|
```
|
|
Flow input_files < Crew input_files < Task input_files
|
|
```
|
|
|
|
على سبيل المثال، إذا عرّف كل من التدفق والمهمة ملفًا باسم `"chart"`، تُستخدم نسخة المهمة.
|
|
|
|
## دعم المزودين
|
|
|
|
تدعم المزودات المختلفة أنواع ملفات مختلفة. يقوم CrewAI تلقائيًا بتنسيق الملفات وفقًا لواجهة كل مزود.
|
|
|
|
| المزود | صورة | PDF | صوت | فيديو | نص |
|
|
|:---------|:-----:|:---:|:-----:|:-----:|:----:|
|
|
| **OpenAI** (completions API) | ✓ | | | | |
|
|
| **OpenAI** (responses API) | ✓ | ✓ | ✓ | | |
|
|
| **Anthropic** (claude-3.x) | ✓ | ✓ | | | |
|
|
| **Google Gemini** (gemini-1.5, 2.0, 2.5) | ✓ | ✓ | ✓ | ✓ | ✓ |
|
|
| **AWS Bedrock** (claude-3) | ✓ | ✓ | | | |
|
|
| **Azure OpenAI** (gpt-4o) | ✓ | | ✓ | | |
|
|
|
|
<Note type="info" title="Gemini لأقصى دعم للملفات">
|
|
تدعم نماذج Google Gemini جميع أنواع الملفات بما في ذلك الفيديو (حتى ساعة واحدة، 2 جيجابايت). استخدم Gemini عندما تحتاج لمعالجة محتوى الفيديو.
|
|
</Note>
|
|
|
|
<Note type="warning" title="أنواع الملفات غير المدعومة">
|
|
إذا مررت نوع ملف لا يدعمه المزود (مثل الفيديو إلى OpenAI)، ستتلقى خطأ `UnsupportedFileTypeError`. اختر مزودك بناءً على أنواع الملفات التي تحتاج لمعالجتها.
|
|
</Note>
|
|
|
|
## كيف تُرسل الملفات
|
|
|
|
يختار CrewAI تلقائيًا الطريقة المثلى لإرسال الملفات إلى كل مزود:
|
|
|
|
| الطريقة | الوصف | متى تُستخدم |
|
|
|:-------|:------------|:----------|
|
|
| **Inline Base64** | الملف مضمّن مباشرة في الطلب | ملفات صغيرة (< 5 ميجابايت عادة) |
|
|
| **File Upload API** | الملف يُرفع بشكل منفصل، يُشار إليه بمعرّف | ملفات كبيرة تتجاوز العتبة |
|
|
| **URL Reference** | عنوان URL مباشر يُمرر إلى النموذج | مصدر الملف هو عنوان URL بالفعل |
|
|
|
|
### طرق الإرسال حسب المزود
|
|
|
|
| المزود | Inline Base64 | File Upload API | URL References |
|
|
|:---------|:-------------:|:---------------:|:--------------:|
|
|
| **OpenAI** | ✓ | ✓ (> 5 MB) | ✓ |
|
|
| **Anthropic** | ✓ | ✓ (> 5 MB) | ✓ |
|
|
| **Google Gemini** | ✓ | ✓ (> 20 MB) | ✓ |
|
|
| **AWS Bedrock** | ✓ | | ✓ (S3 URIs) |
|
|
| **Azure OpenAI** | ✓ | | ✓ |
|
|
|
|
<Note type="info" title="تحسين تلقائي">
|
|
لا تحتاج لإدارة هذا بنفسك. يستخدم CrewAI تلقائيًا الطريقة الأكثر كفاءة بناءً على حجم الملف وقدرات المزود. المزودات بدون واجهات رفع الملفات تستخدم inline base64 لجميع الملفات.
|
|
</Note>
|
|
|
|
## أوضاع معالجة الملفات
|
|
|
|
تحكم في كيفية معالجة الملفات عندما تتجاوز حدود المزود:
|
|
|
|
```python
|
|
from crewai_files import ImageFile, PDFFile
|
|
|
|
image = ImageFile(source="large.png", mode="strict")
|
|
image = ImageFile(source="large.png", mode="auto")
|
|
image = ImageFile(source="large.png", mode="warn")
|
|
pdf = PDFFile(source="large.pdf", mode="chunk")
|
|
```
|
|
|
|
## قيود المزودين
|
|
|
|
لكل مزود حدود محددة لأحجام الملفات والأبعاد:
|
|
|
|
### OpenAI
|
|
- **الصور**: حد أقصى 20 ميجابايت، حتى 10 صور لكل طلب
|
|
- **PDF**: حد أقصى 32 ميجابايت، حتى 100 صفحة
|
|
- **الصوت**: حد أقصى 25 ميجابايت، حتى 25 دقيقة
|
|
|
|
### Anthropic
|
|
- **الصور**: حد أقصى 5 ميجابايت، أقصى 8000x8000 بكسل، حتى 100 صورة
|
|
- **PDF**: حد أقصى 32 ميجابايت، حتى 100 صفحة
|
|
|
|
### Google Gemini
|
|
- **الصور**: حد أقصى 100 ميجابايت
|
|
- **PDF**: حد أقصى 50 ميجابايت
|
|
- **الصوت**: حد أقصى 100 ميجابايت، حتى 9.5 ساعة
|
|
- **الفيديو**: حد أقصى 2 جيجابايت، حتى ساعة واحدة
|
|
|
|
### AWS Bedrock
|
|
- **الصور**: حد أقصى 4.5 ميجابايت، أقصى 8000x8000 بكسل
|
|
- **PDF**: حد أقصى 3.75 ميجابايت، حتى 100 صفحة
|
|
|
|
## الإشارة إلى الملفات في الأوامر
|
|
|
|
استخدم اسم مفتاح الملف في أوصاف المهام للإشارة إلى الملفات:
|
|
|
|
```python
|
|
task = Task(
|
|
description="""
|
|
Analyze the provided materials:
|
|
1. Review the chart in {sales_chart}
|
|
2. Cross-reference with data in {quarterly_report}
|
|
3. Summarize key findings
|
|
""",
|
|
expected_output="Analysis summary with key insights",
|
|
input_files={
|
|
"sales_chart": ImageFile(source="chart.png"),
|
|
"quarterly_report": PDFFile(source="report.pdf"),
|
|
}
|
|
)
|
|
```
|