Jidoka.Effect.Result (Jidoka v0.8.0-beta.1)

Copy Markdown View Source

Normalized result of an interpreted effect.

Summary

Types

t()

Functions

error(intent, output, opts \\ [])
new(attrs)
new!(attrs)
ok(intent, output, opts \\ [])
schema()

Types

t()

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

Functions

error(intent, output, opts \\ [])

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

new(attrs)

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

new!(attrs)

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

ok(intent, output, opts \\ [])

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

schema()

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