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>
91 lines
3.5 KiB
Plaintext
91 lines
3.5 KiB
Plaintext
---
|
|
title: TXT RAG 검색
|
|
description: TXTSearchTool은 텍스트 파일의 내용 내에서 RAG(Retrieval-Augmented Generation) 검색을 수행하도록 설계되었습니다.
|
|
icon: file-lines
|
|
mode: "wide"
|
|
---
|
|
|
|
## 개요
|
|
|
|
<Note>
|
|
저희는 도구를 계속 개선하고 있으므로, 추후에 예기치 않은 동작이나 변경이 발생할 수 있습니다.
|
|
</Note>
|
|
|
|
이 도구는 텍스트 파일의 콘텐츠 내에서 RAG(Retrieval-Augmented Generation) 검색을 수행하는 데 사용됩니다.
|
|
지정된 텍스트 파일의 콘텐츠에서 쿼리를 의미적으로 검색할 수 있어,
|
|
제공된 쿼리를 기반으로 정보를 신속하게 추출하거나 특정 텍스트 섹션을 찾는 데 매우 유용한 리소스입니다.
|
|
|
|
## 설치
|
|
|
|
`TXTSearchTool`을 사용하려면 먼저 `crewai_tools` 패키지를 설치해야 합니다.
|
|
이 작업은 Python용 패키지 관리자 pip를 사용하여 수행할 수 있습니다.
|
|
터미널 또는 명령 프롬프트를 열고 다음 명령어를 입력하세요:
|
|
|
|
```shell
|
|
pip install 'crewai[tools]'
|
|
```
|
|
|
|
이 명령어는 TXTSearchTool과 필요한 모든 종속성을 다운로드하고 설치합니다.
|
|
|
|
## 예시
|
|
|
|
다음 예시는 TXTSearchTool을 사용하여 텍스트 파일 내에서 검색하는 방법을 보여줍니다.
|
|
이 예시는 특정 텍스트 파일로 도구를 초기화하는 방법과, 해당 파일의 내용에서 검색을 수행하는 방법을 모두 포함하고 있습니다.
|
|
|
|
```python Code
|
|
from crewai_tools import TXTSearchTool
|
|
|
|
# Initialize the tool to search within any text file's content
|
|
# the agent learns about during its execution
|
|
tool = TXTSearchTool()
|
|
|
|
# OR
|
|
|
|
# Initialize the tool with a specific text file,
|
|
# so the agent can search within the given text file's content
|
|
tool = TXTSearchTool(txt='path/to/text/file.txt')
|
|
```
|
|
|
|
## 인자
|
|
- `txt` (str): **선택 사항**입니다. 검색하려는 텍스트 파일의 경로입니다.
|
|
이 인자는 도구가 특정 텍스트 파일로 초기화되지 않은 경우에만 필요합니다;
|
|
그렇지 않은 경우 검색은 처음에 제공된 텍스트 파일 내에서 수행됩니다.
|
|
|
|
## 커스텀 모델 및 임베딩
|
|
|
|
기본적으로 이 도구는 임베딩과 요약을 위해 OpenAI를 사용합니다.
|
|
모델을 커스터마이징하려면 다음과 같이 config 딕셔너리를 사용할 수 있습니다:
|
|
|
|
```python Code
|
|
from chromadb.config import Settings
|
|
|
|
tool = TXTSearchTool(
|
|
config={
|
|
# 필수: 임베딩 제공자 + 설정
|
|
"embedding_model": {
|
|
"provider": "openai", # 또는 google-generativeai, cohere, ollama 등
|
|
"config": {
|
|
"model": "text-embedding-3-small",
|
|
# "api_key": "sk-...", # 환경변수 사용 시 생략 가능
|
|
# 공급자별 예시: Google → model: "models/embedding-001", task_type: "retrieval_document"
|
|
},
|
|
},
|
|
|
|
# 필수: 벡터DB 설정
|
|
"vectordb": {
|
|
"provider": "chromadb", # 또는 "qdrant"
|
|
"config": {
|
|
# Chroma 설정(영속성 예시)
|
|
# "settings": Settings(persist_directory="/content/chroma", allow_reset=True, is_persistent=True),
|
|
|
|
# Qdrant 벡터 파라미터 예시:
|
|
# from qdrant_client.models import VectorParams, Distance
|
|
# "vectors_config": VectorParams(size=384, distance=Distance.COSINE),
|
|
|
|
# 참고: 컬렉션 이름은 도구에서 관리합니다(기본값: "rag_tool_collection").
|
|
}
|
|
},
|
|
}
|
|
)
|
|
```
|