Create an Apex Agent Action
Learning Objectives
After completing this unit, you’ll be able to:
- Create an Apex Agent Action.
- Add an Agent Action to a topic.
- Test the Agent Action.
Build an Apex Agent Action
Now that the Apex is ready, let’s add it to an action. You’ll see where the parameters in the Apex automatically get ported to the action.
- Click Setup
and select Setup.
- In the Setup Quick Find box, search for and select Agentforce Assets.
- Click the Actions tab.
- Click New Agent Action.
- For Reference Action Type, select Apex.
- For Reference Action Category, select Invocable Method.
- For Reference Action, select Check Weather. This is the invocable method.
- For Agent Action Label, leave the prefill, Check Weather, that was pulled from the invocable method label parameter.
- For Agent Action API name, leave the automatically generated prefill, Check_Weather.
- Click Next.
The next step is to configure the Agent Action. This is where you start to see the benefit of the parameters being set in the Apex.
- For Agent Action Instructions, leave the prefill provided from the Apex invocable method description parameter.
- Un-check Show loading text for this action.
- For Input, notice that dateToCheck is prefilled.
- For Instructions, note that it’s prefilled with the Apex invocable variable description parameter. You can also update or add to the instructions as necessary.
- For Data Type, it’s prefilled with the Apex data type.
- Required input is defaulted to checked from the required parameter set to true.
- Check Collect data from user.
- For Outputs, there are three that got pulled from the Apex invocable variables, maxTemperature, minTemperature, and temperatureDescription. The Instructions for each are prefilled from the corresponding description parameters and Data Type.
- For the third output, temperatureDescription, check Show in conversation.
- Click Finish.
Excellent! The action is complete. You now know what it takes to add your Apex to actions. And you have a better understanding of how the Apex parameters work to help build out the action. Let’s add the Check Weather Agent Action to a topic and test it.
Update the Topic
- Click Setup
and select Setup.
- In the Setup Quick Find box, search for and select Agentforce Agents.
- Select Einstein Copilot or Agentforce (Default).
- Click Open in Builder.
- Ensure the agent is deactivated.
- Select MigrationDefaultTopic.
- Click This Topic’s Actions.
- Click New, and select Add from Asset Library.
- Check the box for the Check Weather action, and click Finish.
- Refresh your browser window and then select MigrationDefaultTopic.
- Click This Topic’s Actions and verify Check Weather action is still in the list. If it isn’t, repeat steps 8 to 11. Sometimes in our practice environments, an added action doesn’t stay associated with the topic the first time you save it.
- Click Activate.
Let’s Check the Weather
- While still in Agentforce Builder, enter
Check the weather for tomorrowin the Conversation Preview.
- Take a look at the steps the agent took and notice it selected the Check Weather action to fulfill the request.
- Want the weather forecast for next week? Enter
Check the weather for next week.
- Take a look at the steps again. The agent sent the date for each day of the week to build the response.
Well done! You’ve taken a large step toward using all of the Apex functionality your org already has and delivering it up for AI agents to use. You’ve learned some best practices and how to set parameters to get the most out of your agents.