Class: OpenAI::Models::Beta::ChatKit::ChatKitThreadUserMessageItem::InferenceOptions

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/chatkit/chatkit_thread_user_message_item.rb,
sig/openai/models/beta/chatkit/chatkit_thread_user_message_item.rbs

Overview

See Also:

  • OpenAI::Models::Beta::ChatKit::ChatKitThreadUserMessageItem#inference_options

Defined Under Namespace

Classes: ToolChoice

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

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

#initialize(model:, tool_choice:) ⇒ Object

Parameters:

  • model —

    Model name that generated the response. Defaults to null when using the session default.

  • tool_choice —

    Preferred tool to invoke. Defaults to null when ChatKit should auto-select.




# File 'lib/openai/models/beta/chatkit/chatkit_thread_user_message_item.rb', line 169

Instance Attribute Details

#model ⇒ String?

Model name that generated the response. Defaults to null when using the session default.

Returns:

  • (String, nil) 


157
 
# File 'lib/openai/models/beta/chatkit/chatkit_thread_user_message_item.rb', line 157

required :model, String, nil?: true

#tool_choice ⇒ OpenAI::Beta::ChatKit::ChatKitThreadUserMessageItem::InferenceOptions::ToolChoice?

Preferred tool to invoke. Defaults to null when ChatKit should auto-select.

Returns:

  • (OpenAI::Beta::ChatKit::ChatKitThreadUserMessageItem::InferenceOptions::ToolChoice, nil) 


163
164
165
166
167
 
# File 'lib/openai/models/beta/chatkit/chatkit_thread_user_message_item.rb', line 163

required(
  :tool_choice,
  -> { OpenAI::Beta::ChatKit::ChatKitThreadUserMessageItem::InferenceOptions::ToolChoice },
  nil?: true
)

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


149
 
# File 'sig/openai/models/beta/chatkit/chatkit_thread_user_message_item.rbs', line 149

def to_hash: -> {