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

data class Args(val message: String)

Represents the arguments for the ExitTool tool

Properties

val argsSerializer: KSerializer<ExitTool.Args>

val descriptor: ToolDescriptor

val name: String

resultSerializer

val resultSerializer: KSerializer<String>

Functions

fun decodeArgs(rawArgs: JsonObject): ExitTool.Args

fun decodeResult(rawResult: JsonElement): String

fun encodeArgs(args: ExitTool.Args): JsonObject

encodeArgsToString

fun encodeArgsToString(args: ExitTool.Args): String

encodeArgsToStringUnsafe

fun encodeArgsToStringUnsafe(args: Any?): String

encodeArgsUnsafe

fun encodeArgsUnsafe(args: Any?): JsonObject

fun encodeResult(result: String): JsonElement

encodeResultToString

open override fun encodeResultToString(result: String): String

encodeResultToStringUnsafe

fun encodeResultToStringUnsafe(result: Any?): String

encodeResultUnsafe

fun encodeResultUnsafe(result: Any?): JsonElement

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

suspend fun executeUnsafe(args: Any?): String