mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-05 06:59:23 +00:00
a237ebabba
* 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>
180 lines
5.4 KiB
Plaintext
180 lines
5.4 KiB
Plaintext
---
|
|
title: "Ativar Crew Studio"
|
|
description: "Ativando o Crew Studio no CrewAI AMP"
|
|
icon: "comments"
|
|
mode: "wide"
|
|
---
|
|
|
|
<Tip>
|
|
Crew Studio é uma poderosa ferramenta **no-code/low-code** que permite criar
|
|
ou estruturar Crews rapidamente por meio de uma interface conversacional.
|
|
</Tip>
|
|
|
|
## O que é o Crew Studio?
|
|
|
|
O Crew Studio é uma forma inovadora de criar equipes de agentes de IA sem escrever código.
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
Com o Crew Studio, você pode:
|
|
|
|
- Conversar com o Crew Assistant para descrever seu problema
|
|
- Gerar automaticamente agentes e tarefas
|
|
- Selecionar as ferramentas apropriadas
|
|
- Configurar os inputs necessários
|
|
- Gerar código para download e personalização
|
|
- Fazer deploy diretamente na plataforma CrewAI AMP
|
|
|
|
## Etapas de Configuração
|
|
|
|
Antes de começar a usar o Crew Studio, você precisa configurar suas conexões LLM:
|
|
|
|
<Steps>
|
|
<Step title="Configurar a Conexão LLM">
|
|
Acesse a aba **LLM Connections** no painel do CrewAI AMP e crie uma nova conexão LLM.
|
|
|
|
<Note>
|
|
Sinta-se à vontade para utilizar qualquer provedor LLM suportado pelo CrewAI.
|
|
</Note>
|
|
|
|
Configure sua conexão LLM:
|
|
|
|
- Insira um `Connection Name` (por exemplo, `OpenAI`)
|
|
- Selecione o provedor do modelo: `openai` ou `azure`
|
|
- Selecione os modelos que deseja usar em suas Crews geradas pelo Studio
|
|
- Recomendamos pelo menos `gpt-4o`, `o1-mini` e `gpt-4o-mini`
|
|
- Adicione sua chave de API como uma variável de ambiente:
|
|
- Para OpenAI: adicione `OPENAI_API_KEY` com sua chave de API
|
|
- Para Azure OpenAI: consulte [este artigo](https://blog.crewai.com/configuring-azure-openai-with-crewai-a-comprehensive-guide/) para detalhes de configuração
|
|
- Clique em `Add Connection` para salvar sua configuração
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
</Step>
|
|
|
|
<Step title="Verificar Conexão Adicionada">
|
|
Assim que concluir a configuração, você verá sua nova conexão adicionada à lista de conexões disponíveis.
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
</Step>
|
|
|
|
<Step title="Configurar Padrões do LLM">
|
|
No menu principal, vá em **Settings → Defaults** e configure as opções padrão do LLM:
|
|
|
|
- Selecione os modelos padrão para agentes e outros componentes
|
|
- Defina as configurações padrão para o Crew Studio
|
|
|
|
Clique em `Save Settings` para aplicar as alterações.
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
</Step>
|
|
</Steps>
|
|
|
|
## Usando o Crew Studio
|
|
|
|
Agora que você configurou sua conexão LLM e os padrões, está pronto para começar a usar o Crew Studio!
|
|
|
|
<Steps>
|
|
<Step title="Acessar o Studio">
|
|
Navegue até a seção **Studio** no painel do CrewAI AMP.
|
|
</Step>
|
|
|
|
<Step title="Iniciar uma Conversa">
|
|
Inicie uma conversa com o Crew Assistant descrevendo o problema que deseja resolver:
|
|
|
|
```md
|
|
I need a crew that can research the latest AI developments and create a summary report.
|
|
```
|
|
|
|
O Crew Assistant fará perguntas de esclarecimento para entender melhor suas necessidades.
|
|
|
|
</Step>
|
|
|
|
<Step title="Revisar o Crew Gerado">
|
|
Revise a configuração do crew gerado, incluindo:
|
|
|
|
- Agentes e seus papéis
|
|
- Tarefas a serem realizadas
|
|
- Inputs necessários
|
|
- Ferramentas a serem utilizadas
|
|
|
|
Esta é sua oportunidade para refinar a configuração antes de prosseguir.
|
|
|
|
</Step>
|
|
|
|
<Step title="Fazer Deploy ou Baixar">
|
|
Quando estiver satisfeito com a configuração, você pode:
|
|
|
|
- Baixar o código gerado para personalização local
|
|
- Fazer deploy do crew diretamente na plataforma CrewAI AMP
|
|
- Modificar a configuração e gerar o crew novamente
|
|
|
|
</Step>
|
|
|
|
<Step title="Testar seu Crew">
|
|
Após o deploy, teste seu crew com inputs de exemplo para garantir que ele funcione conforme esperado.
|
|
</Step>
|
|
</Steps>
|
|
|
|
<Tip>
|
|
Para melhores resultados, forneça descrições claras e detalhadas do que deseja
|
|
que seu crew realize. Inclua inputs específicos e outputs esperados em sua
|
|
descrição.
|
|
</Tip>
|
|
|
|
## Exemplo de Fluxo de Trabalho
|
|
|
|
Veja um fluxo de trabalho típico para criação de um crew com o Crew Studio:
|
|
|
|
<Steps>
|
|
<Step title="Descreva seu Problema">
|
|
Comece descrevendo seu problema:
|
|
|
|
```md
|
|
I need a crew that can analyze financial news and provide investment recommendations
|
|
```
|
|
|
|
</Step>
|
|
|
|
<Step title="Responder Perguntas">
|
|
Responda às perguntas de esclarecimento do Crew Assistant para refinar seus
|
|
requisitos.
|
|
</Step>
|
|
|
|
<Step title="Revisar o Plano">
|
|
Revise o plano do crew gerado, que pode incluir:
|
|
|
|
- Um Research Agent para coletar notícias financeiras
|
|
- Um Analysis Agent para interpretar os dados
|
|
- Um Recommendations Agent para fornecer conselhos de investimento
|
|
|
|
</Step>
|
|
|
|
<Step title="Aprovar ou Modificar">
|
|
Aprove o plano ou solicite alterações, se necessário.
|
|
</Step>
|
|
|
|
<Step title="Baixar ou Fazer Deploy">
|
|
Baixe o código para personalização ou faça o deploy diretamente na plataforma.
|
|
</Step>
|
|
|
|
<Step title="Testar e Refinar">
|
|
Teste seu crew com inputs de exemplo e faça ajustes conforme necessário.
|
|
</Step>
|
|
</Steps>
|
|
|
|
<Card title="Precisa de ajuda?" icon="headset" href="mailto:support@crewai.com">
|
|
Entre em contato com nossa equipe de suporte para obter assistência com o Crew
|
|
Studio ou qualquer outro recurso do CrewAI AMP.
|
|
</Card>
|