Module Message.Result

Final result messages with metadata about the conversation.

module Usage : sig ... end

Usage statistics for API calls.

type t

The type of result messages.

val jsont : t Jsont.t

jsont is the Jsont codec for result messages.

val create : subtype:string -> duration_ms:int -> duration_api_ms:int -> is_error:bool -> num_turns:int -> session_id:string -> ?total_cost_usd:float -> ?usage:Usage.t -> ?result:string -> ?structured_output:Jsont.json -> unit -> t

create ~subtype ~duration_ms ~duration_api_ms ~is_error ~num_turns ~session_id ?total_cost_usd ?usage ?result ?structured_output () creates a result message.

  • parameter subtype

    The subtype of the result

  • parameter duration_ms

    Total duration in milliseconds

  • parameter duration_api_ms

    API duration in milliseconds

  • parameter is_error

    Whether the result represents an error

  • parameter num_turns

    Number of conversation turns

  • parameter session_id

    Unique session identifier

  • parameter total_cost_usd

    Optional total cost in USD

  • parameter usage

    Optional usage statistics

  • parameter result

    Optional result string

  • parameter structured_output

    Optional structured JSON output from Claude

val subtype : t -> string

subtype t returns the subtype of the result.

val duration_ms : t -> int

duration_ms t returns the total duration in milliseconds.

val duration_api_ms : t -> int

duration_api_ms t returns the API duration in milliseconds.

val is_error : t -> bool

is_error t returns whether this result represents an error.

val num_turns : t -> int

num_turns t returns the number of conversation turns.

val session_id : t -> string

session_id t returns the session identifier.

val total_cost_usd : t -> float option

total_cost_usd t returns the optional total cost in USD.

val usage : t -> Usage.t option

usage t returns the optional usage statistics.

val result : t -> string option

result t returns the optional result string.

val structured_output : t -> Jsont.json option

structured_output t returns the optional structured JSON output.

val unknown : t -> Unknown.t

unknown t returns the unknown fields preserved from JSON.