CliSubprocessCore.Payload.UserMessage (CliSubprocessCore v0.1.0)

Copy Markdown View Source

Represents normalized user input.

Summary

Types

t()

Functions

new(attrs \\ [])
parse(payload)
parse!(payload)
schema()
to_map(payload)

Types

t()

@type t() :: %CliSubprocessCore.Payload.UserMessage{
  content: [term()],
  extra: map(),
  metadata: map(),
  role: :user
}

Functions

new(attrs \\ [])

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

parse(payload)

@spec parse(keyword() | map() | struct()) ::
  {:ok, struct()}
  | {:error,
     {:invalid_payload, module(), CliSubprocessCore.Schema.error_detail()}}

parse!(payload)

@spec parse!(keyword() | map() | struct()) :: struct()

schema()

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

to_map(payload)

@spec to_map(struct()) :: map()