mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 21:28:10 +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>
196 lines
8.7 KiB
Plaintext
196 lines
8.7 KiB
Plaintext
---
|
|
title: أداة استخراج Selenium
|
|
description: أداة `SeleniumScrapingTool` مصممة لاستخراج وقراءة محتوى موقع محدد باستخدام Selenium.
|
|
icon: clipboard-user
|
|
mode: "wide"
|
|
---
|
|
|
|
# `SeleniumScrapingTool`
|
|
|
|
<Note>
|
|
هذه الأداة حالياً قيد التطوير. أثناء تحسين قدراتها، قد يواجه المستخدمون سلوكاً غير متوقع.
|
|
ملاحظاتكم لا تقدر بثمن لإجراء التحسينات.
|
|
</Note>
|
|
|
|
## الوصف
|
|
|
|
أداة `SeleniumScrapingTool` مصنوعة لمهام استخراج البيانات من الويب عالية الكفاءة.
|
|
تسمح بالاستخراج الدقيق للمحتوى من صفحات الويب باستخدام محددات CSS لاستهداف عناصر محددة.
|
|
تصميمها يخدم مجموعة واسعة من احتياجات الاستخراج، مع توفير المرونة للعمل مع أي عنوان URL مقدم.
|
|
|
|
## التثبيت
|
|
|
|
لاستخدام هذه الأداة، تحتاج إلى تثبيت حزمة أدوات CrewAI و Selenium:
|
|
|
|
```shell
|
|
pip install 'crewai[tools]'
|
|
uv add selenium webdriver-manager
|
|
```
|
|
|
|
ستحتاج أيضاً إلى تثبيت Chrome على نظامك، حيث تستخدم الأداة Chrome WebDriver لأتمتة المتصفح.
|
|
|
|
## مثال
|
|
|
|
يوضح المثال التالي كيفية استخدام `SeleniumScrapingTool` مع وكيل CrewAI:
|
|
|
|
```python Code
|
|
from crewai import Agent, Task, Crew, Process
|
|
from crewai_tools import SeleniumScrapingTool
|
|
|
|
# Initialize the tool
|
|
selenium_tool = SeleniumScrapingTool()
|
|
|
|
# Define an agent that uses the tool
|
|
web_scraper_agent = Agent(
|
|
role="Web Scraper",
|
|
goal="Extract information from websites using Selenium",
|
|
backstory="An expert web scraper who can extract content from dynamic websites.",
|
|
tools=[selenium_tool],
|
|
verbose=True,
|
|
)
|
|
|
|
# Example task to scrape content from a website
|
|
scrape_task = Task(
|
|
description="Extract the main content from the homepage of example.com. Use the CSS selector 'main' to target the main content area.",
|
|
expected_output="The main content from example.com's homepage.",
|
|
agent=web_scraper_agent,
|
|
)
|
|
|
|
# Create and run the crew
|
|
crew = Crew(
|
|
agents=[web_scraper_agent],
|
|
tasks=[scrape_task],
|
|
verbose=True,
|
|
process=Process.sequential,
|
|
)
|
|
result = crew.kickoff()
|
|
```
|
|
|
|
يمكنك أيضاً تهيئة الأداة بمعاملات محددة مسبقاً:
|
|
|
|
```python Code
|
|
# Initialize the tool with predefined parameters
|
|
selenium_tool = SeleniumScrapingTool(
|
|
website_url='https://example.com',
|
|
css_element='.main-content',
|
|
wait_time=5
|
|
)
|
|
|
|
# Define an agent that uses the tool
|
|
web_scraper_agent = Agent(
|
|
role="Web Scraper",
|
|
goal="Extract information from websites using Selenium",
|
|
backstory="An expert web scraper who can extract content from dynamic websites.",
|
|
tools=[selenium_tool],
|
|
verbose=True,
|
|
)
|
|
```
|
|
|
|
## المعاملات
|
|
|
|
تقبل أداة `SeleniumScrapingTool` المعاملات التالية أثناء التهيئة:
|
|
|
|
- **website_url**: اختياري. عنوان URL للموقع المراد استخراجه. إذا تم تقديمه أثناء التهيئة، لن يحتاج الوكيل إلى تحديده عند استخدام الأداة.
|
|
- **css_element**: اختياري. محدد CSS للعناصر المراد استخراجها. إذا تم تقديمه أثناء التهيئة، لن يحتاج الوكيل إلى تحديده عند استخدام الأداة.
|
|
- **cookie**: اختياري. قاموس يحتوي على معلومات ملفات تعريف الارتباط، مفيد لمحاكاة جلسة تسجيل دخول للوصول إلى محتوى مقيد.
|
|
- **wait_time**: اختياري. يحدد التأخير (بالثواني) قبل الاستخراج، مما يسمح للموقع وأي محتوى ديناميكي بالتحميل الكامل. الافتراضي هو `3` ثوانٍ.
|
|
- **return_html**: اختياري. ما إذا كان يجب إرجاع محتوى HTML بدلاً من النص فقط. الافتراضي هو `False`.
|
|
|
|
عند استخدام الأداة مع وكيل، سيحتاج الوكيل إلى تقديم المعاملات التالية (ما لم يتم تحديدها أثناء التهيئة):
|
|
|
|
- **website_url**: مطلوب. عنوان URL للموقع المراد استخراجه.
|
|
- **css_element**: مطلوب. محدد CSS للعناصر المراد استخراجها.
|
|
|
|
## مثال على التكامل مع الوكيل
|
|
|
|
إليك مثالاً أكثر تفصيلاً لكيفية دمج `SeleniumScrapingTool` مع وكيل CrewAI:
|
|
|
|
```python Code
|
|
from crewai import Agent, Task, Crew, Process
|
|
from crewai_tools import SeleniumScrapingTool
|
|
|
|
# Initialize the tool
|
|
selenium_tool = SeleniumScrapingTool()
|
|
|
|
# Define an agent that uses the tool
|
|
web_scraper_agent = Agent(
|
|
role="Web Scraper",
|
|
goal="Extract and analyze information from dynamic websites",
|
|
backstory="""You are an expert web scraper who specializes in extracting
|
|
content from dynamic websites that require browser automation. You have
|
|
extensive knowledge of CSS selectors and can identify the right selectors
|
|
to target specific content on any website.""",
|
|
tools=[selenium_tool],
|
|
verbose=True,
|
|
)
|
|
|
|
# Create a task for the agent
|
|
scrape_task = Task(
|
|
description="""
|
|
Extract the following information from the news website at {website_url}:
|
|
|
|
1. The headlines of all featured articles (CSS selector: '.headline')
|
|
2. The publication dates of these articles (CSS selector: '.pub-date')
|
|
3. The author names where available (CSS selector: '.author')
|
|
|
|
Compile this information into a structured format with each article's details grouped together.
|
|
""",
|
|
expected_output="A structured list of articles with their headlines, publication dates, and authors.",
|
|
agent=web_scraper_agent,
|
|
)
|
|
|
|
# Run the task
|
|
crew = Crew(
|
|
agents=[web_scraper_agent],
|
|
tasks=[scrape_task],
|
|
verbose=True,
|
|
process=Process.sequential,
|
|
)
|
|
result = crew.kickoff(inputs={"website_url": "https://news-example.com"})
|
|
```
|
|
|
|
## تفاصيل التنفيذ
|
|
|
|
تستخدم أداة `SeleniumScrapingTool` Selenium WebDriver لأتمتة تفاعلات المتصفح:
|
|
|
|
```python Code
|
|
class SeleniumScrapingTool(BaseTool):
|
|
name: str = "Read a website content"
|
|
description: str = "A tool that can be used to read a website content."
|
|
args_schema: Type[BaseModel] = SeleniumScrapingToolSchema
|
|
|
|
def _run(self, **kwargs: Any) -> Any:
|
|
website_url = kwargs.get("website_url", self.website_url)
|
|
css_element = kwargs.get("css_element", self.css_element)
|
|
return_html = kwargs.get("return_html", self.return_html)
|
|
driver = self._create_driver(website_url, self.cookie, self.wait_time)
|
|
|
|
content = self._get_content(driver, css_element, return_html)
|
|
driver.close()
|
|
|
|
return "\n".join(content)
|
|
```
|
|
|
|
تنفذ الأداة الخطوات التالية:
|
|
1. إنشاء نسخة متصفح Chrome بدون واجهة
|
|
2. التنقل إلى عنوان URL المحدد
|
|
3. الانتظار للمدة المحددة للسماح بتحميل الصفحة
|
|
4. إضافة أي ملفات تعريف ارتباط إذا تم تقديمها
|
|
5. استخراج المحتوى بناءً على محدد CSS
|
|
6. إرجاع المحتوى المستخرج كنص أو HTML
|
|
7. إغلاق نسخة المتصفح
|
|
|
|
## التعامل مع المحتوى الديناميكي
|
|
|
|
أداة `SeleniumScrapingTool` مفيدة بشكل خاص لاستخراج المواقع ذات المحتوى الديناميكي المُحمّل عبر JavaScript. باستخدام نسخة متصفح حقيقية، يمكنها:
|
|
|
|
1. تنفيذ JavaScript على الصفحة
|
|
2. انتظار تحميل المحتوى الديناميكي
|
|
3. التفاعل مع العناصر عند الحاجة
|
|
4. استخراج المحتوى الذي لن يكون متاحاً مع طلبات HTTP البسيطة
|
|
|
|
يمكنك ضبط معامل `wait_time` لضمان تحميل جميع المحتوى الديناميكي قبل الاستخراج.
|
|
|
|
## الخلاصة
|
|
|
|
توفر أداة `SeleniumScrapingTool` طريقة قوية لاستخراج المحتوى من المواقع باستخدام أتمتة المتصفح. من خلال تمكين الوكلاء من التفاعل مع المواقع كما يفعل المستخدم الحقيقي، تسهّل استخراج المحتوى الديناميكي الذي يكون صعباً أو مستحيلاً باستخدام طرق أبسط. هذه الأداة مفيدة بشكل خاص للبحث وجمع البيانات ومهام المراقبة التي تتضمن تطبيقات ويب حديثة ذات محتوى مُصيّر بـ JavaScript. |