mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-05 06:59:23 +00:00
a237ebabba
* 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>
112 lines
3.8 KiB
Plaintext
112 lines
3.8 KiB
Plaintext
---
|
|
title: أداة أوراق arXiv
|
|
description: تبحث `ArxivPaperTool` في arXiv عن أوراق بحثية مطابقة لاستعلام وتقوم اختيارياً بتنزيل ملفات PDF.
|
|
icon: box-archive
|
|
mode: "wide"
|
|
---
|
|
|
|
# `ArxivPaperTool`
|
|
|
|
## الوصف
|
|
|
|
تستعلم `ArxivPaperTool` من واجهة برمجة تطبيقات arXiv عن الأوراق الأكاديمية وتُرجع نتائج مختصرة وقابلة للقراءة. يمكنها أيضاً تنزيل ملفات PDF اختيارياً إلى القرص.
|
|
|
|
## التثبيت
|
|
|
|
لا تحتاج هذه الأداة إلى تثبيت خاص بخلاف `crewai-tools`.
|
|
|
|
```shell
|
|
uv add crewai-tools
|
|
```
|
|
|
|
لا يتطلب مفتاح API. تستخدم هذه الأداة واجهة Atom API العامة من arXiv.
|
|
|
|
## خطوات البدء
|
|
|
|
1. قم بتهيئة الأداة.
|
|
2. قدّم `search_query` (مثل "transformer neural network").
|
|
3. عيّن اختيارياً `max_results` (1-100) وفعّل تنزيل PDF في المُنشئ.
|
|
|
|
## مثال
|
|
|
|
```python Code
|
|
from crewai import Agent, Task, Crew
|
|
from crewai_tools import ArxivPaperTool
|
|
|
|
tool = ArxivPaperTool(
|
|
download_pdfs=False,
|
|
save_dir="./arxiv_pdfs",
|
|
use_title_as_filename=True,
|
|
)
|
|
|
|
agent = Agent(
|
|
role="Researcher",
|
|
goal="Find relevant arXiv papers",
|
|
backstory="Expert at literature discovery",
|
|
tools=[tool],
|
|
verbose=True,
|
|
)
|
|
|
|
task = Task(
|
|
description="Search arXiv for 'transformer neural network' and list top 5 results.",
|
|
expected_output="A concise list of 5 relevant papers with titles, links, and summaries.",
|
|
agent=agent,
|
|
)
|
|
|
|
crew = Crew(agents=[agent], tasks=[task])
|
|
result = crew.kickoff()
|
|
```
|
|
|
|
### الاستخدام المباشر (بدون وكيل)
|
|
|
|
```python Code
|
|
from crewai_tools import ArxivPaperTool
|
|
|
|
tool = ArxivPaperTool(
|
|
download_pdfs=True,
|
|
save_dir="./arxiv_pdfs",
|
|
)
|
|
print(tool.run(search_query="mixture of experts", max_results=3))
|
|
```
|
|
|
|
## المعاملات
|
|
|
|
### معاملات التهيئة
|
|
|
|
- `download_pdfs` (bool, الافتراضي `False`): ما إذا كان سيتم تنزيل ملفات PDF.
|
|
- `save_dir` (str, الافتراضي `./arxiv_pdfs`): المجلد لحفظ ملفات PDF.
|
|
- `use_title_as_filename` (bool, الافتراضي `False`): استخدام عناوين الأوراق كأسماء ملفات.
|
|
|
|
### معاملات التشغيل
|
|
|
|
- `search_query` (str, مطلوب): استعلام البحث في arXiv.
|
|
- `max_results` (int, الافتراضي `5`, النطاق 1-100): عدد النتائج.
|
|
|
|
## صيغة الإخراج
|
|
|
|
تُرجع الأداة قائمة أوراق قابلة للقراءة تتضمن:
|
|
- العنوان
|
|
- الرابط (صفحة الملخص)
|
|
- مقتطف/ملخص (مقتطع)
|
|
|
|
عند تعيين `download_pdfs=True`، يتم حفظ ملفات PDF على القرص ويشير الملخص إلى الملفات المحفوظة.
|
|
|
|
## ملاحظات الاستخدام
|
|
|
|
- تُرجع الأداة نصاً منسقاً مع البيانات الوصفية الرئيسية والروابط.
|
|
- عند تعيين `download_pdfs=True`، سيتم تخزين ملفات PDF في `save_dir`.
|
|
|
|
## استكشاف الأخطاء وإصلاحها
|
|
|
|
- إذا تلقيت انتهاء مهلة الشبكة، أعد المحاولة أو قلل `max_results`.
|
|
- أخطاء XML غير صالحة تشير إلى مشكلة في تحليل استجابة arXiv؛ جرب استعلاماً أبسط.
|
|
- قد تحدث أخطاء نظام الملفات (مثل رفض الصلاحية) عند حفظ ملفات PDF؛ تأكد من أن `save_dir` قابل للكتابة.
|
|
|
|
## روابط ذات صلة
|
|
|
|
- وثائق واجهة arXiv API: https://info.arxiv.org/help/api/index.html
|
|
|
|
## معالجة الأخطاء
|
|
|
|
- يتم التعامل مع مشكلات الشبكة و XML غير الصالح وأخطاء نظام التشغيل برسائل توضيحية.
|