Jidoka.Import.AgentDocument (Jidoka v0.9.0)

Copy Markdown View Source

Portable JSON/YAML authoring document for a Jidoka agent.

The document intentionally stores only data. Runtime-only values such as Zoi schemas and Jido action modules are referenced by name and resolved through explicit registries in Jidoka.Import.

Summary

Types

t()

Functions

new(attrs)

Builds a portable agent document from keyword or map attributes.

new!(attrs)

Builds a portable agent document and raises if the attributes are invalid.

schema()

Returns the Zoi schema for a portable agent document.

version()

Returns the current portable document format version.

Types

t()

@type t() :: %Jidoka.Import.AgentDocument{
  agent: map(),
  controls: map(),
  metadata: map(),
  operations: [map()],
  runtime_defaults: map(),
  tools: map(),
  version: integer()
}

Functions

new(attrs)

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

Builds a portable agent document from keyword or map attributes.

new!(attrs)

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

Builds a portable agent document and raises if the attributes are invalid.

schema()

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

Returns the Zoi schema for a portable agent document.

version()

@spec version() :: pos_integer()

Returns the current portable document format version.