Breadcrumbs

Step 1: Creating the AI Agent

👩‍🎓

Follow Our Example User Story

David has modeled the business process. Now he wants to create and configure the AI agent that he will use in process step 2 to handle the unstructured email data.

ACME Corp. uses OpenAI as their AI service provider, so David will use an API key from OpenAI during the configuration.

Good to Know: What is an AI Agent?

An AI agent is a system that makes decisions and takes actions automatically to accomplish tasks. We have integrated AI agents into Scheer PAS Designer so that our customers can leverage the benefits of AI agents in their BPMN-based business processes.

Integrating AI agents into your Designer processes is a strong strategy, especially when processes require contextual understanding, dynamic decision-making, or heavy data processing. The use of AI agents can lead to significant improvements in the speed, quality, and adaptability of your business processes.

Create The CaseAgent

In the Designer, AI agents are part of the service implementation. Therefore, agents are created within the Implementation folder in the service panel. We recommend to create a separate package for your AI agents.

Right click on the Implementation folder to open its context menu and create a new package, e.g. Agents:

grafik-20251202-085532.png

Open the context menu on the new package and create a new AI agent. Call it CaseAgent:

grafik-20251202-090129.png

Expand the agent’s contents in the service panel. An AI agent always contains the following elements:

  • an interface

  • an execute operation

  • an input parameter of type any

  • an output parameter of type any

grafik-20251202-090526.png

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

Configure the CaseAgent

Before you can use your new AI agent, you must first perform some basic configuration. The default execution operation is a REST call to the AI agent. Therefore, a corresponding REST alias is automatically created for each AI agent.

Good to Know: What is an alias?

Aliases are stereotyped UML artifacts. Their purpose is to link adapters with configuration settings of accessed backend systems. On the service details page you can create and manage the aliases of a service.

For more details about aliases and how to create and manage them, refer to Aliases in the Designer Guide.

Open the service details to see the CaseAgentAlias:

grafik-20251202-104856.png

The REST alias is automatically populated with the necessary input, you have nothing to do here. If you want to inspect the alias' details, use option Edit.

What we need now is a new alias for the AI service provider. Scheer PAS currently supports OpenAI and Mistral.

Please have your own API key from OpenAI or Mistral ready at this point.

Click into the blue Aliases section to create a new alias. In the pop-up, select AI Service Provider and click Next:

grafik-20251202-110930.png

In the next pop-up, do the following:

  • Enter a Name for the alias.

  • Select the Provider you want to use.

  • Select the provider Model you want to use.

  • Enter your API Key.

grafik-20251202-121134.png

Click Save to create the service provider alias. All necessary aliases have now been created:

grafik-20251202-121337.png

Define Input and Output of the CaseAgent

👩‍🎓

Follow Our Example User Story

David knows that an AI agent needs exactly one input and returns exactly one output. In the package Service he created two classes.

Class CaseRequest represents the unstructured data that insurance colleagues receive from customers:

grafik-20251202-133621.png

Class AgentResponse represents the structured data that David expects from the AI agent:

grafik-20251202-133652.png

Now he has to adjust the input and output parameters of the AI agent to match this.

In the service panel, click the input parameter, open the attributes panel, and click option Change type:

grafik-20251202-130142.png


grafik-20251202-130459.png

Change the type of the agent’s input parameter to CaseRequest:

grafik-20251202-130739.png

Next, change the type of the agent’s output parameter to AgentResponse:

grafik-20251202-130948.png

The basic configuration of the AI agent is finished.

👩‍💻

Curious about more details?

In this step you have created the AI agent and configured the necessary basics.

  • For more information about AI agents in Scheer PAS, refer to Using AI Agents and Creating an AI Agent in the Designer Guide.

  • If you want to know more about aliases, how to create and manage them, refer to Aliases in the Designer Guide.

  • On page AI Service Provider Alias you can find an overview on all settings of an AI service provider alias.