Jidoka.Effect.Result (Jidoka v0.9.0)

Normalized result of an interpreted effect.

Summary

t()

Builds a failed result for an effect intent.

new(attrs)

Builds an effect result from keyword or map attributes.

new!(attrs)

Builds an effect result and raises if the attributes are invalid.

Builds a successful result for an effect intent.

schema()

Returns the Zoi schema for an interpreted effect result.

@type t() :: %Jidoka.Effect.Result{
  intent_id: binary(),
  kind: :llm | :operation,
  metadata: map(),
  output: any(),
  status: :ok | :error
}

@spec error(Jidoka.Effect.Intent.t(), term(), keyword()) :: t()

Builds a failed result for an effect intent.

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

Builds an effect result from keyword or map attributes.

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

Builds an effect result and raises if the attributes are invalid.

@spec ok(Jidoka.Effect.Intent.t(), term(), keyword()) :: t()

Builds a successful result for an effect intent.

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

Returns the Zoi schema for an interpreted effect result.