agents-ext/ai.koog.agents.ext.tool/ExitTool

ExitTool

object ExitTool : SimpleTool<ExitTool.Args> (source)

An object representing the exit tool, primarily intended for ending conversations upon user request or based on agent decision. This tool finalizes interactions with a provided message.

The tool utilizes a structured set of arguments, which includes the final message of the agent to provide closure to the conversation. It returns the result as a standardized string, signaling the execution has been completed.

The descriptor defines the tool's metadata including its name, description, and required parameters.

Types

Args

@Serializable

data class Args(val message: String)

Represents the arguments for the ExitTool tool

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): ExitTool.Args

decodeResult

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

encodeArgs

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

encodeArgsToString

fun encodeArgsToString(args: ExitTool.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

encodeResultToString

open override 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: ExitTool.Args, metadata: ToolCallMetadata): String

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

executeUnsafe

suspend fun executeUnsafe(args: Any?): String

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