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

RendererErrorMessage

@Serializable(with = RendererErrorMessageSerializer::class)

sealed interface RendererErrorMessage : RendererToAgentMessage

A renderer-side error.

The schema splits this by code: the three reserved codes take a shape that must locate the failure in the message (Validation), and any other code takes a shape that must name either the surface or the call it belongs to, but not both (Generic).

Inheritors

Validation

Generic

Types

Generic

data class Generic(val code: String, val message: String, val scope: RendererErrorMessage.Scope, val additional: Map<String, JsonElement> = emptyMap()) : RendererErrorMessage

Any other failure, attributed to exactly one of a surface or a function call.

Scope

sealed interface Scope

What a Generic error is about. Exactly one of the two, never both and never neither.

Validation

data class Validation(val validationCode: ValidationErrorCode, val surfaceId: String, val path: String, val message: String) : RendererErrorMessage

A message the renderer refused, located by path within it.

Properties

code

abstract val code: String

The wire value of code.

message

abstract val message: String

A sentence or two on what went wrong.