Files
crewAI/docs/edge/ko/tools/ai-ml/aimindtool.mdx
Lucas Gomide a237ebabba feat: adopt directory-based docs versioning with Edge channel (#6202)
* 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>
2026-06-17 11:56:59 -04:00

120 lines
4.7 KiB
Plaintext

---
title: AI 마인드 툴
description: AIMindTool은 자연어로 데이터 소스를 질의하도록 설계되었습니다.
icon: brain
mode: "wide"
---
# `AIMindTool`
## 설명
`AIMindTool`은 [MindsDB](https://mindsdb.com/)에서 제공하는 [AI-Minds](https://mindsdb.com/minds)의 래퍼입니다. 이 도구를 사용하면 연결 매개변수만 구성하여 자연어로 데이터 소스를 쿼리할 수 있습니다. 이 도구는 PostgreSQL, MySQL, MariaDB, ClickHouse, Snowflake, Google BigQuery 등 다양한 데이터 소스에 저장된 데이터에서 질문에 대한 답변이 필요할 때 유용합니다.
Mind는 LLM(Large Language Model)과 유사하게 작동하는 AI 시스템이지만, 그 이상으로 모든 데이터에서 모든 질문에 답변할 수 있습니다. 이는 다음과 같이 달성됩니다:
- 파라메트릭 검색을 사용하여 답변에 가장 관련성 높은 데이터를 선택
- 의미론적 검색을 통해 의미를 이해하고 올바른 맥락에서 응답 제공
- 데이터를 분석하고 머신러닝(ML) 모델을 사용하여 정확한 답변 제공
## 설치
이 도구를 프로젝트에 통합하려면 Minds SDK를 설치해야 합니다:
```shell
uv add minds-sdk
```
## 시작 단계
`AIMindTool`을 효과적으로 사용하려면 다음 단계를 따르세요:
1. **패키지 설치**: Python 환경에 `crewai[tools]`와 `minds-sdk` 패키지가 설치되어 있는지 확인하세요.
2. **API 키 획득**: Minds 계정에 [여기](https://mdb.ai/register)에서 가입하고 API 키를 받으세요.
3. **환경 설정**: 획득한 API 키를 `MINDS_API_KEY`라는 환경 변수에 저장하여 툴이 사용할 수 있도록 하세요.
## 예시
다음 예시는 도구를 초기화하고 쿼리를 실행하는 방법을 보여줍니다:
```python Code
from crewai_tools import AIMindTool
# Initialize the AIMindTool
aimind_tool = AIMindTool(
datasources=[
{
"description": "house sales data",
"engine": "postgres",
"connection_data": {
"user": "demo_user",
"password": "demo_password",
"host": "samples.mindsdb.com",
"port": 5432,
"database": "demo",
"schema": "demo_data"
},
"tables": ["house_sales"]
}
]
)
# Run a natural language query
result = aimind_tool.run("How many 3 bedroom houses were sold in 2008?")
print(result)
```
## 매개변수
`AIMindTool`은 다음과 같은 매개변수를 허용합니다:
- **api_key**: 선택 사항입니다. 사용자의 Minds API 키입니다. 제공하지 않으면 `MINDS_API_KEY` 환경 변수에서 읽습니다.
- **datasources**: 각 항목에 다음 키를 포함하는 사전들의 목록입니다:
- **description**: 데이터 소스에 포함된 데이터에 대한 설명입니다.
- **engine**: 데이터 소스의 엔진(또는 유형)입니다.
- **connection_data**: 데이터 소스의 연결 매개변수를 포함하는 사전입니다.
- **tables**: 데이터 소스에서 사용할 테이블 목록입니다. 이 항목은 선택 사항이며, 데이터 소스의 모든 테이블을 사용할 경우 생략할 수 있습니다.
지원되는 데이터 소스와 그 연결 매개변수 목록은 [여기](https://docs.mdb.ai/docs/data_sources)에서 확인할 수 있습니다.
## 에이전트 통합 예시
다음은 `AIMindTool`을 CrewAI 에이전트와 통합하는 방법입니다:
```python Code
from crewai import Agent
from crewai.project import agent
from crewai_tools import AIMindTool
# Initialize the tool
aimind_tool = AIMindTool(
datasources=[
{
"description": "sales data",
"engine": "postgres",
"connection_data": {
"user": "your_user",
"password": "your_password",
"host": "your_host",
"port": 5432,
"database": "your_db",
"schema": "your_schema"
},
"tables": ["sales"]
}
]
)
# Define an agent with the AIMindTool
@agent
def data_analyst(self) -> Agent:
return Agent(
config=self.agents_config["data_analyst"],
allow_delegation=False,
tools=[aimind_tool]
)
```
## 결론
`AIMindTool`은 자연어를 사용하여 데이터 소스를 쿼리할 수 있는 강력한 방법을 제공하여 복잡한 SQL 쿼리를 작성하지 않고도 인사이트를 쉽게 추출할 수 있도록 해줍니다. 다양한 데이터 소스에 연결하고 AI-Minds 기술을 활용하여 이 도구는 agent들이 데이터를 효율적으로 접근하고 분석할 수 있게 해줍니다.