agents-ext/ai.koog.agents.ext.tool.search/RegexSearchTool

RegexSearchTool

class RegexSearchTool<Path>(fs: FileSystemProvider.ReadOnly<Path>) : Tool<RegexSearchTool.Args, RegexSearchTool.Result> (source)

Regular expression based content search tool.

Use to find occurrences of a regex pattern across text files under a path.

Constructors

RegexSearchTool

constructor(fs: FileSystemProvider.ReadOnly<Path>)

Types

Args

@Serializable

data class Args(val path: String, val regex: String, val limit: Int = 25, val skip: Int = 0, val caseSensitive: Boolean = false)

Parameters for a regex content search.

Result

@Serializable

data class Result(val entries: List<FileSystemEntry.File>, val original: String)

Search output.

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

decodeResult

open fun decodeResult(rawResult: JSONElement, serializer: JSONSerializer): RegexSearchTool.Result

encodeArgs

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

encodeArgsToString

fun encodeArgsToString(args: RegexSearchTool.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: RegexSearchTool.Result, serializer: JSONSerializer): JSONElement

encodeResultToParts

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

encodeResultToPartsUnsafe

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

encodeResultToString

open fun encodeResultToString(result: RegexSearchTool.Result, 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: RegexSearchTool.Args, metadata: ToolCallMetadata): RegexSearchTool.Result

open suspend override fun execute(args: RegexSearchTool.Args): RegexSearchTool.Result

executeUnsafe

suspend fun executeUnsafe(args: Any?): RegexSearchTool.Result

suspend fun executeUnsafe(args: Any?, metadata: ToolCallMetadata): RegexSearchTool.Result