Automating the Extended Documentation with OpenAI

World of Workflows makes integrating with OpenAI very easy. When you have multiple workflows to document, you might consider writing a workflow to do this.

Sample workflow

We have written this sample workflow for you to implement. There are a few minor editing steps needed to make it work in your environment.

Prerequisites

This sample workflow uses these Plugins

  • OpenAI
  • Utilities

Additionally, you need

Implement the sample workflow

  1. Install the plugins and restart your instance
  2. Import the sample workflow . See here for instructions.
  3. Import the Settings and update for your environment.
    • WFDocumentorChatCredentialName => the name of your ChatGPT credentials
    • WFDocumentorHost => Your fully-qualified host name, such as https://wowcrm.worldofworkflows.com
    • WFDocumentorOutputLocation => where you want the intermediate markdown files created on your server. eg /data/docs

Run the workflow

This workflow demonstrates starting the workflow by HTTP call. You will run it via https://yourhost.azurewebsites.net/documentWorkfow
or
https://localhost:7063/documentWorkfow

This will use the ‘single’ functionality of the workflow.

You can also include a url parameter /?action=multi to work on all of the workflows in your instance.


Table of contents


Copyright © 2023-2024 World of Workflows.