Jido.Memory.Explanation (Jido Memory v1.0.0)

View Source

Canonical explainability payload for provider retrieval decisions.

Summary

Types

t()

Functions

new(attrs)

Builds and normalizes a retrieval explanation.

new!(attrs)

Builds and normalizes an explanation, raising on error.

schema()

Returns the explanation schema.

Types

t()

@type t() :: %Jido.Memory.Explanation{
  extensions: map(),
  metadata: map(),
  provider: nil | any(),
  query: nil | any(),
  reasons: [any()],
  scope: nil | any(),
  summary: nil | binary()
}

Functions

new(attrs)

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

Builds and normalizes a retrieval explanation.

new!(attrs)

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

Builds and normalizes an explanation, raising on error.

schema()

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

Returns the explanation schema.