Creating a connector by using generative AI (experimental feature)

Instead of creating connector objects and actions from scratch, you can use generative AI powered by IBM watsonx to create different objects and associated actions for your connector. When you provide the URL to the API documentation page of the connector that you are going to work with inside Connector Development Kit, the generative AI crawls through the page and scrapes information from the URL, thereby generating paths and methods. As generate connector using AI is an experimental feature, there is a possibility that it might not work as intended for some connectors.

To create a connector with the help of generative AI, complete the following steps:

1. Log in to your Connector Development Kit instance.

2. On the Connector Development Kit home page, click Create a connector.

   The Create a connector page is displayed.

3. From the 'Import or discover' view, select Generate connector using AI, then click Next.

4. From the 'Add connector metadata' view:

   1. Enter a name for the application and optionally add a description.
   2. In the Category field, select a category for your connector. Categories are used to filter connectors when they are published to IBM Automation Explorer.
   3. In the image section, click the Edit icon to add an image for your connector or use the default app image that is provided by the Connector Development Kit.
   4. Specify a version for your connector. For more information, see Connector versioning.

5. Click Next.

6. In the 'Discover operations' view, provide one or more API documentation URLs linked to the operation you want to create actions with (for example, https://developers.example.com/application/api/v1/users).

   Tip: Use Add URL + to add multiple API documentation URLs. You can add a total of five API documentation URLs at a time.

7. Click the Discover operations button to detect operations from the specified API documentation URLs with the help of generative AI.

   

8. Click Next.

   In the 'Select operations' view, a list of HTTP methods along with their respective paths is displayed.

   

9. Choose the operations that you want to use as actions for your connector, then click Next.

   Note: When you are generating the connector document from the selected operations, if the generative AI encounters errors in the application's API documentation, an extra view called 'Fix OpenAPI specification errors' is displayed. In this view, you can make the necessary manual corrections to the errors to continue with the process. If no errors are found, you are redirected directly to the 'Generated Actions' view.

   In the 'Generated actions' view, you can see a list of available objects and associated actions that are created from the selected operations by using generative AI.

   

10. Click Create.

    The Actions tab for the newly created connector containing the generated objects and actions is displayed.

11. If necessary, in the Actions tab, add more details to further customize your actions. For more information, see Configuring actions.

    Note: It is recommended to independently verify each object and action that is generated by AI.

12. If necessary, add polled events for your connector by using the Events tab. For more information, see Configuring polled events.

13. In the Connection properties tab, complete the form to configure the connection properties for your connector. For more information about how to configure connection properties, see Configuring connections.

14. In the Schema tab, create the schema and configure parameters. For more information, see Configuring schemas.

15. Test the new actions and polled events that you created by using the Test actions and Test events tab. For more information, see Testing a connector.