Backplane.AiProtocol.Response (backplane_ai_protocol v0.7.0)

Complete or partial provider response.

Output completeness is independent of protocol terminal state and trailing usage.

Summary

Types

completeness()

stop_reason()

t()

Functions

new(attrs)

Types

completeness()

@type completeness() :: :complete | :partial | :unknown

stop_reason()

@type stop_reason() ::
  :stop
  | :tool_use
  | :max_output_tokens
  | :refusal
  | :safety
  | :cancelled
  | :unknown
  | atom()

t()

@type t() :: %Backplane.AiProtocol.Response{
  completeness: completeness(),
  extensions: map(),
  output: [term()],
  resolved_model: map() | String.t() | nil,
  stop_reason: stop_reason(),
  usage: Backplane.AiProtocol.Usage.t() | nil,
  warnings: [map() | String.t()]
}

Functions

new(attrs)

@spec new(map()) :: {:ok, t()} | {:error, Backplane.AiProtocol.Error.t()}