How to use IBM App Connect with IBM watsonx.ai

IBM watsonx.ai is part of IBM's AI and data platform. Use IBM watsonx.ai to work with generative AI and traditional machine learning models, which provide tools to build and refine models for your specific needs. IBM watsonx.ai offers various models, including options from IBM, open source models, and the ability to use your own.

Availability:

App Connect Enterprise as a Service connector
Local connector in containers (Continuous Delivery release) 12.0.12.3-r1 or later

Supported product and API versions

To find out which product and API versions this connector supports, see Detailed System Requirements on the IBM Support page.

Connecting to IBM watsonx.ai

Complete the connection fields that you see in the App Connect Designer Connect > Applications and APIs page or flow editor. If necessary, work with your IBM watsonx.ai administrator to obtain these values.

IBM watsonx.ai connection fields: Set the Server URLto the URL for the API server that makes runtime calls.; Set the API key to the API key that you use to access IBM watsonx.ai.; Set Allow self-signed certificates to be true or false. Set this field to true to be able to accept self-signed certificates that are trusted and used only in a nonproduction environment. The default is false.; Specify the Override server URL if you want to connect to an endpoint in a private network by using the private network client, or to override the server URL. Specify an override value for the host and port for the connector in the format <http or https>://<host_name>:<port>. If you are not using the private network client or do not require an override, leave this field blank.; Private network connection Select the name of a private network connection that App Connect uses to connect to your private network. This list is populated with the names of private network connections that are created from the Private network connections page in the Designer instance. You see this field only if a switch server is configured for this Designer instance. For more information, see Connecting to a private network from App Connect Designer. (In App Connect Designer 12.0.10.0-r1 or earlier instances that include this field, the display name is shown as Agent name.)

To obtain the connection values for IBM watsonx.ai, see Obtaining connection values for IBM watsonx.ai.

To connect to a IBM watsonx.ai endpoint from the App Connect Designer Applications and APIs page for the first time, expand IBM watsonx.ai, then click Connect.

Tip:

Before you use the account that is created in App Connect in a flow, rename the account to something meaningful that helps you to identify it. To rename the account on the Applications and APIs page, select the account, open its options menu (⋮), then click Rename Account.

General Considerations

Before you use App Connect Designer with IBM watsonx.ai, take note of the following considerations:

You can see lists of the trigger events and actions that are available on the Applications and APIs page of the App Connect Designer.
For some applications, the events and actions depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.
If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.

Post connection considerations

Take note of the following consideration after you are connected to IBM watsonx.ai.

To know more about IBM watsonx.ai plans and pricing, see watsonx pricing.
To know more about the regional availability of foundation models, see Regional availability for services and features on IBM Cloud on the IBM watsonx documentation page.

Events and Actions

Note: Events are not available for changes in this application. You can trigger a flow in other ways, such as at a scheduled interval or at specific dates and times.

Your flow completes these actions on this application.

Object	Action	Description
Email	Generate email template	Generates text content to support the creation of emails
Foundation models	Retrieve available foundation models by version	Retrieves the list of deployed foundation models
Foundation models	Retrieve supported tasks by version	Retrieves the list of tasks that the foundation models support
Sentiment analysis	Classify sentiment	Classify your sentiment into positive, negative, and neutral. It also shows you how inclined it is toward each sentiment.
Sentiment analysis	Modify tone of sentiment	Changes the tone of sentiment and makes your sentence less negative
Summary	Generate summary	Transforms text with domain-specific content into personalized overviews, capturing key points. For example, sales conversation summaries, insurance coverage, meeting transcripts, and contract information.
Text embeddings	Generate embeddings	Generates embeddings from text input
Text generation	Generate text	Infer the next tokens for a given deployed model with a set of parameters
Tokenization	Generate tokens	Use this operation to check the conversion of provided input to tokens for a particular model

Examples

Dashboard tile for a template that uses IBM watsonx.ai

Use templates to quickly create flows for IBM watsonx.ai

Learn how to use App Connect templates to quickly create flows that complete actions on IBM watsonx.ai. For example, open the Templates gallery, and then search for IBM watsonx ai.

Learn more

Use IBM App Connect to build flows that integrate with IBM watsonx.ai.

The following blog post describes how to summarize open leads from Salesforce by using IBM watsonx.ai. The post then describes how to send an email or SMS notification about upcoming offers for Shopify customers by using text from IBM watsonx.ai.

Read the blog