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

AskUser

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

Object representation of a tool that provides an interface for agent-user interaction. It allows the agent to ask the user for input (via stdout/stdin).

Types

Args

@Serializable

data class Args(val message: String)

Represents the arguments for the AskUser 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): AskUser.Args

decodeResult

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

encodeArgs

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

encodeArgsToString

fun encodeArgsToString(args: AskUser.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 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: AskUser.Args, metadata: ToolCallMetadata): String

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

executeUnsafe

suspend fun executeUnsafe(args: Any?): String

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