Sake.Prompt behaviour (Sake v0.4.0)

Copy Markdown View Source

A prompt template: arg lines (strings only) and get/2, which returns messages as {:user | :assistant, text | %Sake.Content{}}. scope: (one or many) gates it by the token's scopes, and authentication: ([acr: ["mfa"], max_age: 300]) by how the person signed in (see "Step-up authentication" in Sake.Server).

Summary

Callbacks

complete(arg, partial, ctx)
get(args, ctx)
spec()

Functions

arg(name, type, opts \\ [])

Callbacks

complete(arg, partial, ctx)

(optional) 
@callback complete(arg :: String.t(), partial :: String.t(), ctx :: Sake.Context.t()) ::
  {:ok, [String.t()]} | {:ok, [String.t()], keyword()}

get(args, ctx)

@callback get(args :: map(), ctx :: Sake.Context.t()) ::
  {:ok, [{atom(), term()}]}
  | {:ok, [{atom(), term()}], keyword()}
  | {:error, String.t()}
  | {:error, {:missing_capability, map()}}

spec()

@callback spec() :: Sake.Prompt.Spec.t()

Functions

arg(name, type, opts \\ [])

(macro)