Class: Vellum::PromptParameters

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(stop: OMIT, temperature: OMIT, max_tokens: OMIT, top_p: OMIT, top_k: OMIT, frequency_penalty: OMIT, presence_penalty: OMIT, logit_bias: OMIT, custom_parameters: OMIT, additional_properties: nil) ⇒ Vellum::PromptParameters

Parameters:

  • stop (Array<String>) (defaults to: OMIT)
  • temperature (Float) (defaults to: OMIT)
  • max_tokens (Integer) (defaults to: OMIT)
  • top_p (Float) (defaults to: OMIT)
  • top_k (Integer) (defaults to: OMIT)
  • frequency_penalty (Float) (defaults to: OMIT)
  • presence_penalty (Float) (defaults to: OMIT)
  • logit_bias (Hash{String => Float}) (defaults to: OMIT)
  • custom_parameters (Hash{String => Object}) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/vellum_ai/types/prompt_parameters.rb', line 44

def initialize(stop: OMIT, temperature: OMIT, max_tokens: OMIT, top_p: OMIT, top_k: OMIT, frequency_penalty: OMIT, presence_penalty: OMIT, logit_bias: OMIT, custom_parameters: OMIT, additional_properties: nil)
  @stop = stop if stop != OMIT
  @temperature = temperature if temperature != OMIT
  @max_tokens = max_tokens if max_tokens != OMIT
  @top_p = top_p if top_p != OMIT
  @top_k = top_k if top_k != OMIT
  @frequency_penalty = frequency_penalty if frequency_penalty != OMIT
  @presence_penalty = presence_penalty if presence_penalty != OMIT
  @logit_bias = logit_bias if logit_bias != OMIT
  @custom_parameters = custom_parameters if custom_parameters != OMIT
  @additional_properties = additional_properties
  @_field_set = { "stop": stop, "temperature": temperature, "max_tokens": max_tokens, "top_p": top_p, "top_k": top_k, "frequency_penalty": frequency_penalty, "presence_penalty": presence_penalty, "logit_bias": logit_bias, "custom_parameters": custom_parameters }.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



26
27
28
 
# File 'lib/vellum_ai/types/prompt_parameters.rb', line 26

def additional_properties
  @additional_properties
end

#custom_parameters ⇒ Hash{String => Object} (readonly)

Returns:

  • (Hash{String => Object}) 


24
25
26
 
# File 'lib/vellum_ai/types/prompt_parameters.rb', line 24

def custom_parameters
  @custom_parameters
end

#frequency_penalty ⇒ Float (readonly)

Returns:

  • (Float) 


18
19
20
 
# File 'lib/vellum_ai/types/prompt_parameters.rb', line 18

def frequency_penalty
  @frequency_penalty
end

#logit_bias ⇒ Hash{String => Float} (readonly)

Returns:

  • (Hash{String => Float}) 


22
23
24
 
# File 'lib/vellum_ai/types/prompt_parameters.rb', line 22

def logit_bias
  @logit_bias
end

#max_tokens ⇒ Integer (readonly)

Returns:

  • (Integer) 


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

def max_tokens
  @max_tokens
end

#presence_penalty ⇒ Float (readonly)

Returns:

  • (Float) 


20
21
22
 
# File 'lib/vellum_ai/types/prompt_parameters.rb', line 20

def presence_penalty
  @presence_penalty
end

#stop ⇒ Array<String> (readonly)

Returns:

  • (Array<String>) 


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

def stop
  @stop
end

#temperature ⇒ Float (readonly)

Returns:

  • (Float) 


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

def temperature
  @temperature
end

#top_k ⇒ Integer (readonly)

Returns:

  • (Integer) 


16
17
18
 
# File 'lib/vellum_ai/types/prompt_parameters.rb', line 16

def top_k
  @top_k
end

#top_p ⇒ Float (readonly)

Returns:

  • (Float) 


14
15
16
 
# File 'lib/vellum_ai/types/prompt_parameters.rb', line 14

def top_p
  @top_p
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::PromptParameters

Parameters:

  • json_object (String)

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/vellum_ai/types/prompt_parameters.rb', line 63

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  stop = parsed_json["stop"]
  temperature = parsed_json["temperature"]
  max_tokens = parsed_json["max_tokens"]
  top_p = parsed_json["top_p"]
  top_k = parsed_json["top_k"]
  frequency_penalty = parsed_json["frequency_penalty"]
  presence_penalty = parsed_json["presence_penalty"]
  logit_bias = parsed_json["logit_bias"]
  custom_parameters = parsed_json["custom_parameters"]
  new(
    stop: stop,
    temperature: temperature,
    max_tokens: max_tokens,
    top_p: top_p,
    top_k: top_k,
    frequency_penalty: frequency_penalty,
    presence_penalty: presence_penalty,
    logit_bias: logit_bias,
    custom_parameters: custom_parameters,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/vellum_ai/types/prompt_parameters.rb', line 100

def self.validate_raw(obj:)
  obj.stop&.is_a?(Array) != false || raise("Passed value for field obj.stop is not the expected type, validation failed.")
  obj.temperature&.is_a?(Float) != false || raise("Passed value for field obj.temperature is not the expected type, validation failed.")
  obj.max_tokens&.is_a?(Integer) != false || raise("Passed value for field obj.max_tokens is not the expected type, validation failed.")
  obj.top_p&.is_a?(Float) != false || raise("Passed value for field obj.top_p is not the expected type, validation failed.")
  obj.top_k&.is_a?(Integer) != false || raise("Passed value for field obj.top_k is not the expected type, validation failed.")
  obj.frequency_penalty&.is_a?(Float) != false || raise("Passed value for field obj.frequency_penalty is not the expected type, validation failed.")
  obj.presence_penalty&.is_a?(Float) != false || raise("Passed value for field obj.presence_penalty is not the expected type, validation failed.")
  obj.logit_bias&.is_a?(Hash) != false || raise("Passed value for field obj.logit_bias is not the expected type, validation failed.")
  obj.custom_parameters&.is_a?(Hash) != false || raise("Passed value for field obj.custom_parameters is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


91
92
93
 
# File 'lib/vellum_ai/types/prompt_parameters.rb', line 91

def to_json
  @_field_set&.to_json
end