Altar.ADM.ToolResult (Altar v0.1.2)

ToolResult correlates a FunctionCall with its outcome.

Use new/1 to construct validated instances. This simple v1 structure records whether the result is an error and carries the content payload.

Summary

t()

A validated ToolResult.

new(attrs)

Construct a new validated ToolResult.

@type t() :: %Altar.ADM.ToolResult{
  call_id: String.t(),
  content: any(),
  is_error: boolean()
}

A validated ToolResult.

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

Construct a new validated ToolResult.

Accepts a map or keyword list with:

:call_id (required): non-empty string; correlates with the triggering call
:content (optional): any term; if is_error: true, should ideally be a map like %{error: "..."}
:is_error (optional): boolean, defaults to false

Returns {:ok, %ToolResult{}} on success or {:error, reason}.