View Source Anthropic.Messages.Message (anthropic_community v0.5.0)

A message returned by the Anthropic Messages API — the {:ok, message} result of Anthropic.Messages.create/2 or the final fold of Anthropic.Messages.stream/2.

Summary

Types

t()

Functions

from_json(body)

to_param(message)

Converts this message into a plain map suitable for the messages request param, for continuing a conversation (tool-use loop, multi-turn chat).

tool_use?(message)

True if this message is asking the caller to run tools.

tool_uses(message)

All tool_use content blocks in this message, in order.

Types

t()

@type t() :: %Anthropic.Messages.Message{
  content: [Anthropic.Messages.Content.t()],
  id: String.t() | nil,
  model: String.t() | nil,
  role: String.t() | nil,
  stop_reason: String.t() | nil,
  stop_sequence: String.t() | nil,
  type: String.t() | nil,
  usage: map()
}

Functions

from_json(body)

@spec from_json(map()) :: t()

to_param(message)

@spec to_param(t()) :: map()

Converts this message into a plain map suitable for the messages request param, for continuing a conversation (tool-use loop, multi-turn chat).

tool_use?(message)

@spec tool_use?(t()) :: boolean()

True if this message is asking the caller to run tools.

tool_uses(message)

@spec tool_uses(t()) :: [Anthropic.Messages.Content.ToolUse.t()]

All tool_use content blocks in this message, in order.