Skip to main content

Integrate Nexla with OpenAI

Enrich resource documentation catalog by integrating OpenAI with Nexla.

Once an organization member with Nexla administrator status links and activates OpenAI App Integration in Nexla, all members of the organization will have the ability to efficiently add thorough AI-generated documentation to Nexsets and data flows.

This article provides instructions for the one-time integration setup process performed by an organization administrator in Section 1. Section 2 covers how to use OpenAI to generate resource documentation in Nexla.

1. Set Up & Activate OpenAI App Integration​

Integrating OpenAI and Nexla creates a link between the organization's Nexla account and the OpenAI API. Once this integration is enabled, organization members can utilize OpenAI to easily generate recommended documentation for Nexsets and data flows with the click of a button.

The steps in Sections 1.1-1.4 must be completed by an organization administrator.

1.1 OpenAI Configuration Information​

The following information about the organization's OpenAI account is needed to configure OpenAI integration in Nexla.

info

This information must be obtained from the OpenAI UI by an OpenAI account aministrator.

  • OpenAI Token – This is the API key for the organization OpenAI account.

    • See this OpenAI article to learn where to find the API key in the organiation's OpenAI account.

  • OpenAI Model – Determine the OpenAI text-generation model that will be used to generate resource documentation in the Nexla account.

    • Information about the different OpenAI models can be found in the articles on this OpenAI page.

1.2 Create an OpenAI Credential in Nexla​

info

The steps in this section must be performed in the Nexla UI by a Nexla organization administrator.

  1. Log into Nexla as an organization administrator, and select settings.png from the toolbar on the left.

      Settings2.png

  2. Select AppIntegrations.png from the Settings toolbar.

      AppIntegrations2.png

  3. In the App Integrations screen, select the Gen AI Integrations tab.

      GenAI_Int.png

  4. Click Configure on the OpenAI tile to open the integration configuration drawer.

      Config.png

  5. In the configuration drawer, enter a name for the OpenAI credential that will be used to authenticate the OpenAI account in the Credential Name field.

    • A credential name that will be meaningful for bookkeeping is recommended.

      CredName.png

  6. Enter a meaningful short description of the credential in the Credential Description field.

      CredDesc.png

  7. Enter the API key for the OpenAI account obtained in Section 1.1 in the OpenAI Token field.

      Token.png

  8. Click Authenticate.png to authenticate the credential information.

      Authenticate2.png

    • If the entered information is correct, authentication should result in the creation of a new credential with name and description entered in the previous step, along with a button providing the option to edit the credential.

        Credential.png

1.3 Configure OpenAI Model Settings​

info

The steps in this section must be performed in the Nexla UI by a Nexla organization administrator.

Any of the OpenAI text-generation models available to the OpenAI account corresponding to the credential created in Section 1.2 can be used to generate resource documentation in Nexla. To learn more about the different avaialable OpenAI models, see the articles linked on this OpenAI page.

  1. Select the model that will be used to generate resource documentation text in organization accounts from the OpenAI Model pulldown menu.

      OpenAI_Model.png

    note

    The selected model will be used to generate resource documentation when the Generate option is used by any member of the organization.

    This selection can be changed by a Nexla account administrator from within the configuration drawer at any time.

1.4 Activate the OpenAI Integration​

info

The steps in this section must be performed in the Nexla UI by a Nexla organization administrator.

  1. Click the Close.png in the top right corner of the configuration drawer to close it.

  2. Turn on the toggle switch on the OpenAI tile to activate OpenAI app integration for the organization's Nexla account.

    • OpenAI integration with the Nexla account can be paused at any time by turning off this switch.

      Activate.png

2. Generate Documentation with OpenAI​

Once the organization administrator has configured and activated OpenAI app integration in Nexla, all organization members will be able to generate resource documentation using OpenAI by following the instructions in this section.

  1. Access the information drawer of the resource.

    • Data Flows: Click the DataFlowInfo.png icon on the data flow listing.

        DataFlowInfo2.png

    • Nexsets: Click the Details.png icon on the Nexset.

        NexsetInfo.png

  2. The resource documentation field is located at the top of the Overview tab. Click the Generate.png button to generate documentation for the resource using OpenAI.

      Generate2.png

  3. A preview of the generated text is displayed within the documentation field. Any needed changes to the text can be made in this field before saving.

      Preview.png

    • To view a side-by-side comparison of text modifications, click ViewMod.png in the bottom right corner below the text field.

      ViewMod2.png

    • To reject all changes to the text:

      • In the resource information screen, click the Discard.png button in the bottom-right corner of the text field.

      • In the side-by-side comparison screen, click Cancel.png in the bottom-right corner of the pop-up.

  4. To save the resource documentation text:

    • In the side-by-side comparison pop-up, click the Accept.png button in the bottom-right corner.

        Accept2.png

    • In the resource information drawer, click SaveText.png in the bottom-right corner below the text field.

        SaveText2.png