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

TestBlankTool

class TestBlankTool(name: String? = null) : Tool<TestBlankTool.Args, String> (source)

A simple implementation of the Tool class that returns the input string argument as the result. This tool is used for testing purposes only.

Parameters

name

An optional name for the tool. If not provided, it defaults to "blank-tool".

Constructors

TestBlankTool

constructor(name: String? = null)

Types

Args

@Serializable

data class Args(val args: String = "")

Represents the arguments for the TestBlankTool.

Properties

argsType

val argsType: TypeToken

descriptor

val descriptor: ToolDescriptor

metadata

val metadata: Map<String, String>

name

val name: String

resultType

val resultType: TypeToken

Functions

decodeArgs

open fun decodeArgs(rawArgs: JSONObject, serializer: JSONSerializer): TestBlankTool.Args

decodeResult

open fun decodeResult(rawResult: JSONElement, serializer: JSONSerializer): String

encodeArgs

open fun encodeArgs(args: TestBlankTool.Args, serializer: JSONSerializer): JSONObject

encodeArgsToString

fun encodeArgsToString(args: TestBlankTool.Args, serializer: JSONSerializer): String

encodeArgsToStringUnsafe

fun encodeArgsToStringUnsafe(args: Any?, serializer: JSONSerializer): String

encodeArgsUnsafe

fun encodeArgsUnsafe(args: Any?, serializer: JSONSerializer): JSONObject

encodeResult

open fun encodeResult(result: String, serializer: JSONSerializer): JSONElement

encodeResultToParts

open fun encodeResultToParts(result: String, serializer: JSONSerializer): List<MessagePart.ContentPart>

encodeResultToPartsUnsafe

fun encodeResultToPartsUnsafe(result: Any?, serializer: JSONSerializer): List<MessagePart.ContentPart>

encodeResultToString

open fun encodeResultToString(result: String, serializer: JSONSerializer): String

encodeResultToStringUnsafe

fun encodeResultToStringUnsafe(result: Any?, serializer: JSONSerializer): String

encodeResultUnsafe

fun encodeResultUnsafe(result: Any?, serializer: JSONSerializer): JSONElement

execute

suspend override fun execute(args: TestBlankTool.Args, metadata: ToolCallMetadata): String

open suspend override fun execute(args: TestBlankTool.Args): String

executeUnsafe

suspend fun executeUnsafe(args: Any?): String

suspend fun executeUnsafe(args: Any?, metadata: ToolCallMetadata): String