agents-test/ai.koog.agents.testing.tools/MockLLMBuilder

MockLLMBuilder

class MockLLMBuilder(clock: Clock, tokenizer: Tokenizer? = null)(source)

Builder class for creating mock LLM executors for testing.

This class provides a fluent API for configuring mock responses for LLM requests and tool calls. It allows you to define how the LLM should respond to different inputs and how tools should behave when called during testing.

Example usage:

val mockLLMApi = getMockExecutor(toolRegistry) {
    // Mock LLM text responses
    mockLLMAnswer("Hello!") onRequestContains "Hello"
    mockLLMAnswer("I don't know how to answer that.").asDefaultResponse

    // Mock LLM tool calls
    mockLLMToolCall(CreateTool, CreateTool.Args("solve")) onRequestEquals "Solve task"

    // Mock tool behavior
    mockTool(PositiveToneTool) alwaysReturns "The text has a positive tone."
    mockTool(NegativeToneTool) alwaysTells {
        println("Negative tone tool called")
        "The text has a negative tone."
    }
}

Constructors

MockLLMBuilder

constructor(clock: Clock, tokenizer: Tokenizer? = null)

Types

MixedResultsReceiver

class MixedResultsReceiver<Args : ToolArgs>(toolCalls: List<Pair<Tool<Args, *>, Args>>, responses: List<String>, builder: MockLLMBuilder)

Represents a class responsible for handling and managing mixed tool call results based on mock responses and predefined configurations.

MockToolReceiver

class MockToolReceiver<Args : ToolArgs, Result : ToolResult>(tool: Tool<Args, Result>, builder: MockLLMBuilder)

Receiver class for configuring tool behavior during testing.

MultiToolCallReceiver

class MultiToolCallReceiver<Args : ToolArgs>(toolCalls: List<Pair<Tool<Args, *>, Args>>, builder: MockLLMBuilder)

Receiver class for configuring tool call responses from the LLM. This class is part of the fluent API for configuring how the LLM should respond with tool calls when it receives specific inputs.

ToolCallReceiver

class ToolCallReceiver<Args : ToolArgs>(tool: Tool<Args, *>, args: Args, toolCallId: String?, builder: MockLLMBuilder)

Receiver class for configuring tool call responses from the LLM.

Properties

handleLastAssistantMessage

var handleLastAssistantMessage: Boolean

Determines whether the last message handled in a sequence should focus specifically on the most recent message categorized as Message.Assistant when resolving mock responses.

Functions

addLLMAnswerExactPattern

fun <Args : ToolArgs> addLLMAnswerExactPattern(pattern: String, toolCalls: List<Pair<Tool<Args, *>, Args>>)

Adds an exact pattern match for an LLM answer that triggers a set of tool calls.

fun <Args : ToolArgs> addLLMAnswerExactPattern(pattern: String, toolCalls: List<Pair<Tool<Args, *>, Args>>, responses: List<String>)

Adds an exact pattern match for an LLM answer that triggers a set of tool calls with predefined responses.

fun <Args : ToolArgs> addLLMAnswerExactPattern(pattern: String, tool: Tool<Args, *>, args: Args, toolCallId: String?)

Adds an exact pattern match for an LLM answer that triggers a tool call.

addLLMAnswerPartialPattern

fun <Args : ToolArgs> addLLMAnswerPartialPattern(pattern: String, toolCalls: List<Pair<Tool<Args, *>, Args>>)

Adds a partial pattern match for an LLM answer that triggers a set of tool calls.

fun <Args : ToolArgs> addLLMAnswerPartialPattern(pattern: String, tool: Tool<Args, *>, args: Args)

Adds a partial pattern match for an LLM answer that triggers a tool call.

fun <Args : ToolArgs> addLLMAnswerPartialPattern(pattern: String, toolCalls: List<Pair<Tool<Args, *>, Args>>, responses: List<String>)

Adds a partial pattern match for an LLM answer that triggers a set of tool calls with predefined responses.

addModerationResponseExactPattern

fun <Args : ToolArgs> addModerationResponseExactPattern(pattern: String, response: ModerationResult)

Adds a specific moderation response for an exact pattern match.

addModerationResponsePartialPattern

fun <Args : ToolArgs> addModerationResponsePartialPattern(pattern: String, response: ModerationResult)

Associates a given moderation response with a specific partial pattern.

addToolAction

fun <Args : ToolArgs, Result : ToolResult> addToolAction(tool: Tool<Args, Result>, argsCondition: suspend (Args) -> Boolean = { true }, action: suspend (Args) -> Result)

Adds a tool action to be executed when a tool call matches the specified condition.

alwaysReturns

infix fun <Args : ToolArgs> MockLLMBuilder.MockToolReceiver<Args, ToolResult.Text>.alwaysReturns(response: String)

Convenience extension function for configuring a text tool to always return the specified string.

alwaysTells

infix fun <Args : ToolArgs> MockLLMBuilder.MockToolReceiver<Args, ToolResult.Text>.alwaysTells(action: suspend () -> String)

Convenience extension function for configuring a text tool to always execute the specified action and return its string result.

build

fun build(): PromptExecutor

Builds and returns a PromptExecutor configured with the mock responses and tool actions.

doesStr

infix fun <Args : ToolArgs> MockLLMBuilder.MockToolReceiver<Args, ToolResult.Text>.doesStr(action: suspend () -> String): MockLLMBuilder.MockToolReceiver.MockToolResponseBuilder<Args, ToolResult.Text>

Convenience extension function for configuring a text tool to execute the specified action and return its string result when it receives matching arguments.

mockLLMMixedResponse

fun <Args : ToolArgs> mockLLMMixedResponse(toolCalls: List<Pair<Tool<Args, *>, Args>>, responses: List<String>): MockLLMBuilder.MixedResultsReceiver<Args>

Creates a mock response with a combination of tool calls and predefined string responses.

mockLLMToolCall

fun <Args : ToolArgs> mockLLMToolCall(toolCalls: List<Pair<Tool<Args, *>, Args>>): MockLLMBuilder.MultiToolCallReceiver<Args>

Creates a mock for a list of LLM tool calls.

fun <Args : ToolArgs> mockLLMToolCall(tool: Tool<Args, *>, args: Args, toolCallId: String? = null): MockLLMBuilder.ToolCallReceiver<Args>

Creates a mock for an LLM tool call.

mockLLMToolCall

fun MockLLMBuilder.mockLLMToolCall(tool: KFunction<*>, vararg args: Any?, toolCallId: String? = null): MockLLMBuilder.ToolCallReceiver<ToolFromCallable.VarArgs>

Mocks a tool call for the provided tool function and arguments.

mockTool

fun <Args : ToolArgs, Result : ToolResult> mockTool(tool: Tool<Args, Result>): MockLLMBuilder.MockToolReceiver<Args, Result>

Creates a mock for a tool.

mockTool

infix fun <Result> MockLLMBuilder.mockTool(tool: KFunction<Result>): MockToolFromCallableReceiver<Result>

Associates a tool function with the MockLLMBuilder to create a MockToolFromCallableReceiver instance.

onCondition

infix fun String.onCondition(condition: (String) -> Boolean): MockLLMBuilder

Configures the LLM to respond with this string when the user request satisfies the specified condition.

onUserRequestContains

infix fun String.onUserRequestContains(pattern: String): MockLLMBuilder

Configures the LLM to respond with this string when the user request contains the specified pattern.

onUserRequestEquals

infix fun String.onUserRequestEquals(pattern: String): MockLLMBuilder

Configures the LLM to respond with this string when the user request exactly matches the specified pattern.

setDefaultModerationResponse

fun setDefaultModerationResponse(result: ModerationResult)

Sets the default moderation response to the provided result.

setDefaultResponse

fun setDefaultResponse(response: String)

Sets the default response to be returned when no other response matches.

setToolRegistry

fun setToolRegistry(registry: ToolRegistry)

Sets the tool registry to be used for tool execution.