Agentix.Scope (Agentix v0.5.2)

Copy Markdown View Source

The caller's authorization/context, passed per entry-verb call (send_message/3, resolve/4) and threaded into :server tool callbacks via Agentix.Turn.

A scope is per-call and never persisted — it reflects who is acting now, not conversation state. Two flavours:

  • a user scope — carries current_user and arbitrary assigns;
  • a system scope (system/0) — system?: true, the documented scope for timeout-driven resolutions and other server-initiated actions. A system scope may not carry a current_user.

Built with new/1 (rejects unknown keys).

Optional fields

  • tenant_key — the acting tenant, for multi-tenant hosts (nil or a non-empty string). Entry verbs (send_message/4, resolve/4) use it as the default tenant_key: option when the caller passes none, so authenticating the tenant into the scope is enough to get the write-once isolation check on every call (an explicit option still wins). The conversation's own persisted tenant is Agentix.Conversation.Config.tenant_key. Like the rest of the scope, this field itself is never persisted and never broadcast on telemetry.

Summary

Types

t()

Functions

new(attrs \\ [])

Builds a scope from attrs. Raises ArgumentError on unknown keys, if assigns is not a map, or if a system scope carries a current_user.

system()

The documented system scope (e.g. timeout-driven resolutions).

Types

t()

@type t() :: %Agentix.Scope{
  assigns: map(),
  current_user: term() | nil,
  system?: boolean(),
  tenant_key: String.t() | nil
}

Functions

new(attrs \\ [])

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

Builds a scope from attrs. Raises ArgumentError on unknown keys, if assigns is not a map, or if a system scope carries a current_user.

system()

@spec system() :: t()

The documented system scope (e.g. timeout-driven resolutions).