Jidoka.Agent.Spec.Memory (Jidoka v0.8.0-beta.1)

Copy Markdown View Source

Conversation memory policy for an agent.

The policy is definition data. Runtime stores are supplied per run through harness options.

Summary

Types

capture()
inject()
scope()
t()

Functions

capture_conversation?(memory)
captures()
from_input(memory)
injects()
new(attrs \\ [])
new!(attrs \\ [])
schema()
scopes()

Types

capture()

@type capture() :: :manual | :conversation | :off

inject()

@type inject() :: :instructions | :context

scope()

@type scope() :: :agent | :session

t()

@type t() :: %Jidoka.Agent.Spec.Memory{
  capture: (:manual | :conversation | :off) | binary(),
  enabled: boolean(),
  inject: (:instructions | :context) | binary(),
  max_entries: integer(),
  metadata: map(),
  namespace: nil | nil | any(),
  scope: (:agent | :session) | binary()
}

Functions

capture_conversation?(memory)

@spec capture_conversation?(t() | nil) :: boolean()

captures()

@spec captures() :: [capture()]

from_input(memory)

@spec from_input(t() | keyword() | map() | true | false | nil) ::
  {:ok, t() | nil} | {:error, term()}

injects()

@spec injects() :: [inject()]

new(attrs \\ [])

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

new!(attrs \\ [])

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

schema()

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

scopes()

@spec scopes() :: [scope()]