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>
148 lines
4.7 KiB
Plaintext
148 lines
4.7 KiB
Plaintext
---
|
|
title: أداة LlamaIndex
|
|
description: أداة `LlamaIndexTool` هي غلاف لأدوات ومحركات استعلام LlamaIndex.
|
|
icon: address-book
|
|
mode: "wide"
|
|
---
|
|
|
|
# `LlamaIndexTool`
|
|
|
|
## الوصف
|
|
|
|
صُممت `LlamaIndexTool` لتكون غلافاً عاماً حول أدوات ومحركات استعلام LlamaIndex، مما يتيح لك الاستفادة من موارد LlamaIndex من حيث خطوط أنابيب RAG/الوكيلية كأدوات للتوصيل بوكلاء CrewAI. تتيح لك هذه الأداة دمج قدرات معالجة واسترجاع البيانات القوية من LlamaIndex في سير عمل CrewAI بسلاسة.
|
|
|
|
## التثبيت
|
|
|
|
لاستخدام هذه الأداة، تحتاج إلى تثبيت LlamaIndex:
|
|
|
|
```shell
|
|
uv add llama-index
|
|
```
|
|
|
|
## خطوات البدء
|
|
|
|
لاستخدام `LlamaIndexTool` بفعالية، اتبع الخطوات التالية:
|
|
|
|
1. **تثبيت LlamaIndex**: ثبّت حزمة LlamaIndex باستخدام الأمر أعلاه.
|
|
2. **إعداد LlamaIndex**: اتبع [وثائق LlamaIndex](https://docs.llamaindex.ai/) لإعداد خط أنابيب RAG/وكيلي.
|
|
3. **إنشاء أداة أو محرك استعلام**: أنشئ أداة أو محرك استعلام LlamaIndex تريد استخدامه مع CrewAI.
|
|
|
|
## مثال
|
|
|
|
توضح الأمثلة التالية كيفية تهيئة الأداة من مكونات LlamaIndex مختلفة:
|
|
|
|
### من أداة LlamaIndex
|
|
|
|
```python Code
|
|
from crewai_tools import LlamaIndexTool
|
|
from crewai import Agent
|
|
from llama_index.core.tools import FunctionTool
|
|
|
|
# Example 1: Initialize from FunctionTool
|
|
def search_data(query: str) -> str:
|
|
"""Search for information in the data."""
|
|
# Your implementation here
|
|
return f"Results for: {query}"
|
|
|
|
# Create a LlamaIndex FunctionTool
|
|
og_tool = FunctionTool.from_defaults(
|
|
search_data,
|
|
name="DataSearchTool",
|
|
description="Search for information in the data"
|
|
)
|
|
|
|
# Wrap it with LlamaIndexTool
|
|
tool = LlamaIndexTool.from_tool(og_tool)
|
|
|
|
# Define an agent that uses the tool
|
|
@agent
|
|
def researcher(self) -> Agent:
|
|
'''
|
|
This agent uses the LlamaIndexTool to search for information.
|
|
'''
|
|
return Agent(
|
|
config=self.agents_config["researcher"],
|
|
tools=[tool]
|
|
)
|
|
```
|
|
|
|
### من أدوات LlamaHub
|
|
|
|
```python Code
|
|
from crewai_tools import LlamaIndexTool
|
|
from llama_index.tools.wolfram_alpha import WolframAlphaToolSpec
|
|
|
|
# Initialize from LlamaHub Tools
|
|
wolfram_spec = WolframAlphaToolSpec(app_id="your_app_id")
|
|
wolfram_tools = wolfram_spec.to_tool_list()
|
|
tools = [LlamaIndexTool.from_tool(t) for t in wolfram_tools]
|
|
```
|
|
|
|
### من محرك استعلام LlamaIndex
|
|
|
|
```python Code
|
|
from crewai_tools import LlamaIndexTool
|
|
from llama_index.core import VectorStoreIndex
|
|
from llama_index.core.readers import SimpleDirectoryReader
|
|
|
|
# Load documents
|
|
documents = SimpleDirectoryReader("./data").load_data()
|
|
|
|
# Create an index
|
|
index = VectorStoreIndex.from_documents(documents)
|
|
|
|
# Create a query engine
|
|
query_engine = index.as_query_engine()
|
|
|
|
# Create a LlamaIndexTool from the query engine
|
|
query_tool = LlamaIndexTool.from_query_engine(
|
|
query_engine,
|
|
name="Company Data Query Tool",
|
|
description="Use this tool to lookup information in company documents"
|
|
)
|
|
```
|
|
|
|
## طرق الفئة
|
|
|
|
توفر `LlamaIndexTool` طريقتي فئة رئيسيتين لإنشاء المثيلات:
|
|
|
|
### from_tool
|
|
|
|
تنشئ `LlamaIndexTool` من أداة LlamaIndex.
|
|
|
|
```python Code
|
|
@classmethod
|
|
def from_tool(cls, tool: Any, **kwargs: Any) -> "LlamaIndexTool":
|
|
# Implementation details
|
|
```
|
|
|
|
### from_query_engine
|
|
|
|
تنشئ `LlamaIndexTool` من محرك استعلام LlamaIndex.
|
|
|
|
```python Code
|
|
@classmethod
|
|
def from_query_engine(
|
|
cls,
|
|
query_engine: Any,
|
|
name: Optional[str] = None,
|
|
description: Optional[str] = None,
|
|
return_direct: bool = False,
|
|
**kwargs: Any,
|
|
) -> "LlamaIndexTool":
|
|
# Implementation details
|
|
```
|
|
|
|
## المعاملات
|
|
|
|
تقبل طريقة `from_query_engine` المعاملات التالية:
|
|
|
|
- **query_engine**: مطلوب. محرك استعلام LlamaIndex المراد تغليفه.
|
|
- **name**: اختياري. اسم الأداة.
|
|
- **description**: اختياري. وصف الأداة.
|
|
- **return_direct**: اختياري. ما إذا كان يتم إرجاع الاستجابة مباشرة. القيمة الافتراضية `False`.
|
|
|
|
## الخلاصة
|
|
|
|
توفر `LlamaIndexTool` طريقة قوية لدمج قدرات LlamaIndex في وكلاء CrewAI. من خلال تغليف أدوات ومحركات استعلام LlamaIndex، تمكّن الوكلاء من الاستفادة من وظائف استرجاع ومعالجة البيانات المتطورة، مما يعزز قدرتهم على التعامل مع مصادر المعلومات المعقدة.
|