Class: OpenAI::Helpers::Streaming::ChatFunctionToolCallArgumentsDoneEvent

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/helpers/streaming/chat_events.rb

Overview

Function tool call arguments completion event.

Emitted when a function tool call’s arguments are complete. For tools defined with ‘strict: true`, the arguments will be fully parsed and validated. For non-strict tools, only raw JSON is available.

Examples:

With strict tool

event.name             # => "get_weather"
event.arguments        # => '{"location": "San Francisco", "unit": "celsius"}'
event.parsed # => {location: "San Francisco", unit: "celsius"}

Without strict tool

event.parsed # => nil (parse JSON from event.arguments manually)

Method Summary

Methods inherited from Internal::Type::BaseModel

#==, ==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

This class inherits a constructor from OpenAI::Internal::Type::BaseModel