agents-tools/ai.koog.agents.core.tools/ToolResult/AsTextSerializer

AsTextSerializer

open class AsTextSerializer<T : ToolResult.TextSerializable>(valueSerializer: KSerializer<T>) : KSerializer<T> (source)

A serializer that converts an object implementing the TextSerializable interface into a textual format by utilizing the textForLLM function defined in the interface.

This serializer provides functionality to encode the object into a string format suitable for textual representation and decodes it using a provided serializer for the type.

Parameters

The type of object being serialized/deserialized, constrained to types implementing TextSerializable.

valueSerializer

The serializer responsible for handling the underlying type operations.

Constructors

AsTextSerializer

constructor(valueSerializer: KSerializer<T>)

Properties

descriptor

open override val descriptor: SerialDescriptor

The descriptor that provides metadata about the serialized form of the value. This descriptor corresponds to the valueSerializer's descriptor, defining the structure of the serialized data and associated information like kind and elements.

Functions

asToolDescriptorSerializer

fun <T> KSerializer<T>.asToolDescriptorSerializer(): KSerializer<T>

Provides a custom serializer for tools, wrapping and unwrapping values that do not serialize into JsonObject into a custom JsonObject with value key. This wrapping/unwrapping is needed because for LLM APIs tool arguments must always be JsonObject.

deserialize

open override fun deserialize(decoder: Decoder): T

Deserializes the provided encoded data using the specified decoder and returns the resulting object of type T.

serialize

open override fun serialize(encoder: Encoder, value: T)

Serializes an object of type T into its textual representation.