mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-02 05:38:12 +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>
174 lines
5.2 KiB
Plaintext
174 lines
5.2 KiB
Plaintext
---
|
|
title: RAG 도구
|
|
description: RagTool은 Retrieval-Augmented Generation을 사용하여 질문에 답변하는 동적 지식 기반 도구입니다.
|
|
icon: vector-square
|
|
mode: "wide"
|
|
---
|
|
|
|
# `RagTool`
|
|
|
|
## 설명
|
|
|
|
`RagTool`은 EmbedChain을 통한 RAG(Retrieval-Augmented Generation)의 강력함을 활용하여 질문에 답하도록 설계되었습니다.
|
|
이는 다양한 데이터 소스에서 관련 정보를 검색할 수 있는 동적 지식 기반을 제공합니다.
|
|
이 도구는 방대한 정보에 접근해야 하고 맥락에 맞는 답변을 제공해야 하는 애플리케이션에 특히 유용합니다.
|
|
|
|
## 예시
|
|
|
|
다음 예시는 도구를 초기화하고 다양한 데이터 소스와 함께 사용하는 방법을 보여줍니다:
|
|
|
|
```python Code
|
|
from crewai_tools import RagTool
|
|
|
|
# Create a RAG tool with default settings
|
|
rag_tool = RagTool()
|
|
|
|
# Add content from a file
|
|
rag_tool.add(data_type="file", path="path/to/your/document.pdf")
|
|
|
|
# Add content from a web page
|
|
rag_tool.add(data_type="web_page", url="https://example.com")
|
|
|
|
# Define an agent with the RagTool
|
|
@agent
|
|
def knowledge_expert(self) -> Agent:
|
|
'''
|
|
This agent uses the RagTool to answer questions about the knowledge base.
|
|
'''
|
|
return Agent(
|
|
config=self.agents_config["knowledge_expert"],
|
|
allow_delegation=False,
|
|
tools=[rag_tool]
|
|
)
|
|
```
|
|
|
|
## 지원되는 데이터 소스
|
|
|
|
`RagTool`은 다양한 데이터 소스와 함께 사용할 수 있습니다. 예를 들어:
|
|
|
|
- 📰 PDF 파일
|
|
- 📊 CSV 파일
|
|
- 📃 JSON 파일
|
|
- 📝 텍스트
|
|
- 📁 디렉터리/폴더
|
|
- 🌐 HTML 웹 페이지
|
|
- 📽️ YouTube 채널
|
|
- 📺 YouTube 동영상
|
|
- 📚 문서화 웹사이트
|
|
- 📝 MDX 파일
|
|
- 📄 DOCX 파일
|
|
- 🧾 XML 파일
|
|
- 📬 Gmail
|
|
- 📝 GitHub 저장소
|
|
- 🐘 PostgreSQL 데이터베이스
|
|
- 🐬 MySQL 데이터베이스
|
|
- 🤖 Slack 대화
|
|
- 💬 Discord 메시지
|
|
- 🗨️ Discourse 포럼
|
|
- 📝 Substack 뉴스레터
|
|
- 🐝 Beehiiv 콘텐츠
|
|
- 💾 Dropbox 파일
|
|
- 🖼️ 이미지
|
|
- ⚙️ 사용자 정의 데이터 소스
|
|
|
|
## 매개변수
|
|
|
|
`RagTool`은 다음과 같은 매개변수를 허용합니다:
|
|
|
|
- **summarize**: 선택 사항. 검색된 콘텐츠를 요약할지 여부입니다. 기본값은 `False`입니다.
|
|
- **adapter**: 선택 사항. 지식 베이스에 대한 사용자 지정 어댑터입니다. 제공되지 않은 경우 EmbedchainAdapter가 사용됩니다.
|
|
- **config**: 선택 사항. 내부 EmbedChain App의 구성입니다.
|
|
|
|
## 콘텐츠 추가
|
|
|
|
`add` 메서드를 사용하여 지식 베이스에 콘텐츠를 추가할 수 있습니다:
|
|
|
|
```python Code
|
|
# PDF 파일 추가
|
|
rag_tool.add(data_type="file", path="path/to/your/document.pdf")
|
|
|
|
# 웹 페이지 추가
|
|
rag_tool.add(data_type="web_page", url="https://example.com")
|
|
|
|
# YouTube 비디오 추가
|
|
rag_tool.add(data_type="youtube_video", url="https://www.youtube.com/watch?v=VIDEO_ID")
|
|
|
|
# 파일이 있는 디렉터리 추가
|
|
rag_tool.add(data_type="directory", path="path/to/your/directory")
|
|
```
|
|
|
|
## 에이전트 통합 예시
|
|
|
|
아래는 `RagTool`을 CrewAI 에이전트와 통합하는 방법입니다:
|
|
|
|
```python Code
|
|
from crewai import Agent
|
|
from crewai.project import agent
|
|
from crewai_tools import RagTool
|
|
|
|
# Initialize the tool and add content
|
|
rag_tool = RagTool()
|
|
rag_tool.add(data_type="web_page", url="https://docs.crewai.com")
|
|
rag_tool.add(data_type="file", path="company_data.pdf")
|
|
|
|
# Define an agent with the RagTool
|
|
@agent
|
|
def knowledge_expert(self) -> Agent:
|
|
return Agent(
|
|
config=self.agents_config["knowledge_expert"],
|
|
allow_delegation=False,
|
|
tools=[rag_tool]
|
|
)
|
|
```
|
|
|
|
## 고급 구성
|
|
|
|
`RagTool`의 동작을 구성 사전을 제공하여 사용자 지정할 수 있습니다.
|
|
|
|
```python Code
|
|
from crewai_tools import RagTool
|
|
|
|
# 사용자 지정 구성으로 RAG 도구 생성
|
|
config = {
|
|
"app": {
|
|
"name": "custom_app",
|
|
},
|
|
"llm": {
|
|
"provider": "openai",
|
|
"config": {
|
|
"model": "gpt-4",
|
|
}
|
|
},
|
|
"embedding_model": {
|
|
"provider": "openai",
|
|
"config": {
|
|
"model": "text-embedding-ada-002"
|
|
}
|
|
},
|
|
"vectordb": {
|
|
"provider": "elasticsearch",
|
|
"config": {
|
|
"collection_name": "my-collection",
|
|
"cloud_id": "deployment-name:xxxx",
|
|
"api_key": "your-key",
|
|
"verify_certs": False
|
|
}
|
|
},
|
|
"chunker": {
|
|
"chunk_size": 400,
|
|
"chunk_overlap": 100,
|
|
"length_function": "len",
|
|
"min_chunk_size": 0
|
|
}
|
|
}
|
|
|
|
rag_tool = RagTool(config=config, summarize=True)
|
|
```
|
|
|
|
내부 RAG 도구는 Embedchain 어댑터를 사용하므로 Embedchain에서 지원하는 모든 구성 옵션을 전달할 수 있습니다.
|
|
자세한 내용은 [Embedchain 문서](https://docs.embedchain.ai/components/introduction)를 참조하세요.
|
|
.yaml 파일에서 제공되는 구성 옵션을 반드시 검토하시기 바랍니다.
|
|
|
|
## 결론
|
|
`RagTool`은 다양한 데이터 소스에서 지식 베이스를 생성하고 질의할 수 있는 강력한 방법을 제공합니다. Retrieval-Augmented Generation을 활용하여, 에이전트가 관련 정보를 효율적으로 접근하고 검색할 수 있게 하여, 보다 정확하고 상황에 맞는 응답을 제공하는 능력을 향상시킵니다.
|