Class: Vellum::RawPromptExecutionOverridesRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(body: nil, headers: nil, url: nil, additional_properties: nil) ⇒ RawPromptExecutionOverridesRequest

Parameters:

  • body (Hash{String => String}) (defaults to: nil)
  • headers (Hash{String => String}) (defaults to: nil) —

    The raw headers to send to the model host.

  • url (String) (defaults to: nil) —

    The raw URL to send to the model host.

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



14
15
16
17
18
19
20
21
22
23
 
# File 'lib/vellum_ai/types/raw_prompt_execution_overrides_request.rb', line 14

def initialize(body: nil, headers: nil, url: nil, additional_properties: nil)
  # @type [Hash{String => String}]
  @body = body
  # @type [Hash{String => String}] The raw headers to send to the model host.
  @headers = headers
  # @type [String] The raw URL to send to the model host.
  @url = url
  # @type [OpenStruct] Additional properties unmapped to the current class definition
  @additional_properties = additional_properties
end

Instance Attribute Details

#additional_properties ⇒ Object (readonly)

Returns the value of attribute additional_properties.



7
8
9
 
# File 'lib/vellum_ai/types/raw_prompt_execution_overrides_request.rb', line 7

def additional_properties
  @additional_properties
end

#body ⇒ Object (readonly)

Returns the value of attribute body.



7
8
9
 
# File 'lib/vellum_ai/types/raw_prompt_execution_overrides_request.rb', line 7

def body
  @body
end

#headers ⇒ Object (readonly)

Returns the value of attribute headers.



7
8
9
 
# File 'lib/vellum_ai/types/raw_prompt_execution_overrides_request.rb', line 7

def headers
  @headers
end

#url ⇒ Object (readonly)

Returns the value of attribute url.



7
8
9
 
# File 'lib/vellum_ai/types/raw_prompt_execution_overrides_request.rb', line 7

def url
  @url
end

Class Method Details

.from_json(json_object:) ⇒ RawPromptExecutionOverridesRequest

Deserialize a JSON object to an instance of RawPromptExecutionOverridesRequest

Parameters:

  • json_object (JSON)

Returns:



29
30
31
32
33
34
35
36
 
# File 'lib/vellum_ai/types/raw_prompt_execution_overrides_request.rb', line 29

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  JSON.parse(json_object)
  body = struct.body
  headers = struct.headers
  url = struct.url
  new(body: body, headers: headers, url: url, additional_properties: struct)
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object’s property definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


49
50
51
52
53
 
# File 'lib/vellum_ai/types/raw_prompt_execution_overrides_request.rb', line 49

def self.validate_raw(obj:)
  obj.body&.is_a?(Hash) != false || raise("Passed value for field obj.body is not the expected type, validation failed.")
  obj.headers&.is_a?(Hash) != false || raise("Passed value for field obj.headers is not the expected type, validation failed.")
  obj.url&.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of RawPromptExecutionOverridesRequest to a JSON object

Returns:

  • (JSON) 


41
42
43
 
# File 'lib/vellum_ai/types/raw_prompt_execution_overrides_request.rb', line 41

def to_json(*_args)
  { "body": @body, "headers": @headers, "url": @url }.to_json
end