Jido.Memory.ProviderInfo (Jido Memory v1.0.0)

Canonical provider metadata returned by runtime/provider info calls.

Summary

Types

t()

Functions

from_capabilities(provider, capability_set, opts \\ [])

Builds provider info from a capability set.

new(attrs)

Builds and normalizes provider info.

new!(attrs)

Builds and normalizes provider info, raising on error.

schema()

Returns the provider info schema.

Types

t()

@type t() :: %Jido.Memory.ProviderInfo{
  advanced_operations: map(),
  capabilities: [atom()],
  capability_descriptor: map(),
  defaults: map(),
  description: nil | binary(),
  key: nil | atom(),
  metadata: map(),
  name: binary(),
  provider: atom(),
  provider_style: nil | atom(),
  scope: nil | any(),
  surface_boundary: map(),
  topology: map(),
  version: nil | binary()
}

Functions

from_capabilities(provider, capability_set, opts \\ [])

@spec from_capabilities(module() | atom(), Jido.Memory.CapabilitySet.t(), keyword()) ::
  t()

Builds provider info from a capability set.

new(attrs)

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

Builds and normalizes provider info.

new!(attrs)

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

Builds and normalizes provider info, raising on error.

schema()

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

Returns the provider info schema.