Jidoka.Review.Request (Jidoka v0.9.0)

Application-facing request for human review of an interrupted operation.

Summary

Types

t()

Functions

from_input(request)

Normalizes an existing request, keyword list, or map.

from_interrupt(interrupt)

Projects a runtime interrupt into a public review request.

from_interrupt!(interrupt)

Projects a runtime interrupt and raises if its data is invalid.

new(attrs)

Builds a review request from keyword or map attributes.

new!(attrs)

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

schema()

Returns the Zoi schema for a public review request.

Types

t()

@type t() :: %Jidoka.Review.Request{
  agent_id: binary(),
  arguments: map(),
  boundary: :operation,
  created_at_ms: nil | nil | integer(),
  expires_at_ms: nil | nil | integer(),
  id: binary(),
  interrupt_id: binary(),
  metadata: map(),
  operation: binary(),
  reason: any(),
  request_id: binary()
}

Functions

from_input(request)

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

Normalizes an existing request, keyword list, or map.

from_interrupt(interrupt)

@spec from_interrupt(Jidoka.Review.Interrupt.t()) :: {:ok, t()} | {:error, term()}

Projects a runtime interrupt into a public review request.

from_interrupt!(interrupt)

@spec from_interrupt!(Jidoka.Review.Interrupt.t()) :: t()

Projects a runtime interrupt and raises if its data is invalid.

new(attrs)

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

Builds a review request from keyword or map attributes.

new!(attrs)

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

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

schema()

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

Returns the Zoi schema for a public review request.