Pipeline documentation with AI
Learn more about how you can generate pipeline documentation with AI and how the documentation is structured.
Last updated
Learn more about how you can generate pipeline documentation with AI and how the documentation is structured.
Last updated
Customers who signed a contract with Digibee before November 27, 2023 must contact support to activate this feature. For customers who signed a contract with Digibee after November 27, 2023 this feature is activated by default and they must ask to deactivate it if they wish.
The AI Generator for Pipeline Documentation uses advanced artificial intelligence techniques to analyze the flow of a pipeline and generate detailed documentation. This saves time and effort in manually creating and maintaining documentation. It also reduces the effort required to understand complex pipelines and helps with troubleshooting.
To generate the documentation, click on the Download documentation button, a download icon next to the Settings button. It may take a few seconds for the documentation to be created, but once it is created, a PDF file will be downloaded to your computer.
The documentation is created in English or Portuguese, depending on the language setting of the browser. Learn how to change the language of your Chrome browser.
OpenAI works with tokens, which are “common sequences of characters found in a set of text”. These tokens are limited depending on the model, and when they are reached, the answer is not generated.
Our AI Generator for Pipeline Documentation has a limit of 128000 tokens per request. In a pipeline, this number corresponds to approximately 500-600 components. Once these tokens are reached, the pipeline documentation is not generated and an error message is displayed on the screen.
Important information:
The tokens are shared with all Digibee accounts and reset every day.
The documentation is generated by AI and therefore hallucinations may occur. Note that empty pipelines do not generate documentation or hallucinations.
The pipeline documentation includes the following information:
The first part of the document is a description of the flow, which gives you an overview of the pipeline. The text includes the purpose of the integration and a concise description that explains how the integration is triggered and how the flow is implemented.
The External Systems Involved section lists all systems that are integrated into the pipeline. In the list you can find information about the components, such as their names, parameters, and other configurations.
The Events section lists all events that are sent within the pipeline. This allows you to track the data flow and possible problems. It also helps you to understand which other pipelines are triggered.
The Globals section lists the components associated with global variables. This helps you understand how they are used and prevents accidental misuse of global variables to ensure reliable integration.
The Accounts section documents accounts and access to credentials. This promotes best practices for security and compliance.
In the Object Store component, account identification is deactivated because it is inherent in the Digibee Integration Platform configuration.
