Jido.AI.Effects.Policy (Jido AI v2.2.0)

Effect policy definition and filtering for tool-emitted effects.

Summary

constraints()

matcher()

matcher_set()

mode()

t()

Returns true when an effect is permitted by the policy.

default()

Returns the default policy.

Filters effects according to the policy.

Narrows an agent policy by a strategy policy.

new(policy)

Builds a policy from map/keyword input.

@type constraints() :: map()

@type matcher() :: module()

@type matcher_set() :: term()

@type mode() :: :deny_all | :allow_all | :allow_list

@type t() :: %Jido.AI.Effects.Policy{
  allow: matcher_set(),
  constraints: constraints(),
  deny: matcher_set(),
  mode: mode()
}

@spec allowed?(t(), term()) :: boolean()

Returns true when an effect is permitted by the policy.

@spec default() :: t()

Returns the default policy.

@spec filter(t() | map() | keyword() | nil, [term()]) :: {[term()], [term()]}

Filters effects according to the policy.

Returns {allowed, dropped}.

@spec intersect(t() | map() | keyword() | nil, t() | map() | keyword() | nil) :: t()

Narrows an agent policy by a strategy policy.

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

Builds a policy from map/keyword input.