Pi.Skill.Script behaviour (pi_bridge v0.1.0)

Copy Markdown View Source

Behaviour and DSL for trusted executable .skill.exs files.

Summary

Types

metadata()

Callbacks

apis()
markdown()
metadata()
prompt_context(map)
validate(map)

Functions

skill(list)

Types

metadata()

@type metadata() :: %{
  :name => String.t(),
  optional(:version) => String.t(),
  optional(:description) => String.t(),
  optional(:triggers) => [String.t()],
  optional(:alias) => atom(),
  optional(:examples) => [String.t()]
}

Callbacks

apis()

(optional) 
@callback apis() :: [Pi.Plugin.API.t() | keyword() | map()]

markdown()

@callback markdown() :: String.t()

metadata()

@callback metadata() :: metadata()

prompt_context(map)

(optional) 
@callback prompt_context(map()) :: String.t()

validate(map)

(optional) 
@callback validate(map()) :: :ok | {:error, term()}

Functions

skill(list)

(macro)