mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-04 22:49:23 +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>
119 lines
4.5 KiB
Plaintext
119 lines
4.5 KiB
Plaintext
---
|
|
title: AI Mind Tool
|
|
description: O `AIMindTool` foi desenvolvido para consultar fontes de dados em linguagem natural.
|
|
icon: brain
|
|
mode: "wide"
|
|
---
|
|
|
|
# `AIMindTool`
|
|
|
|
## Descrição
|
|
|
|
O `AIMindTool` é um wrapper em torno do [AI-Minds](https://mindsdb.com/minds) fornecido pela [MindsDB](https://mindsdb.com/). Ele permite que você consulte fontes de dados em linguagem natural, bastando configurar os parâmetros de conexão. Essa ferramenta é útil quando você precisa de respostas para perguntas utilizando dados armazenados em diversas fontes, incluindo PostgreSQL, MySQL, MariaDB, ClickHouse, Snowflake e Google BigQuery.
|
|
|
|
Minds são sistemas de IA que funcionam de forma similar aos grandes modelos de linguagem (LLMs), mas vão além ao responder qualquer pergunta sobre qualquer dado. Isso é realizado por meio de:
|
|
- Seleção dos dados mais relevantes para a resposta utilizando busca paramétrica
|
|
- Compreensão do significado e fornecimento de respostas dentro do contexto correto através de busca semântica
|
|
- Entrega de respostas precisas ao analisar dados e utilizar modelos de machine learning (ML)
|
|
|
|
## Instalação
|
|
|
|
Para incorporar esta ferramenta ao seu projeto, é necessário instalar o Minds SDK:
|
|
|
|
```shell
|
|
uv add minds-sdk
|
|
```
|
|
|
|
## Passos para Começar
|
|
|
|
Para utilizar o `AIMindTool` de maneira eficaz, siga estes passos:
|
|
|
|
1. **Instalação de Pacotes**: Verifique se os pacotes `crewai[tools]` e `minds-sdk` estão instalados no seu ambiente Python.
|
|
2. **Obtenção da Chave de API**: Cadastre-se para uma conta Minds [aqui](https://mdb.ai/register) e obtenha uma chave de API.
|
|
3. **Configuração do Ambiente**: Armazene sua chave de API obtida em uma variável de ambiente chamada `MINDS_API_KEY` para facilitar seu uso pela ferramenta.
|
|
|
|
## Exemplo
|
|
|
|
O exemplo a seguir demonstra como inicializar a ferramenta e executar uma consulta:
|
|
|
|
```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)
|
|
```
|
|
|
|
## Parâmetros
|
|
|
|
O `AIMindTool` aceita os seguintes parâmetros:
|
|
|
|
- **api_key**: Opcional. Sua chave de API da Minds. Se não for fornecida, será lida da variável de ambiente `MINDS_API_KEY`.
|
|
- **datasources**: Uma lista de dicionários, cada um contendo as seguintes chaves:
|
|
- **description**: Uma descrição dos dados contidos na fonte de dados.
|
|
- **engine**: O engine (ou tipo) da fonte de dados.
|
|
- **connection_data**: Um dicionário contendo os parâmetros de conexão da fonte de dados.
|
|
- **tables**: Uma lista de tabelas que a fonte de dados irá utilizar. Isso é opcional e pode ser omitido caso todas as tabelas da fonte de dados devam ser utilizadas.
|
|
|
|
Uma lista das fontes de dados suportadas e seus parâmetros de conexão pode ser encontrada [aqui](https://docs.mdb.ai/docs/data_sources).
|
|
|
|
## Exemplo de Integração com Agente
|
|
|
|
Veja como integrar o `AIMindTool` com um agente 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]
|
|
)
|
|
```
|
|
|
|
## Conclusão
|
|
|
|
O `AIMindTool` oferece uma forma poderosa de consultar suas fontes de dados utilizando linguagem natural, facilitando a extração de insights sem a necessidade de escrever consultas SQL complexas. Ao conectar diversas fontes de dados e aproveitar a tecnologia AI-Minds, essa ferramenta permite que agentes acessem e analisem dados de maneira eficiente. |