Jev.Wire.Answer (Jev v0.2.0)

One answer. noul, choice, or score is set according to type; confidence, legend, and probabilities accompany a choice or score.

Summary

Types

t()

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.

Types

t()

@type t() :: %Jev.Wire.Answer{
  choice: String.t() | nil,
  confidence: number() | nil,
  legend: %{required(String.t()) => String.t()} | nil,
  noul: number() | nil,
  probabilities: %{required(String.t()) => number()},
  score: number() | nil,
  type: :noul | :choice | :score | 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.