Jidoka.Turn.Request (Jidoka v0.9.0)

Copy Markdown View Source

Input for one agent turn.

Summary

Types

input()
t()

Functions

from_input(input, opts \\ [])

Normalizes a request struct, text, content-part list, keyword list, or map.

new(attrs, opts \\ [])

Builds a turn request and applies runtime identifier defaults.

new!(attrs, opts \\ [])

Builds a turn request and raises if the attributes are invalid.

schema()

Returns the Zoi schema for a turn request.

Types

input()

@type input() :: t() | String.t() | [Jidoka.ContentPart.input()] | keyword() | map()

t()

@type t() :: %Jidoka.Turn.Request{
  agent_state: term(),
  content: [term()],
  context: term(),
  input: binary(),
  metadata: map(),
  request_id: binary()
}

Functions

from_input(input, opts \\ [])

@spec from_input(
  input(),
  keyword()
) :: {:ok, t()} | {:error, term()}

Normalizes a request struct, text, content-part list, keyword list, or map.

new(attrs, opts \\ [])

@spec new(
  keyword() | map(),
  keyword()
) :: {:ok, t()} | {:error, term()}

Builds a turn request and applies runtime identifier defaults.

new!(attrs, opts \\ [])

@spec new!(
  keyword() | map(),
  keyword()
) :: t()

Builds a turn request and raises if the attributes are invalid.

schema()

@spec schema() :: Zoi.schema()

Returns the Zoi schema for a turn request.