Jido.Chat.OptionsLoadResult (Jido Chat v1.2.0)

Copy Markdown View Source

Successful, typed output from a dynamic select option loader.

The core does not set a provider maximum for option or group counts. An adapter can apply its own limits before it renders this result.

Summary

Types

t()

Functions

from_map(map)

Builds options-load output from serialized data.

new(result)

Creates successful options-load output.

ok(options, opts \\ [])

Builds output from an option list.

schema()

Returns the schema for options-load output.

to_map(result)

Serializes options-load output.

Types

t()

@type t() :: %Jido.Chat.OptionsLoadResult{
  cursor: nil | nil | binary(),
  has_more: boolean(),
  metadata: map(),
  option_groups: [any()],
  options: [any()]
}

Functions

from_map(map)

@spec from_map(map()) :: t()

Builds options-load output from serialized data.

new(result)

@spec new(t() | map()) :: t()

Creates successful options-load output.

ok(options, opts \\ [])

@spec ok([Jido.Chat.OptionsLoadOption.t() | map()], keyword() | map()) :: t()

Builds output from an option list.

schema()

Returns the schema for options-load output.

to_map(result)

@spec to_map(t()) :: map()

Serializes options-load output.