Documentação de pipelines com IA

Saiba mais sobre como você pode gerar documentação de pipeline com IA e como a documentação é estruturada.

Clientes que assinaram contrato com a Digibee antes de 27 de novembro de 2023 devem entrar em contato com o suporte para ativar esse recurso. Para clientes que assinaram contrato com a Digibee após 27 de novembro de 2023, este recurso é ativado por padrão e eles devem pedir para desativá-lo, se desejarem. Por favor, leia os Termos de uso para funcionalidades de IA.

O Gerador de Documentação de Pipeline com IA usa técnicas avançadas de inteligência artificial para analisar o fluxo de um pipeline e gerar documentação detalhada. Isso economiza tempo e esforço na criação e manutenção manual de documentação. Também reduz o esforço necessário para compreender pipelines complexos e ajuda na solução de problemas.

Como gerar a documentação

Para gerar a documentação, clique no botão Download da documentação, um ícone de download próximo ao botão Configurações. A criação da documentação pode demorar alguns segundos, mas uma vez criada, um arquivo PDF será baixado para o seu computador.

A documentação será criada em português ou inglês, dependendo do idioma configurada no navegador. Aprenda como mudar o idioma do navegador Chrome.

Restrições na geração da documentação

A OpenAI trabalha com tokens, que são "sequências comuns de caracteres encontradas em um conjunto de texto". Esses tokens são limitados dependendo do modelo e, quando atingidos, a resposta não é gerada.

Nosso Gerador de Documentação de Pipeline com IA tem um limite de 128.000 tokens. Em um pipeline, esse número corresponde a aproximadamente 500-600 componentes. Uma vez que esses tokens são atingidos, a documentação do pipeline não é gerada, e uma mensagem de erro é exibida na tela.

Os tokens são compartilhados por todas as contas da Digibee e são redefinidos diariamente.

Estrutura da documentação

A documentação do pipeline inclui as seguintes informações:

Descrição do fluxo

A primeira parte do documento é uma descrição do fluxo, que fornece uma visão geral do pipeline. O texto inclui a finalidade da integração e uma descrição concisa que explica como a integração é acionada e como o fluxo é implementado.

External Systems Involved

A seção External Systems Involved lista todos os sistemas integrados ao pipeline. Na lista você encontra informações sobre os componentes, como nomes, parâmetros e outras configurações.

Events

A seção Events lista todos os eventos enviados no pipeline. Isso permite você acompanhar o fluxo de dados e possíveis problemas. Também ajuda você a entender quais outros pipelines são acionados.

Globals

A seção Globals lista os componentes associados a variáveis ​​globais. Isso ajuda você a entender como elas são usadas e evita o uso indevido acidental de variáveis ​​globais para garantir uma integração confiável.

Accounts

A seção Accounts documenta contas e acesso a credenciais. Isso promove práticas recomendadas de segurança e conformidade.

No componente Object Store a identificação da conta está desativada por ser inerente à configuração da Digibee Integration Platform.