Package akka.javasdk.testkit

Class TestModelProvider

Object

akka.javasdk.testkit.TestModelProvider

All Implemented Interfaces:

akka.javasdk.agent.ModelProvider, akka.javasdk.agent.ModelProvider.Custom

public final class TestModelProvider
extends Object
implements akka.javasdk.agent.ModelProvider.Custom

A ModelProvider implementation for testing purposes that does not use a real AI model. It allows defining mock responses based on input predicates.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	TestModelProvider.AiResponse	Represents an AI response, which can include a message and/or list of tool invocation requests.
static final class	TestModelProvider.AutonomousAgentTools	Factory methods for TestModelProvider.ToolInvocationRequest instances that correspond to the internal tools exposed by the autonomous agent runtime to the LLM.
static interface	TestModelProvider.InputMessage	Represents an input message.
static class	TestModelProvider.MissingModelResponseException
static final record	TestModelProvider.ToolInvocationRequest	Represents a tool invocation request with a name and arguments.
static final record	TestModelProvider.ToolResult	Represents a tool result.
static final record	TestModelProvider.UserMessage	Represents a user message.
static class	TestModelProvider.WhenClause	Base class for building reply configurations for specific input predicates.
static final class	TestModelProvider.WhenToolReplyClause	Specialized reply builder for handling tool result messages.

Nested classes/interfaces inherited from interface akka.javasdk.agent.ModelProvider

akka.javasdk.agent.ModelProvider.Anthropic, akka.javasdk.agent.ModelProvider.AzureOpenAi, akka.javasdk.agent.ModelProvider.Bedrock, akka.javasdk.agent.ModelProvider.BedrockPromptCachePlacement, akka.javasdk.agent.ModelProvider.Custom, akka.javasdk.agent.ModelProvider.FromConfig, akka.javasdk.agent.ModelProvider.GoogleAIGemini, akka.javasdk.agent.ModelProvider.HuggingFace, akka.javasdk.agent.ModelProvider.LocalAI, akka.javasdk.agent.ModelProvider.MistralAi, akka.javasdk.agent.ModelProvider.Ollama, akka.javasdk.agent.ModelProvider.OpenAi, akka.javasdk.agent.ModelProvider.VertexAi

Constructor Summary

Constructors

Constructor	Description
TestModelProvider()

Method Summary

Modifier and Type	Method	Description
Object	createChatModel()
Object	createStreamingChatModel()
void	fixedResponse(TestModelProvider.AiResponse response)	Configures a fixed TestModelProvider.AiResponse for all input messages.
void	fixedResponse(TestModelProvider.ToolInvocationRequest request)	Configures a fixed tool invocation response for all input messages.
void	fixedResponse(String response)	Configures a fixed response for all input messages.
void	fixedResponse(Function<TestModelProvider.InputMessage,TestModelProvider.AiResponse> handler)	Configures a dynamic response for each input message.
String	modelName()
void	reset()	Resets all previously added response configurations.
TestModelProvider.WhenClause	whenMessage(String message)	Configures to respond when the content of an TestModelProvider.InputMessage is an exact match of the passed message.
TestModelProvider.WhenClause	whenMessage(Predicate<String> predicate)	Configures to respond when the passed string predicate matches the content of an TestModelProvider.InputMessage.
TestModelProvider.WhenToolReplyClause	whenToolResult(TestModelProvider.ToolResult toolResult)	Configures to respond when an TestModelProvider.ToolResult is an exact match of toolResult.
TestModelProvider.WhenToolReplyClause	whenToolResult(Predicate<TestModelProvider.ToolResult> predicate)	Configures to respond when the given predicate matches a TestModelProvider.ToolResult.
TestModelProvider.WhenClause	whenUserMessage(TestModelProvider.UserMessage userMessage)	Configures to respond when an TestModelProvider.UserMessage is an exact match of userMessage.
TestModelProvider.WhenClause	whenUserMessage(Predicate<TestModelProvider.UserMessage> predicate)	Configures to respond when the given predicate matches a TestModelProvider.UserMessage.
TestModelProvider	withMessageSelector(Function<List<TestModelProvider.InputMessage>,TestModelProvider.InputMessage> selector)	Configures a custom message selector that determines which input message from the current turn is passed to response predicates.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TestModelProvider

public TestModelProvider()

Method Details

modelName

public String modelName()

Specified by:

modelName in interface akka.javasdk.agent.ModelProvider.Custom

createChatModel

public Object createChatModel()

Specified by:

createChatModel in interface akka.javasdk.agent.ModelProvider.Custom

createStreamingChatModel

public Object createStreamingChatModel()

Specified by:

createStreamingChatModel in interface akka.javasdk.agent.ModelProvider.Custom

fixedResponse

public void fixedResponse(String response)

Configures a fixed response for all input messages.

fixedResponse

public void fixedResponse(TestModelProvider.AiResponse response)

Configures a fixed TestModelProvider.AiResponse for all input messages.

fixedResponse

public void fixedResponse(TestModelProvider.ToolInvocationRequest request)

Configures a fixed tool invocation response for all input messages.

fixedResponse

public void fixedResponse(Function<TestModelProvider.InputMessage,TestModelProvider.AiResponse> handler)

Configures a dynamic response for each input message.

whenMessage

public TestModelProvider.WhenClause whenMessage(Predicate<String> predicate)

Configures to respond when the passed string predicate matches the content of an TestModelProvider.InputMessage. The predicate is applied to content of TestModelProvider.UserMessage or TestModelProvider.ToolResult.

Note that to finish the configuration, you must call one of the reply methods.

whenMessage

public TestModelProvider.WhenClause whenMessage(String message)

Configures to respond when the content of an TestModelProvider.InputMessage is an exact match of the passed message.

Note that to finish the configuration, you must call one of the reply methods.

whenUserMessage

public TestModelProvider.WhenClause whenUserMessage(Predicate<TestModelProvider.UserMessage> predicate)

Configures to respond when the given predicate matches a TestModelProvider.UserMessage. The predicate is applied to TestModelProvider.UserMessage instances only.

Note that to finish the configuration, you must call one of the reply methods.

whenUserMessage

public TestModelProvider.WhenClause whenUserMessage(TestModelProvider.UserMessage userMessage)

Configures to respond when an TestModelProvider.UserMessage is an exact match of userMessage.

Note that to finish the configuration, you must call one of the reply methods.

whenToolResult

public TestModelProvider.WhenToolReplyClause whenToolResult(Predicate<TestModelProvider.ToolResult> predicate)

Configures to respond when the given predicate matches a TestModelProvider.ToolResult. The predicate is applied to TestModelProvider.ToolResult instances only.

Note that to finish the configuration, you must call one of the reply methods.

whenToolResult

public TestModelProvider.WhenToolReplyClause whenToolResult(TestModelProvider.ToolResult toolResult)

Configures to respond when an TestModelProvider.ToolResult is an exact match of toolResult.

Note that to finish the configuration, you must call one of the reply methods.

withMessageSelector

public TestModelProvider withMessageSelector(Function<List<TestModelProvider.InputMessage>,TestModelProvider.InputMessage> selector)

Configures a custom message selector that determines which input message from the current turn is passed to response predicates. The selector receives all new input messages since the last AI response (tool results and user messages) and returns the one to respond to.

The default selector picks the last message.

reset

public void reset()

Resets all previously added response configurations.