Pi.Protocol.Session.Snapshot (pi_bridge v0.6.22)

Copy Markdown View Source

Renderer-neutral snapshot of a server-owned Pi session.

Summary

Functions

Decodes a JSON string into this struct.

Decodes a JSON string into this struct, raising on failure.

Dumps this struct into JSON-shaped data, respecting JSON field names.

Builds this struct from a decoded JSON map.

Builds this struct from a decoded JSON map, raising on failure.

Returns a JSON Schema-compatible schema map.

Returns a JSON Schema-compatible schema map.

Converts this struct into a JSON-shaped map.

Types

t()

@type t() :: %Pi.Protocol.Session.Snapshot{
  completed_at: String.t() | nil,
  current: String.t() | nil,
  current_started_at: String.t() | nil,
  duration_ms: non_neg_integer() | nil,
  error: String.t() | nil,
  events: [Pi.Protocol.Session.Event.t()],
  id: String.t(),
  last_activity_at: String.t() | nil,
  latest: String.t() | nil,
  message_count: non_neg_integer(),
  name: String.t() | nil,
  parent_id: String.t() | nil,
  prompt: String.t() | nil,
  recent_output: [String.t()],
  response: String.t() | nil,
  result: term(),
  run_count: non_neg_integer(),
  started_at: String.t() | nil,
  status: String.t(),
  turn_count: non_neg_integer(),
  updated_at: String.t() | nil,
  usage: map() | nil
}

Functions

decode(json)

Decodes a JSON string into this struct.

decode!(json)

Decodes a JSON string into this struct, raising on failure.

dump(struct)

Dumps this struct into JSON-shaped data, respecting JSON field names.

from_map(map)

Builds this struct from a decoded JSON map.

from_map!(map)

Builds this struct from a decoded JSON map, raising on failure.

json_schema()

Returns a JSON Schema-compatible schema map.

schema()

Returns a JSON Schema-compatible schema map.

to_map(struct)

Converts this struct into a JSON-shaped map.