Generate an AI-Powered Integration Description

You can generate a new description or replace an existing description in an integration with a single click.

Understand the Guidelines

Note the following guidelines:

  • To configure an AI engine to generate the integration description, you must first subscribe to the engine. When you subscribe to the API engine, you receive the API key to specify.
  • There may be a limitation on the number of API key calls that can be made to the AI engine. When you reach the limit, the key becomes invalid and you receive an unauthorized key error when you attempt to generate a description. Ensure that you review your AI engine subscription documentation for more information about API key capabilities.
  • The integration for which to generate a description can be inside or outside of a project.
  • The integration description can be generated and replaced only if the integration is editable. For example, you cannot replace an integration description in an active integration.
  • You can regenerate and replace the integration description as often as you want.
  • You cannot generate and replace a description for an integration that is part of an accelerator obtained from the Integration Store.
  • Only a user with the ServiceAdministrator role can configure the AI engine to use. However, any user with the ServiceDeveloper role can generate and replace a description within the integration canvas.

Subscribe to and Configure the AI Engine to Use

  1. In the navigation pane, click Settings, then AI engines.
  2. Click Add.
  3. Enter the following information.
    Element Description
    Name

    Enter a meaningful name.

    Engine
    Select the engine to use to generate an integration description.
    • Cohere: This engine supports the command-r-plus model.
    • OpenAPI GPT-4.4.0: This engine supports the gpt-4o model.
    API Key

    Enter the LLM API key you receive when subscribing to the AI engine.

    Based on the LLM API key, the corresponding LLM API (Cohere or OpenAPI) is invoked to generate the integration description.

    Set as default engine

    Click this check box to make the selected engine the default version. Only one engine can be the default.

Generate the Integration Summary

  1. Decide where to start:
    • Work in a project.
      1. In the navigation pane, click Projects.
      2. Select the project name.
      3. Click Integrations Integrations icon.
      4. In the Integration section, click the integration for which to generate the description.
    • Work outside a project.
      1. In the navigation pane, click Design, then Integrations.
      2. Click the integration for which to generate the description.
  2. Above the integration canvas, click Primary info Primary information icon.
  3. Click Generate.

    Note:

    • If you have not configured an AI engine, an error message is displayed when you click Generate.
    • If you have reached the limit on your number of API keys, you receive an unauthorized key error.
    The Description field can be empty or already include a description.
    • If the Description field is empty, the generated integration description is added to the field.
    • If the Description field already includes a description, the updated description is displayed as a popup. For this example, a description already existed.


    An integration is displayed in the canvas. Eight icons appear in the upper left corner below the integration name. To the right of the canvas, the Properties tab and Activity report tab are shown. A View list and Save button appear in the upper right corner. Below this, four icons appear horizontally and five icons appear vertically. The Properties tab is selected to show the Name field, Identifier field, Version field, and Description field. A popup shows the latest generated description, with Retry and Replace buttons appearing at the bottom.

  4. If the Description field already includes a description, perform one of the following steps:
    1. Click Retry to regenerate the description. If you retry, the newer description varies slightly in terms of the words used, but the meaning remains the same.
    2. Click Replace to replace the current description in the Description section. Replace is only selectable if the integration is editable.
  5. Click Save.