Class: Vellum::PromptRequestDocumentInput

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(key:, type:, value:, additional_properties: nil) ⇒ Vellum::PromptRequestDocumentInput

Parameters:

  • key (String) —

    The variable’s name, as defined in the Prompt.

  • type (String)
  • value (Vellum::VellumDocument)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



27
28
29
30
31
32
33
 
# File 'lib/vellum_ai/types/prompt_request_document_input.rb', line 27

def initialize(key:, type:, value:, additional_properties: nil)
  @key = key
  @type = type
  @value = value
  @additional_properties = additional_properties
  @_field_set = { "key": key, "type": type, "value": value }
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



15
16
17
 
# File 'lib/vellum_ai/types/prompt_request_document_input.rb', line 15

def additional_properties
  @additional_properties
end

#key ⇒ String (readonly)

Returns The variable’s name, as defined in the Prompt.

Returns:

  • (String) —

    The variable’s name, as defined in the Prompt.



9
10
11
 
# File 'lib/vellum_ai/types/prompt_request_document_input.rb', line 9

def key
  @key
end

#type ⇒ String (readonly)

Returns:

  • (String) 


11
12
13
 
# File 'lib/vellum_ai/types/prompt_request_document_input.rb', line 11

def type
  @type
end

#value ⇒ Vellum::VellumDocument (readonly)

Returns:



13
14
15
 
# File 'lib/vellum_ai/types/prompt_request_document_input.rb', line 13

def value
  @value
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::PromptRequestDocumentInput

Parameters:

  • json_object (String)

Returns:



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/vellum_ai/types/prompt_request_document_input.rb', line 38

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  key = parsed_json["key"]
  type = parsed_json["type"]
  unless parsed_json["value"].nil?
    value = parsed_json["value"].to_json
    value = Vellum::VellumDocument.from_json(json_object: value)
  else
    value = nil
  end
  new(
    key: key,
    type: type,
    value: value,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


68
69
70
71
72
 
# File 'lib/vellum_ai/types/prompt_request_document_input.rb', line 68

def self.validate_raw(obj:)
  obj.key.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
  obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
  Vellum::VellumDocument.validate_raw(obj: obj.value)
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


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

def to_json
  @_field_set&.to_json
end