mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-05 15:09:22 +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>
173 lines
6.0 KiB
Plaintext
173 lines
6.0 KiB
Plaintext
---
|
|
title: Integração Microsoft Word
|
|
description: "Criação e gerenciamento de documentos com integração Microsoft Word para CrewAI."
|
|
icon: "file-word"
|
|
mode: "wide"
|
|
---
|
|
|
|
## Visão Geral
|
|
|
|
Permita que seus agentes criem, leiam e gerenciem documentos do Word e arquivos de texto no OneDrive ou SharePoint. Automatize a criação de documentos, recupere conteúdo, gerencie propriedades de documentos e simplifique seus fluxos de trabalho de documentos com automação alimentada por IA.
|
|
|
|
## Pré-requisitos
|
|
|
|
Antes de usar a integração Microsoft Word, certifique-se de ter:
|
|
|
|
- Uma conta [CrewAI AMP](https://app.crewai.com) com assinatura ativa
|
|
- Uma conta Microsoft com acesso ao Word e OneDrive/SharePoint
|
|
- Conectado sua conta Microsoft através da [página de Integrações](https://app.crewai.com/crewai_plus/connectors)
|
|
|
|
## Configurando a Integração Microsoft Word
|
|
|
|
### 1. Conecte sua Conta Microsoft
|
|
|
|
1. Navegue para [Integrações CrewAI AMP](https://app.crewai.com/crewai_plus/connectors)
|
|
2. Encontre **Microsoft Word** na seção de Integrações de Autenticação
|
|
3. Clique em **Conectar** e complete o fluxo OAuth
|
|
4. Conceda as permissões necessárias para acesso a arquivos
|
|
5. Copie seu Token Enterprise das [Configurações de Integração](https://app.crewai.com/crewai_plus/settings/integrations)
|
|
|
|
### 2. Instale o Pacote Necessário
|
|
|
|
```bash
|
|
uv add crewai-tools
|
|
```
|
|
|
|
### 3. Configuração de variável de ambiente
|
|
|
|
<Note>
|
|
Para usar integrações com `Agent(apps=[])`, você deve definir a variável de
|
|
ambiente `CREWAI_PLATFORM_INTEGRATION_TOKEN` com seu Enterprise Token.
|
|
</Note>
|
|
|
|
```bash
|
|
export CREWAI_PLATFORM_INTEGRATION_TOKEN="seu_enterprise_token"
|
|
```
|
|
|
|
Ou adicione ao seu arquivo `.env`:
|
|
|
|
```
|
|
CREWAI_PLATFORM_INTEGRATION_TOKEN=seu_enterprise_token
|
|
```
|
|
|
|
## Ações Disponíveis
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="microsoft_word/get_documents">
|
|
**Descrição:** Obter todos os documentos do Word do OneDrive ou SharePoint.
|
|
|
|
**Parâmetros:**
|
|
- `select` (string, opcional): Selecionar propriedades específicas para retornar.
|
|
- `filter` (string, opcional): Filtrar resultados usando sintaxe OData.
|
|
- `expand` (string, opcional): Expandir recursos relacionados inline.
|
|
- `top` (integer, opcional): Número de itens a retornar (mín 1, máx 999).
|
|
- `orderby` (string, opcional): Ordenar resultados por propriedades especificadas.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_word/create_text_document">
|
|
**Descrição:** Criar um documento de texto (.txt) com conteúdo. RECOMENDADO para criação de conteúdo programático que precisa ser legível e editável.
|
|
|
|
**Parâmetros:**
|
|
- `file_name` (string, obrigatório): Nome do documento de texto (deve terminar com .txt).
|
|
- `content` (string, opcional): Conteúdo de texto para o documento. Padrão: "Este é um novo documento de texto criado via API."
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_word/get_document_content">
|
|
**Descrição:** Obter o conteúdo de um documento (funciona melhor com arquivos de texto).
|
|
|
|
**Parâmetros:**
|
|
- `file_id` (string, obrigatório): O ID do documento.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_word/get_document_properties">
|
|
**Descrição:** Obter propriedades e metadados de um documento.
|
|
|
|
**Parâmetros:**
|
|
- `file_id` (string, obrigatório): O ID do documento.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_word/delete_document">
|
|
**Descrição:** Excluir um documento.
|
|
|
|
**Parâmetros:**
|
|
- `file_id` (string, obrigatório): O ID do documento a excluir.
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_word/copy_document">
|
|
**Descrição:** Copiar um documento para um novo local no OneDrive.
|
|
|
|
**Parâmetros:**
|
|
- `file_id` (string, obrigatório): O ID do documento a copiar.
|
|
- `name` (string, opcional): Novo nome para o documento copiado.
|
|
- `parent_id` (string, opcional): O ID da pasta de destino (padrão: raiz).
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="microsoft_word/move_document">
|
|
**Descrição:** Mover um documento para um novo local no OneDrive.
|
|
|
|
**Parâmetros:**
|
|
- `file_id` (string, obrigatório): O ID do documento a mover.
|
|
- `parent_id` (string, obrigatório): O ID da pasta de destino.
|
|
- `name` (string, opcional): Novo nome para o documento movido.
|
|
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## Exemplos de Uso
|
|
|
|
### Configuração Básica do Agente Microsoft Word
|
|
|
|
```python
|
|
from crewai import Agent, Task, Crew
|
|
|
|
# Crie um agente com capacidades do Microsoft Word
|
|
word_agent = Agent(
|
|
role="Gerenciador de Documentos",
|
|
goal="Gerenciar documentos do Word e arquivos de texto de forma eficiente",
|
|
backstory="Um assistente IA especializado em operações de documentos do Microsoft Word e gerenciamento de conteúdo.",
|
|
apps=['microsoft_word'] # Todas as ações do Word estarão disponíveis
|
|
)
|
|
|
|
# Tarefa para criar um novo documento de texto
|
|
create_doc_task = Task(
|
|
description="Criar um novo documento de texto chamado 'notas_reuniao.txt' com conteúdo 'Notas da Reunião de Janeiro de 2024: Pontos-chave de discussão e itens de ação.'",
|
|
agent=word_agent,
|
|
expected_output="Novo documento de texto 'notas_reuniao.txt' criado com sucesso."
|
|
)
|
|
|
|
# Execute a tarefa
|
|
crew = Crew(
|
|
agents=[word_agent],
|
|
tasks=[create_doc_task]
|
|
)
|
|
|
|
crew.kickoff()
|
|
```
|
|
|
|
## Solução de Problemas
|
|
|
|
### Problemas Comuns
|
|
|
|
**Erros de Autenticação**
|
|
|
|
- Certifique-se de que sua conta Microsoft tenha as permissões necessárias para acesso a arquivos (ex: `Files.Read.All`, `Files.ReadWrite.All`).
|
|
- Verifique se a conexão OAuth inclui todos os escopos necessários.
|
|
|
|
**Problemas de Criação de Arquivos**
|
|
|
|
- Ao criar documentos de texto, certifique-se de que o `file_name` termine com extensão `.txt`.
|
|
- Verifique se você tem permissões de escrita no local de destino (OneDrive/SharePoint).
|
|
|
|
### Obtendo Ajuda
|
|
|
|
<Card title="Precisa de Ajuda?" icon="headset" href="mailto:support@crewai.com">
|
|
Entre em contato com nossa equipe de suporte para assistência com configuração
|
|
ou solução de problemas da integração Microsoft Word.
|
|
</Card>
|