Class: Vapi::ResponseOutputText

Inherits:
Object
  • Object
show all
Defined in:
lib/vapi_server_sdk/types/response_output_text.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(annotations:, text:, type:, additional_properties: nil) ⇒ Vapi::ResponseOutputText

Parameters:

  • annotations (Array<Hash{String => Object}>) —

    Annotations in the text output

  • text (String) —

    The text output from the model

  • type (String) —

    The type of the output text

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

    Additional properties unmapped to the current class definition



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

def initialize(annotations:, text:, type:, additional_properties: nil)
  @annotations = annotations
  @text = text
  @type = type
  @additional_properties = additional_properties
  @_field_set = { "annotations": annotations, "text": text, "type": type }
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/vapi_server_sdk/types/response_output_text.rb', line 15

def additional_properties
  @additional_properties
end

#annotations ⇒ Array<Hash{String => Object}> (readonly)

Returns Annotations in the text output.

Returns:

  • (Array<Hash{String => Object}>) —

    Annotations in the text output



9
10
11
 
# File 'lib/vapi_server_sdk/types/response_output_text.rb', line 9

def annotations
  @annotations
end

#text ⇒ String (readonly)

Returns The text output from the model.

Returns:

  • (String) —

    The text output from the model



11
12
13
 
# File 'lib/vapi_server_sdk/types/response_output_text.rb', line 11

def text
  @text
end

#type ⇒ String (readonly)

Returns The type of the output text.

Returns:

  • (String) —

    The type of the output text



13
14
15
 
# File 'lib/vapi_server_sdk/types/response_output_text.rb', line 13

def type
  @type
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::ResponseOutputText

Deserialize a JSON object to an instance of ResponseOutputText

Parameters:

  • json_object (String)

Returns:



39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/vapi_server_sdk/types/response_output_text.rb', line 39

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


66
67
68
69
70
 
# File 'lib/vapi_server_sdk/types/response_output_text.rb', line 66

def self.validate_raw(obj:)
  obj.annotations.is_a?(Array) != false || raise("Passed value for field obj.annotations 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.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of ResponseOutputText to a JSON object

Returns:

  • (String) 


56
57
58
 
# File 'lib/vapi_server_sdk/types/response_output_text.rb', line 56

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