Jido.Chat.CapabilityMatrix (Jido Chat v1.0.0)

Copy Markdown View Source

Adapter capability declaration matrix (:native | :fallback | :unsupported).

Summary

Functions

Returns capability matrix map.

Builds capability matrix from serialized map.

Creates normalized capability matrix payload.

Returns the Zoi schema for CapabilityMatrix.

Returns declared support status for capability.

Serializes capability matrix into plain map with type marker.

Types

capability_status()

@type capability_status() :: :native | :fallback | :unsupported

t()

@type t() :: %Jido.Chat.CapabilityMatrix{
  adapter_name: nil | nil | atom(),
  capabilities: map()
}

Functions

as_map(matrix)

@spec as_map(t()) :: %{optional(atom()) => capability_status()}

Returns capability matrix map.

from_map(map)

@spec from_map(map()) :: t()

Builds capability matrix from serialized map.

new(attrs)

@spec new(map()) :: t()

Creates normalized capability matrix payload.

schema()

Returns the Zoi schema for CapabilityMatrix.

status(matrix, capability)

@spec status(t(), atom()) :: capability_status()

Returns declared support status for capability.

to_map(matrix)

@spec to_map(t()) :: map()

Serializes capability matrix into plain map with type marker.