mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 13:18:10 +00:00
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>
168 lines
4.3 KiB
Plaintext
168 lines
4.3 KiB
Plaintext
---
|
|
title: MongoDB 벡터 검색 도구
|
|
description: MongoDBVectorSearchTool은(는) 선택적인 인덱싱 도우미와 함께 MongoDB Atlas에서 벡터 검색을 수행합니다.
|
|
icon: "leaf"
|
|
mode: "wide"
|
|
---
|
|
|
|
# `MongoDBVectorSearchTool`
|
|
|
|
## 설명
|
|
|
|
MongoDB Atlas 컬렉션에서 벡터 유사성 쿼리를 수행합니다. 인덱스 생성 도우미 및 임베디드 텍스트의 일괄 삽입을 지원합니다.
|
|
|
|
MongoDB Atlas는 네이티브 벡터 검색을 지원합니다. 자세히 알아보기:
|
|
https://www.mongodb.com/docs/atlas/atlas-vector-search/vector-search-overview/
|
|
|
|
## 설치
|
|
|
|
MongoDB 추가 기능과 함께 설치하세요:
|
|
|
|
```shell
|
|
pip install crewai-tools[mongodb]
|
|
```
|
|
|
|
또는
|
|
|
|
```shell
|
|
uv add crewai-tools --extra mongodb
|
|
```
|
|
|
|
## 파라미터
|
|
|
|
### 초기화
|
|
|
|
- `connection_string` (str, 필수)
|
|
- `database_name` (str, 필수)
|
|
- `collection_name` (str, 필수)
|
|
- `vector_index_name` (str, 기본값 `vector_index`)
|
|
- `text_key` (str, 기본값 `text`)
|
|
- `embedding_key` (str, 기본값 `embedding`)
|
|
- `dimensions` (int, 기본값 `1536`)
|
|
|
|
### 실행 매개변수
|
|
|
|
- `query` (str, 필수): 임베드 및 검색할 자연어 쿼리.
|
|
|
|
## 빠른 시작
|
|
|
|
```python Code
|
|
from crewai_tools import MongoDBVectorSearchTool
|
|
|
|
tool = MongoDBVectorSearchTool(
|
|
connection_string="mongodb+srv://...",
|
|
database_name="mydb",
|
|
collection_name="docs",
|
|
)
|
|
|
|
print(tool.run(query="how to create vector index"))
|
|
```
|
|
|
|
## 인덱스 생성 도우미
|
|
|
|
`create_vector_search_index(...)`를 사용하여 올바른 차원과 유사성을 가진 Atlas Vector Search 인덱스를 프로비저닝하세요.
|
|
|
|
## 일반적인 문제
|
|
|
|
- 인증 실패: Atlas IP 액세스 목록에 러너가 허용되어 있는지 확인하고, 연결 문자열에 자격 증명이 포함되어 있는지 확인하세요.
|
|
- 인덱스를 찾을 수 없음: 벡터 인덱스를 먼저 생성하세요; 이름이 `vector_index_name`과 일치해야 합니다.
|
|
- 차원 불일치: 임베딩 모델의 차원을 `dimensions`와 일치시켜야 합니다.
|
|
|
|
## 추가 예시
|
|
|
|
### 기본 초기화
|
|
|
|
```python Code
|
|
from crewai_tools import MongoDBVectorSearchTool
|
|
|
|
tool = MongoDBVectorSearchTool(
|
|
database_name="example_database",
|
|
collection_name="example_collection",
|
|
connection_string="<your_mongodb_connection_string>",
|
|
)
|
|
```
|
|
|
|
### 사용자 지정 쿼리 구성
|
|
|
|
```python Code
|
|
from crewai_tools import MongoDBVectorSearchConfig, MongoDBVectorSearchTool
|
|
|
|
query_config = MongoDBVectorSearchConfig(limit=10, oversampling_factor=2)
|
|
tool = MongoDBVectorSearchTool(
|
|
database_name="example_database",
|
|
collection_name="example_collection",
|
|
connection_string="<your_mongodb_connection_string>",
|
|
query_config=query_config,
|
|
vector_index_name="my_vector_index",
|
|
)
|
|
|
|
rag_agent = Agent(
|
|
name="rag_agent",
|
|
role="You are a helpful assistant that can answer questions with the help of the MongoDBVectorSearchTool.",
|
|
goal="...",
|
|
backstory="...",
|
|
tools=[tool],
|
|
)
|
|
```
|
|
|
|
### 데이터베이스 미리 로드 및 인덱스 생성
|
|
|
|
```python Code
|
|
import os
|
|
from crewai_tools import MongoDBVectorSearchTool
|
|
|
|
tool = MongoDBVectorSearchTool(
|
|
database_name="example_database",
|
|
collection_name="example_collection",
|
|
connection_string="<your_mongodb_connection_string>",
|
|
)
|
|
|
|
# Load text content from a local folder and add to MongoDB
|
|
texts = []
|
|
for fname in os.listdir("knowledge"):
|
|
path = os.path.join("knowledge", fname)
|
|
if os.path.isfile(path):
|
|
with open(path, "r", encoding="utf-8") as f:
|
|
texts.append(f.read())
|
|
|
|
tool.add_texts(texts)
|
|
|
|
# Create the Atlas Vector Search index (e.g., 3072 dims for text-embedding-3-large)
|
|
tool.create_vector_search_index(dimensions=3072)
|
|
```
|
|
|
|
## 예시
|
|
|
|
```python Code
|
|
from crewai import Agent, Task, Crew
|
|
from crewai_tools import MongoDBVectorSearchTool
|
|
|
|
tool = MongoDBVectorSearchTool(
|
|
connection_string="mongodb+srv://...",
|
|
database_name="mydb",
|
|
collection_name="docs",
|
|
)
|
|
|
|
agent = Agent(
|
|
role="RAG Agent",
|
|
goal="Answer using MongoDB vector search",
|
|
backstory="Knowledge retrieval specialist",
|
|
tools=[tool],
|
|
verbose=True,
|
|
)
|
|
|
|
task = Task(
|
|
description="Find relevant content for 'indexing guidance'",
|
|
expected_output="A concise answer citing the most relevant matches",
|
|
agent=agent,
|
|
)
|
|
|
|
crew = Crew(
|
|
agents=[agent],
|
|
tasks=[task],
|
|
verbose=True,
|
|
)
|
|
|
|
result = crew.kickoff()
|
|
```
|