mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-05-06 01:32:36 +00:00
07c4a30f2e
Some checks failed
* feat(crewai-tools): add highlights to ExaSearchTool, rename from EXASearchTool - Add a highlights init param so agents can get token-efficient excerpts instead of full pages - Rename EXASearchTool to ExaSearchTool; keep EXASearchTool as a deprecated alias so existing imports keep working - Update the docs and example to use highlights as the recommended option - Add a small note that says Exa is the fastest and most accurate web search API - Add tests for the new highlights param and the deprecation alias * fix(crewai-tools): import order and module-level Exa for tests - Reorder std-lib imports so ruff is happy with force-sort-within-sections. - Import Exa at module level (with a fallback) so the existing test mocks resolve. The lazy install prompt still works if exa_py is missing. - Allow content and summary to be a dict, matching highlights. - Trim test file to the cases this PR introduces (highlights param and the EXASearchTool deprecation alias). Existing init-shape tests stay. Co-Authored-By: ishan <ishan@exa.ai> * chore(crewai-tools): drop self-explanatory comment on schema alias Co-Authored-By: ishan <ishan@exa.ai> * docs(crewai-tools): default highlights to True, drop summary from examples Co-Authored-By: ishan <ishan@exa.ai> * docs(crewai-tools): simplify highlights examples to highlights=True Co-Authored-By: ishan <ishan@exa.ai> * feat(crewai-tools): add x-exa-integration header for usage tracking Co-Authored-By: ishan <ishan@exa.ai> * docs(crewai-tools): add Exa MCP section and resources links Co-Authored-By: ishan <ishan@exa.ai> --------- Co-authored-by: ishan <ishan@exa.ai> Co-authored-by: Greyson LaLonde <greyson.r.lalonde@gmail.com> Co-authored-by: Lorenze Jay <63378463+lorenzejay@users.noreply.github.com>
137 lines
5.6 KiB
Plaintext
137 lines
5.6 KiB
Plaintext
---
|
|
title: "أداة بحث Exa"
|
|
description: "ابحث في الويب باستخدام Exa Search API للعثور على النتائج الأكثر صلة لأي استعلام، مع خيارات لمحتوى الصفحة الكامل والمقتطفات."
|
|
icon: "magnifying-glass"
|
|
mode: "wide"
|
|
---
|
|
|
|
تتيح أداة `ExaSearchTool` لوكلاء CrewAI البحث في الويب باستخدام [Exa](https://exa.ai/) search API. تُرجع النتائج الأكثر صلة لأي استعلام، مع خيارات لمحتوى الصفحة الكامل والمقتطفات الموفرة للرموز.
|
|
|
|
## التثبيت
|
|
|
|
ثبّت حزمة أدوات CrewAI:
|
|
|
|
```shell
|
|
pip install 'crewai[tools]'
|
|
```
|
|
|
|
## متغيرات البيئة
|
|
|
|
عيّن مفتاح Exa API كمتغير بيئة:
|
|
|
|
```bash
|
|
export EXA_API_KEY='your_exa_api_key'
|
|
```
|
|
|
|
احصل على مفتاح API من [لوحة تحكم Exa](https://dashboard.exa.ai/api-keys).
|
|
|
|
## مثال على الاستخدام
|
|
|
|
إليك كيفية استخدام `ExaSearchTool` مع وكيل CrewAI:
|
|
|
|
```python
|
|
import os
|
|
from crewai import Agent, Task, Crew
|
|
from crewai_tools import ExaSearchTool
|
|
|
|
# Initialize the tool
|
|
exa_tool = ExaSearchTool()
|
|
|
|
# Create an agent that uses the tool
|
|
researcher = Agent(
|
|
role='Research Analyst',
|
|
goal='Find the latest information on any topic',
|
|
backstory='An expert researcher who finds the most relevant and up-to-date information.',
|
|
tools=[exa_tool],
|
|
verbose=True
|
|
)
|
|
|
|
# Create a task for the agent
|
|
research_task = Task(
|
|
description='Find the top 3 recent breakthroughs in quantum computing.',
|
|
expected_output='A summary of the top 3 breakthroughs with source URLs.',
|
|
agent=researcher
|
|
)
|
|
|
|
# Form the crew and kick it off
|
|
crew = Crew(
|
|
agents=[researcher],
|
|
tasks=[research_task],
|
|
verbose=True
|
|
)
|
|
|
|
result = crew.kickoff()
|
|
print(result)
|
|
```
|
|
|
|
## خيارات التكوين
|
|
|
|
تقبل أداة `ExaSearchTool` المعاملات التالية أثناء التهيئة:
|
|
|
|
- `type` (str، اختياري): نوع البحث المستخدم. الافتراضي هو `"auto"`. الخيارات: `"auto"`، `"instant"`، `"fast"`، `"deep"`.
|
|
- `highlights` (bool أو dict، اختياري): إرجاع مقتطفات موفرة للرموز أكثر صلة بالاستعلام بدلاً من الصفحة الكاملة. الافتراضي هو `True`. مرر قاموسًا مثل `{"max_characters": 4000}` للتكوين، أو `False` للتعطيل.
|
|
- `content` (bool، اختياري): ما إذا كان يجب تضمين محتوى الصفحة الكامل في النتائج. الافتراضي هو `False`.
|
|
- `api_key` (str، اختياري): مفتاح Exa API الخاص بك. يعود إلى متغير البيئة `EXA_API_KEY` إذا لم يتم تقديمه.
|
|
- `base_url` (str، اختياري): عنوان URL مخصص لخادم API. يعود إلى متغير البيئة `EXA_BASE_URL` إذا لم يتم تقديمه.
|
|
|
|
عند استدعاء الأداة (أو عندما يستدعيها وكيل)، تتوفر معاملات البحث التالية:
|
|
|
|
- `search_query` (str): **مطلوب**. سلسلة استعلام البحث.
|
|
- `start_published_date` (str، اختياري): تصفية النتائج المنشورة بعد هذا التاريخ (تنسيق ISO 8601، مثل `"2024-01-01"`).
|
|
- `end_published_date` (str، اختياري): تصفية النتائج المنشورة قبل هذا التاريخ (تنسيق ISO 8601).
|
|
- `include_domains` (list[str]، اختياري): قائمة بالنطاقات لتقييد البحث عليها.
|
|
|
|
## الاستخدام المتقدم
|
|
|
|
يمكنك تكوين الأداة بمعاملات مخصصة للحصول على نتائج أغنى:
|
|
|
|
```python
|
|
# Use 'deep' for thorough, multi-step searches
|
|
exa_tool = ExaSearchTool(
|
|
highlights=True,
|
|
type="deep"
|
|
)
|
|
|
|
# Use it in an agent
|
|
agent = Agent(
|
|
role="Deep Researcher",
|
|
goal="Conduct thorough research",
|
|
tools=[exa_tool]
|
|
)
|
|
```
|
|
|
|
## استخدام Exa عبر MCP
|
|
|
|
يمكنك أيضًا ربط وكيلك بخادم MCP المستضاف من Exa. مرّر مفتاح API الخاص بك عبر ترويسة `x-api-key`:
|
|
|
|
```python
|
|
from crewai import Agent
|
|
from crewai.mcp import MCPServerHTTP
|
|
|
|
agent = Agent(
|
|
role="Research Analyst",
|
|
goal="Find and analyze information on the web",
|
|
backstory="Expert researcher with access to Exa's tools",
|
|
mcps=[
|
|
MCPServerHTTP(
|
|
url="https://mcp.exa.ai/mcp",
|
|
headers={"x-api-key": "YOUR_EXA_API_KEY"},
|
|
),
|
|
],
|
|
)
|
|
```
|
|
|
|
احصل على مفتاح API من [لوحة تحكم Exa](https://dashboard.exa.ai/api-keys). لمزيد من المعلومات حول MCP في CrewAI، راجع [نظرة عامة على MCP](/ar/mcp/overview).
|
|
|
|
## الميزات
|
|
|
|
- **مقتطفات موفرة للرموز**: الحصول على المقتطفات الأكثر صلة من كل نتيجة، باستخدام رموز أقل بكثير من النص الكامل
|
|
- **البحث الدلالي**: العثور على نتائج بناءً على المعنى، وليس الكلمات المفتاحية فقط
|
|
- **استرجاع المحتوى الكامل**: الحصول على النص الكامل لصفحات الويب مع نتائج البحث
|
|
- **تصفية التاريخ**: تقييد النتائج لفترات زمنية محددة باستخدام فلاتر تاريخ النشر
|
|
- **تصفية النطاقات**: تقييد عمليات البحث على نطاقات محددة
|
|
|
|
## موارد
|
|
|
|
- [توثيق Exa](https://exa.ai/docs)
|
|
- [لوحة تحكم Exa — إدارة مفاتيح API والاستخدام](https://dashboard.exa.ai) |