Using an AI Agent in an xUML Service

Prerequisites

The AI agent feature is only available in a Kubernetes setup.
To use PAS AI agents, you need an AI service provider account. This is not provided by Scheer PAS. Currently, OpenAI and Mistral are supported providers.

Do not rename a service that contains an AI agent. If you do, refer to Error Handling AI Agents for help.

Using the Execute Operation in the Service

Once you have created and tested your AI agent, you can embedd it in your xUML process. As explained in detail on Creating an AI Agent, for each AI agent a default operation execute is created:

Do not rename or delete the standard operation execute and its input and output parameters.

You need to adapt the type of the input and output parameters to match your service implementation. By default, they are of type Any, but both parameters must be of a complex type. We recommend to create helper classes for the AI agents in the Implementation folder that contain the necessary properties for the agent. You can adapt the type in the attributes panel of the corresponding parameter (refer to Attributes Panel > Changing the Type of an Element for details).

Now, you can use the execute operation in execution and activity diagrams. Simply drag & drop the operation on the diagram pane:

Since the AI agent’s execute operation is a REST call, you need to apply the REST extension to the operation. Go to the operations’s attributes, select the REST Adapter extension and the corresponding AI agent alias:

You may have to reload the page to see the new pins related to the REST Adapter extension.

Mandatory Usage of “getAuthorizationOptions”

When using the AI agent operation in a model, you need to authenticate with the PAS platform. You need to set the necessary request options to the execute REST call (refer to Setting REST Request Options for details). You can do that by using the PAS platform standard operation getAuthorizationOptions that provides the necessary authentication headers.

You can find it in Base Types > PAS_Platform > Auth > AuthService:

The operation returns an instance of the RequestOptions class, with authentication header already set (contains a valid service account token). You can use the result directly as input for REST adapter calls to authenticate at the internal PAS platform services:

Related Content