Class: Vellum::SubmitCompletionActualRequest

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id: OMIT, external_id: OMIT, text: OMIT, quality: OMIT, timestamp: OMIT, metadata: OMIT, additional_properties: nil) ⇒ Vellum::SubmitCompletionActualRequest

Parameters:

  • metadata (Hash{String => Object}) (defaults to: OMIT) —

    Optionally provide additional metadata about the feedback submission.

  • 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
 
# File 'lib/vellum_ai/types/submit_completion_actual_request.rb', line 44

def initialize(id: OMIT, external_id: OMIT, text: OMIT, quality: OMIT, timestamp: OMIT, metadata: OMIT, additional_properties: nil)
  @id = id if id != OMIT
  @external_id = external_id if external_id != OMIT
  @text = text if text != OMIT
  @quality = quality if quality != OMIT
  @timestamp = timestamp if timestamp != OMIT
  @metadata = metadata if metadata != OMIT
  @additional_properties = additional_properties
  @_field_set = { "id": id, "external_id": external_id, "text": text, "quality": quality, "timestamp": timestamp, "metadata": metadata }.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



25
26
27
 
# File 'lib/vellum_ai/types/submit_completion_actual_request.rb', line 25

def additional_properties
  @additional_properties
end

#external_id ⇒ Object (readonly)

you’d now like to submit actuals for. Must provide either this or id.



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

def external_id
  @external_id
end

#id ⇒ Object (readonly)

either this or external_id.



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

def id
  @id
end

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

Returns Optionally provide additional metadata about the feedback submission.

Returns:

  • (Hash{String => Object}) —

    Optionally provide additional metadata about the feedback submission.



23
24
25
 
# File 'lib/vellum_ai/types/submit_completion_actual_request.rb', line 23

def metadata
  @metadata
end

#quality ⇒ Object (readonly)

worst, 1 is the best.



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

def quality
  @quality
end

#text ⇒ String (readonly)

Returns Text representing what the completion should have been.

Returns:

  • (String) —

    Text representing what the completion should have been.



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

def text
  @text
end

#timestamp ⇒ Object (readonly)

Used for reporting purposes.



21
22
23
 
# File 'lib/vellum_ai/types/submit_completion_actual_request.rb', line 21

def timestamp
  @timestamp
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::SubmitCompletionActualRequest

Parameters:

  • json_object (String)

Returns:



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/vellum_ai/types/submit_completion_actual_request.rb', line 60

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = parsed_json["id"]
  external_id = parsed_json["external_id"]
  text = parsed_json["text"]
  quality = parsed_json["quality"]
  timestamp = unless parsed_json["timestamp"].nil?
  DateTime.parse(parsed_json["timestamp"])
else
  nil
end
  metadata = parsed_json["metadata"]
  new(
    id: id,
    external_id: external_id,
    text: text,
    quality: quality,
    timestamp: timestamp,
    metadata: metadata,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


95
96
97
98
99
100
101
102
 
# File 'lib/vellum_ai/types/submit_completion_actual_request.rb', line 95

def self.validate_raw(obj:)
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.external_id&.is_a?(String) != false || raise("Passed value for field obj.external_id is not the expected type, validation failed.")
  obj.text&.is_a?(String) != false || raise("Passed value for field obj.text is not the expected type, validation failed.")
  obj.quality&.is_a?(Float) != false || raise("Passed value for field obj.quality is not the expected type, validation failed.")
  obj.timestamp&.is_a?(DateTime) != false || raise("Passed value for field obj.timestamp is not the expected type, validation failed.")
  obj.metadata&.is_a?(Hash) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


86
87
88
 
# File 'lib/vellum_ai/types/submit_completion_actual_request.rb', line 86

def to_json
  @_field_set&.to_json
end