Backplane.AiProtocol.ContentBlock (backplane_ai_protocol v1.10.37)

Typed, ordered content.

Opaque reasoning and provider state are preserved as provenance-tagged values; they are never converted into display text.

Audio, embedded resources and resource links use bounded, string-keyed data objects. Audio carries MIME plus base64 data or a URI; resources retain URI, MIME and optional text/base64 content; links retain URI and name. Portable annotations and provenance belong in namespaced extensions. Known JSON type tags decode through a fixed whitelist without creating atoms.

Summary

Types

kind()

t()

Functions

new(attrs, opts \\ [])

Types

kind()

@type kind() ::
  :text
  | :image
  | :audio
  | :resource
  | :resource_link
  | :reasoning
  | :tool_call
  | :refusal
  | :provider_state

t()

@type t() :: %Backplane.AiProtocol.ContentBlock{
  data: term() | nil,
  extensions: map(),
  reason: String.t() | nil,
  state: map() | nil,
  text: String.t() | nil,
  tool_call: Backplane.AiProtocol.ToolCall.t() | nil,
  type: kind()
}

Functions

new(attrs, opts \\ [])

@spec new(map(), keyword()) :: {:ok, t()} | {:error, Backplane.AiProtocol.Error.t()}