a2ui-core/dev.ynagai.a2ui.core.protocol/FunctionResponse

FunctionResponse

@Serializable(with = FunctionResponseSerializer::class)

The response to a callRendererFunction or callAgentFunction invocation.

The schema's "exactly one of value or error" is expressed as the two variants, so a response carrying both or neither cannot be constructed, only rejected while decoding.

Inheritors

Success

Failure

Types

Failure

data class Failure(val functionCallId: CallId, val error: FunctionError) : FunctionResponse

The function failed with error.

Success

data class Success(val functionCallId: CallId, val value: JsonElement) : FunctionResponse

The function returned value.

Properties

functionCallId

abstract val functionCallId: CallId

The id of the invocation this responds to.