Class: AssemblyAI::Lemur::LemurQuestionAnswer

Inherits:
Object
  • Object
show all
Defined in:
lib/assemblyai/lemur/types/lemur_question_answer.rb

Overview

An answer generated by LeMUR and its question

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(question:, answer:, additional_properties: nil) ⇒ AssemblyAI::Lemur::LemurQuestionAnswer

Parameters:

  • question (String) —

    The question for LeMUR to answer

  • answer (String) —

    The answer generated by LeMUR

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

    Additional properties unmapped to the current class definition



26
27
28
29
30
31
 
# File 'lib/assemblyai/lemur/types/lemur_question_answer.rb', line 26

def initialize(question:, answer:, additional_properties: nil)
  @question = question
  @answer = answer
  @additional_properties = additional_properties
  @_field_set = { "question": question, "answer": answer }
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/assemblyai/lemur/types/lemur_question_answer.rb', line 15

def additional_properties
  @additional_properties
end

#answer ⇒ String (readonly)

Returns The answer generated by LeMUR.

Returns:

  • (String) —

    The answer generated by LeMUR



13
14
15
 
# File 'lib/assemblyai/lemur/types/lemur_question_answer.rb', line 13

def answer
  @answer
end

#question ⇒ String (readonly)

Returns The question for LeMUR to answer.

Returns:

  • (String) —

    The question for LeMUR to answer



11
12
13
 
# File 'lib/assemblyai/lemur/types/lemur_question_answer.rb', line 11

def question
  @question
end

Class Method Details

.from_json(json_object:) ⇒ AssemblyAI::Lemur::LemurQuestionAnswer

Deserialize a JSON object to an instance of LemurQuestionAnswer

Parameters:

  • json_object (String)

Returns:



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/assemblyai/lemur/types/lemur_question_answer.rb', line 37

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  question = struct["question"]
  answer = struct["answer"]
  new(
    question: question,
    answer: answer,
    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) 


61
62
63
64
 
# File 'lib/assemblyai/lemur/types/lemur_question_answer.rb', line 61

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of LemurQuestionAnswer to a JSON object

Returns:

  • (String) 


51
52
53
 
# File 'lib/assemblyai/lemur/types/lemur_question_answer.rb', line 51

def to_json(*_args)
  @_field_set&.to_json
end