Class: Vellum::PromptSettings

Inherits:
Object
  • Object
show all
Defined in:
lib/vellum_ai/types/prompt_settings.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(timeout: OMIT, stream_enabled: OMIT, additional_properties: nil) ⇒ Vellum::PromptSettings

Parameters:

  • timeout (Float) (defaults to: OMIT)
  • stream_enabled (Boolean) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



23
24
25
26
27
28
29
30
 
# File 'lib/vellum_ai/types/prompt_settings.rb', line 23

def initialize(timeout: OMIT, stream_enabled: OMIT, additional_properties: nil)
  @timeout = timeout if timeout != OMIT
  @stream_enabled = stream_enabled if stream_enabled != OMIT
  @additional_properties = additional_properties
  @_field_set = { "timeout": timeout, "stream_enabled": stream_enabled }.reject do | _k, v |
  v == OMIT
end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



12
13
14
 
# File 'lib/vellum_ai/types/prompt_settings.rb', line 12

def additional_properties
  @additional_properties
end

#stream_enabled ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


10
11
12
 
# File 'lib/vellum_ai/types/prompt_settings.rb', line 10

def stream_enabled
  @stream_enabled
end

#timeout ⇒ Float (readonly)

Returns:

  • (Float) 


8
9
10
 
# File 'lib/vellum_ai/types/prompt_settings.rb', line 8

def timeout
  @timeout
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::PromptSettings

Parameters:

  • json_object (String)

Returns:



35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/vellum_ai/types/prompt_settings.rb', line 35

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  timeout = parsed_json["timeout"]
  stream_enabled = parsed_json["stream_enabled"]
  new(
    timeout: timeout,
    stream_enabled: stream_enabled,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


58
59
60
61
 
# File 'lib/vellum_ai/types/prompt_settings.rb', line 58

def self.validate_raw(obj:)
  obj.timeout&.is_a?(Float) != false || raise("Passed value for field obj.timeout is not the expected type, validation failed.")
  obj.stream_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.stream_enabled is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


49
50
51
 
# File 'lib/vellum_ai/types/prompt_settings.rb', line 49

def to_json
  @_field_set&.to_json
end