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

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.

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

Search output.

Properties

val argsSerializer: KSerializer<RegexSearchTool.Args>

val descriptor: ToolDescriptor

val name: String

resultSerializer

val resultSerializer: KSerializer<RegexSearchTool.Result>

Functions

fun decodeArgs(rawArgs: JsonObject): RegexSearchTool.Args

fun decodeResult(rawResult: JsonElement): RegexSearchTool.Result

fun encodeArgs(args: RegexSearchTool.Args): JsonObject

encodeArgsToString

fun encodeArgsToString(args: RegexSearchTool.Args): String

encodeArgsToStringUnsafe

fun encodeArgsToStringUnsafe(args: Any?): String

encodeArgsUnsafe

fun encodeArgsUnsafe(args: Any?): JsonObject

fun encodeResult(result: RegexSearchTool.Result): JsonElement

encodeResultToString

open fun encodeResultToString(result: RegexSearchTool.Result): String

encodeResultToStringUnsafe

fun encodeResultToStringUnsafe(result: Any?): String

encodeResultUnsafe

fun encodeResultUnsafe(result: Any?): JsonElement

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

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