mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-03 14:09:24 +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>
215 lines
8.9 KiB
Plaintext
215 lines
8.9 KiB
Plaintext
---
|
|
title: الاتصال بأي LLM
|
|
description: دليل شامل لدمج CrewAI مع نماذج اللغة الكبيرة المختلفة (LLMs) باستخدام LiteLLM، بما في ذلك المزودون المدعومون وخيارات الإعداد.
|
|
icon: brain-circuit
|
|
mode: "wide"
|
|
---
|
|
|
|
## ربط CrewAI بنماذج اللغة الكبيرة
|
|
|
|
يتصل CrewAI بنماذج اللغة الكبيرة من خلال تكاملات SDK الأصلية لأكثر المزودين شيوعاً (OpenAI وAnthropic وGoogle Gemini وAzure وAWS Bedrock)، ويستخدم LiteLLM كاحتياط مرن لجميع المزودين الآخرين.
|
|
|
|
<Note>
|
|
افتراضياً، يستخدم CrewAI نموذج `gpt-4o-mini`. يتم تحديد ذلك بواسطة متغير البيئة `OPENAI_MODEL_NAME`، الذي يكون قيمته الافتراضية "gpt-4o-mini" إذا لم يتم تعيينه.
|
|
يمكنك بسهولة إعداد وكلائك لاستخدام نموذج أو مزود مختلف كما هو موضح في هذا الدليل.
|
|
</Note>
|
|
|
|
## المزودون المدعومون
|
|
|
|
يدعم LiteLLM مجموعة واسعة من المزودين، بما في ذلك على سبيل المثال لا الحصر:
|
|
|
|
- OpenAI
|
|
- Anthropic
|
|
- Google (Vertex AI, Gemini)
|
|
- Azure OpenAI
|
|
- AWS (Bedrock, SageMaker)
|
|
- Cohere
|
|
- VoyageAI
|
|
- Hugging Face
|
|
- Ollama
|
|
- Mistral AI
|
|
- Replicate
|
|
- Together AI
|
|
- AI21
|
|
- Cloudflare Workers AI
|
|
- DeepInfra
|
|
- Groq
|
|
- SambaNova
|
|
- Nebius AI Studio
|
|
- [NVIDIA NIMs](https://docs.api.nvidia.com/nim/reference/models-1)
|
|
- والمزيد!
|
|
|
|
للحصول على قائمة كاملة ومحدثة بالمزودين المدعومين، يرجى الرجوع إلى [وثائق مزودي LiteLLM](https://docs.litellm.ai/docs/providers).
|
|
|
|
<Info>
|
|
لاستخدام أي مزود غير مغطى بتكامل أصلي، أضف LiteLLM كاعتمادية لمشروعك:
|
|
```bash
|
|
uv add 'crewai[litellm]'
|
|
```
|
|
يستخدم المزودون الأصليون (OpenAI، Anthropic، Google Gemini، Azure، AWS Bedrock) إضافات SDK الخاصة بهم — راجع [أمثلة إعداد المزودين](/ar/concepts/llms#provider-configuration-examples).
|
|
</Info>
|
|
|
|
## تغيير نموذج اللغة الكبير
|
|
|
|
لاستخدام LLM مختلف مع وكلاء CrewAI، لديك عدة خيارات:
|
|
|
|
<Tabs>
|
|
<Tab title="باستخدام معرف نصي">
|
|
مرر اسم النموذج كسلسلة نصية عند تهيئة الوكيل:
|
|
<CodeGroup>
|
|
```python Code
|
|
from crewai import Agent
|
|
|
|
# Using OpenAI's GPT-4
|
|
openai_agent = Agent(
|
|
role='OpenAI Expert',
|
|
goal='Provide insights using GPT-4',
|
|
backstory="An AI assistant powered by OpenAI's latest model.",
|
|
llm='gpt-4'
|
|
)
|
|
|
|
# Using Anthropic's Claude
|
|
claude_agent = Agent(
|
|
role='Anthropic Expert',
|
|
goal='Analyze data using Claude',
|
|
backstory="An AI assistant leveraging Anthropic's language model.",
|
|
llm='claude-2'
|
|
)
|
|
```
|
|
</CodeGroup>
|
|
</Tab>
|
|
<Tab title="باستخدام فئة LLM">
|
|
لمزيد من الإعداد التفصيلي، استخدم فئة LLM:
|
|
<CodeGroup>
|
|
```python Code
|
|
from crewai import Agent, LLM
|
|
|
|
llm = LLM(
|
|
model="gpt-4",
|
|
temperature=0.7,
|
|
base_url="https://api.openai.com/v1",
|
|
api_key="your-api-key-here"
|
|
)
|
|
|
|
agent = Agent(
|
|
role='Customized LLM Expert',
|
|
goal='Provide tailored responses',
|
|
backstory="An AI assistant with custom LLM settings.",
|
|
llm=llm
|
|
)
|
|
```
|
|
</CodeGroup>
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## خيارات الإعداد
|
|
|
|
عند إعداد LLM لوكيلك، يمكنك الوصول إلى مجموعة واسعة من المعاملات:
|
|
|
|
| المعامل | النوع | الوصف |
|
|
|:----------|:-----:|:-------------|
|
|
| **model** | `str` | اسم النموذج المراد استخدامه (مثل "gpt-4"، "claude-2") |
|
|
| **temperature** | `float` | يتحكم في العشوائية في المخرجات (0.0 إلى 1.0) |
|
|
| **max_tokens** | `int` | الحد الأقصى لعدد الرموز المولدة |
|
|
| **top_p** | `float` | يتحكم في تنوع المخرجات (0.0 إلى 1.0) |
|
|
| **frequency_penalty** | `float` | يعاقب الرموز الجديدة بناءً على تكرارها في النص حتى الآن |
|
|
| **presence_penalty** | `float` | يعاقب الرموز الجديدة بناءً على وجودها في النص حتى الآن |
|
|
| **stop** | `str`, `List[str]` | تسلسل(ات) لإيقاف التوليد |
|
|
| **base_url** | `str` | عنوان URL الأساسي لنقطة نهاية API |
|
|
| **api_key** | `str` | مفتاح API الخاص بك للمصادقة |
|
|
|
|
للحصول على قائمة كاملة بالمعاملات وأوصافها، راجع وثائق فئة LLM.
|
|
|
|
## الاتصال بنماذج LLM المتوافقة مع OpenAI
|
|
|
|
يمكنك الاتصال بنماذج LLM المتوافقة مع OpenAI باستخدام متغيرات البيئة أو عن طريق تعيين خصائص محددة في فئة LLM:
|
|
|
|
<Tabs>
|
|
<Tab title="باستخدام متغيرات البيئة">
|
|
<CodeGroup>
|
|
```python Generic
|
|
import os
|
|
|
|
os.environ["OPENAI_API_KEY"] = "your-api-key"
|
|
os.environ["OPENAI_API_BASE"] = "https://api.your-provider.com/v1"
|
|
os.environ["OPENAI_MODEL_NAME"] = "your-model-name"
|
|
```
|
|
|
|
```python Google
|
|
import os
|
|
|
|
# Example using Gemini's OpenAI-compatible API.
|
|
os.environ["OPENAI_API_KEY"] = "your-gemini-key" # Should start with AIza...
|
|
os.environ["OPENAI_API_BASE"] = "https://generativelanguage.googleapis.com/v1beta/openai/"
|
|
os.environ["OPENAI_MODEL_NAME"] = "openai/gemini-2.0-flash" # Add your Gemini model here, under openai/
|
|
```
|
|
</CodeGroup>
|
|
</Tab>
|
|
<Tab title="باستخدام خصائص فئة LLM">
|
|
<CodeGroup>
|
|
```python Generic
|
|
llm = LLM(
|
|
model="custom-model-name",
|
|
api_key="your-api-key",
|
|
base_url="https://api.your-provider.com/v1"
|
|
)
|
|
agent = Agent(llm=llm, ...)
|
|
```
|
|
|
|
```python Google
|
|
# Example using Gemini's OpenAI-compatible API
|
|
llm = LLM(
|
|
model="openai/gemini-2.0-flash",
|
|
base_url="https://generativelanguage.googleapis.com/v1beta/openai/",
|
|
api_key="your-gemini-key", # Should start with AIza...
|
|
)
|
|
agent = Agent(llm=llm, ...)
|
|
```
|
|
</CodeGroup>
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## استخدام النماذج المحلية مع Ollama
|
|
|
|
للنماذج المحلية مثل تلك التي يوفرها Ollama:
|
|
|
|
<Steps>
|
|
<Step title="تحميل وتثبيت Ollama">
|
|
[انقر هنا لتحميل وتثبيت Ollama](https://ollama.com/download)
|
|
</Step>
|
|
<Step title="سحب النموذج المطلوب">
|
|
على سبيل المثال، شغّل `ollama pull llama3.2` لتحميل النموذج.
|
|
</Step>
|
|
<Step title="إعداد وكيلك">
|
|
<CodeGroup>
|
|
```python Code
|
|
agent = Agent(
|
|
role='Local AI Expert',
|
|
goal='Process information using a local model',
|
|
backstory="An AI assistant running on local hardware.",
|
|
llm=LLM(model="ollama/llama3.2", base_url="http://localhost:11434")
|
|
)
|
|
```
|
|
</CodeGroup>
|
|
</Step>
|
|
</Steps>
|
|
|
|
## تغيير عنوان URL الأساسي لـ API
|
|
|
|
يمكنك تغيير عنوان URL الأساسي لـ API لأي مزود LLM عن طريق تعيين معامل `base_url`:
|
|
|
|
```python Code
|
|
llm = LLM(
|
|
model="custom-model-name",
|
|
base_url="https://api.your-provider.com/v1",
|
|
api_key="your-api-key"
|
|
)
|
|
agent = Agent(llm=llm, ...)
|
|
```
|
|
|
|
هذا مفيد بشكل خاص عند العمل مع واجهات برمجة تطبيقات متوافقة مع OpenAI أو عندما تحتاج إلى تحديد نقطة نهاية مختلفة للمزود الذي اخترته.
|
|
|
|
## الخاتمة
|
|
|
|
من خلال الاستفادة من LiteLLM، يوفر CrewAI تكاملاً سلساً مع مجموعة واسعة من نماذج اللغة الكبيرة. تتيح لك هذه المرونة اختيار النموذج الأنسب لاحتياجاتك المحددة، سواء كنت تعطي الأولوية للأداء أو كفاءة التكلفة أو النشر المحلي. تذكر الرجوع إلى [وثائق LiteLLM](https://docs.litellm.ai/docs/) للحصول على أحدث المعلومات حول النماذج المدعومة وخيارات الإعداد.
|