Class: OpenAI::Helpers::Streaming::ChatFunctionToolCallArgumentsDeltaEvent

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

Overview

Incremental function tool call arguments update.

Emitted as function arguments are being streamed. Provides both the raw JSON fragments and, for strict tools, parsed arguments once the accumulated arguments are complete, valid JSON.

Examples:

event.name            # => "get_weather"
event.index           # => 0 (tool call index in array)
event.arguments_delta # => ' Francisco"}'  (new fragment)
event.arguments       # => '{"location": "San Francisco"}'  (accumulated JSON)
event.parsed # => {location: "San Francisco"}  (for a strict tool)

Instance Attribute Summary

Attributes inherited from Internal::Type::BaseModel

#last_response

Method Summary

Methods inherited from Internal::Type::BaseModel

#==, ==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, 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, coerce_with_error, 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