Module: OpenApiOpenAIClient::CreateChatCompletionRequestFunctionCall

Defined in:
lib/openapi_openai/models/create_chat_completion_request_function_call.rb

Overview

Deprecated in favor of tool_choice. Controls which (if any) function is called by the model. none means the model will not call a function and instead generates a message. auto means the model can pick between generating a message or calling a function. Specifying a particular function via ‘"my_function"` forces the model to call that function. none is the default when no functions are present. auto is the default if functions are present.

Class Method Summary collapse

Class Method Details

.build(data) ⇒ Object

Builds the object

Parameters:

  • Data (Mixed) —

    to be matched against the list of oneOf items

Returns:

  • (Object) —

    Returns the model or the data itself



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/openapi_openai/models/create_chat_completion_request_function_call.rb', line 31

def build(data)
  # Go through the list of oneOf items and attempt to identify the appropriate one.
  # Note:
  # - We do not attempt to check whether exactly one item matches.
  # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
  #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
  # - TODO: scalar values are de facto behaving as if they were nullable.
  # - TODO: logging when debugging is set.
  openapi_one_of.each do |klass|
    begin
      next if klass == :AnyType # "nullable: true"
      return find_and_cast_into_type(klass, data)
    rescue # rescue all errors so we keep iterating even if the current item lookup raises
    end
  end

  openapi_one_of.include?(:AnyType) ? data : nil
end

.openapi_one_of ⇒ Object

List of class defined in oneOf (OpenAPI v3)



21
22
23
24
25
26
 
# File 'lib/openapi_openai/models/create_chat_completion_request_function_call.rb', line 21

def openapi_one_of
  [
    :'ChatCompletionFunctionCallOption',
    :'String'
  ]
end