Class: Vapi::StartSpeakingPlanSmartEndpointingPlan

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

Overview

This is the plan for smart endpointing. Pick between Vapi smart endpointing or

LiveKit smart endpointing (or nothing). We strongly recommend using livekit
endpointing when working in English. LiveKit endpointing is not supported in
other languages, yet.
If this is set, it will override and take precedence over
`transcriptionEndpointingPlan`.
This plan will still be overridden by any matching `customEndpointingRules`.

Class Method Summary collapse

Class Method Details

.from_json(json_object:) ⇒ Vapi::StartSpeakingPlanSmartEndpointingPlan

Deserialize a JSON object to an instance of

StartSpeakingPlanSmartEndpointingPlan

Parameters:

  • json_object (String)

Returns:



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/vapi_server_sdk/types/start_speaking_plan_smart_endpointing_plan.rb', line 22

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  begin
    Vapi::VapiSmartEndpointingPlan.validate_raw(obj: struct)
    return Vapi::VapiSmartEndpointingPlan.from_json(json_object: struct) unless struct.nil?

    return nil
  rescue StandardError
    # noop
  end
  begin
    Vapi::LivekitSmartEndpointingPlan.validate_raw(obj: struct)
    return Vapi::LivekitSmartEndpointingPlan.from_json(json_object: struct) unless struct.nil?

    return nil
  rescue StandardError
    # noop
  end
  begin
    Vapi::CustomEndpointingModelSmartEndpointingPlan.validate_raw(obj: struct)
    return Vapi::CustomEndpointingModelSmartEndpointingPlan.from_json(json_object: struct) unless struct.nil?

    return nil
  rescue StandardError
    # noop
  end
  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) 


57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/vapi_server_sdk/types/start_speaking_plan_smart_endpointing_plan.rb', line 57

def self.validate_raw(obj:)
  begin
    return Vapi::VapiSmartEndpointingPlan.validate_raw(obj: obj)
  rescue StandardError
    # noop
  end
  begin
    return Vapi::LivekitSmartEndpointingPlan.validate_raw(obj: obj)
  rescue StandardError
    # noop
  end
  begin
    return Vapi::CustomEndpointingModelSmartEndpointingPlan.validate_raw(obj: obj)
  rescue StandardError
    # noop
  end
  raise("Passed value matched no type within the union, validation failed.")
end