Test an Agent with Agentforce DX

This section describes the legacy process for testing Agentforce agents, or the pro-code equivalent to using the Legacy Agentforce Testing Center in Setup. It doesn’t apply to the new agent testing process, or the pro-code equivalent to the New Testing Center in Agentforce Studio (Beta). That documentation will be released soon.

Warning

Testing an agent entails sending it questions, statements, or commands (utterances) and then making sure that the agent behaves as you expected when it responds.

Flow of Pro-Code Agent Testing

Using Agentforce DX to test an agent is the pro-code equivalent of using the Agentforce Testing Center UI in your development org. As with any software development, testing an agent is an iterative process. Here’s the general flow, and later sections of this guide go into details about some steps.

Generate a test spec for your agent with the agent generate test-spec CLI command. A test spec is a local YAML file that describes one or more test cases for your agent.
Customize the generated YAML test spec file. Add more testing items to the test spec file, such as setting context variables and including out-of-the-box metrics in the test output.
Create the agent test in your development org with the agent test create command, passing it the test spec file. This command also automatically syncs the associated metadata back to your DX project.
Run the agent tests in your development org and view the results with the agent test run command. You can also use the VS Code agent testing panel to view and run the tests.
If your tests all pass, then you’re all set! But if tests fail, use the VS Code Agent Preview pane or the agent preview CLI command to chat with the agent and test the utterances and responses in a conversational way. When using VS Code Agent Preview, you can also easily invoke the Apex Replay Debugger to debug Apex classes that implement actions. Then use all the information you gathered to fine-tune your agent instructions, actions, or subagents.
Iterate as needed over the preceding steps until you’ve perfected your set of agent tests. Then use the test results to update your agent to work correctly.
Add the tests to a continuous integration (CI) system to make sure that your agent continues to work correctly in the future.

Test an Agent with Agentforce DX

Flow of Pro-Code Agent Testing

See Also