vapi_server_sdk 0.4.0 → 0.9.1

data/lib/vapi_server_sdk/types/cartesia_transcriber_language.rb

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+module Vapi
+  class CartesiaTranscriberLanguage
+    AA = "aa"
+    AB = "ab"
+    AE = "ae"
+    AF = "af"
+    AK = "ak"
+    AM = "am"
+    AN = "an"
+    AR = "ar"
+    AS = "as"
+    AV = "av"
+    AY = "ay"
+    AZ = "az"
+    BA = "ba"
+    BE = "be"
+    BG = "bg"
+    BH = "bh"
+    BI = "bi"
+    BM = "bm"
+    BN = "bn"
+    BO = "bo"
+    BR = "br"
+    BS = "bs"
+    CA = "ca"
+    CE = "ce"
+    CH = "ch"
+    CO = "co"
+    CR = "cr"
+    CS = "cs"
+    CU = "cu"
+    CV = "cv"
+    CY = "cy"
+    DA = "da"
+    DE = "de"
+    DV = "dv"
+    DZ = "dz"
+    EE = "ee"
+    EL = "el"
+    EN = "en"
+    EO = "eo"
+    ES = "es"
+    ET = "et"
+    EU = "eu"
+    FA = "fa"
+    FF = "ff"
+    FI = "fi"
+    FJ = "fj"
+    FO = "fo"
+    FR = "fr"
+    FY = "fy"
+    GA = "ga"
+    GD = "gd"
+    GL = "gl"
+    GN = "gn"
+    GU = "gu"
+    GV = "gv"
+    HA = "ha"
+    HE = "he"
+    HI = "hi"
+    HO = "ho"
+    HR = "hr"
+    HT = "ht"
+    HU = "hu"
+    HY = "hy"
+    HZ = "hz"
+    IA = "ia"
+    ID = "id"
+    IE = "ie"
+    IG = "ig"
+    II = "ii"
+    IK = "ik"
+    IO = "io"
+    IS = "is"
+    IT = "it"
+    IU = "iu"
+    JA = "ja"
+    JV = "jv"
+    KA = "ka"
+    KG = "kg"
+    KI = "ki"
+    KJ = "kj"
+    KK = "kk"
+    KL = "kl"
+    KM = "km"
+    KN = "kn"
+    KO = "ko"
+    KR = "kr"
+    KS = "ks"
+    KU = "ku"
+    KV = "kv"
+    KW = "kw"
+    KY = "ky"
+    LA = "la"
+    LB = "lb"
+    LG = "lg"
+    LI = "li"
+    LN = "ln"
+    LO = "lo"
+    LT = "lt"
+    LU = "lu"
+    LV = "lv"
+    MG = "mg"
+    MH = "mh"
+    MI = "mi"
+    MK = "mk"
+    ML = "ml"
+    MN = "mn"
+    MR = "mr"
+    MS = "ms"
+    MT = "mt"
+    MY = "my"
+    NA = "na"
+    NB = "nb"
+    ND = "nd"
+    NE = "ne"
+    NG = "ng"
+    NL = "nl"
+    NN = "nn"
+    NO = "no"
+    NR = "nr"
+    NV = "nv"
+    NY = "ny"
+    OC = "oc"
+    OJ = "oj"
+    OM = "om"
+    OR = "or"
+    OS = "os"
+    PA = "pa"
+    PI = "pi"
+    PL = "pl"
+    PS = "ps"
+    PT = "pt"
+    QU = "qu"
+    RM = "rm"
+    RN = "rn"
+    RO = "ro"
+    RU = "ru"
+    RW = "rw"
+    SA = "sa"
+    SC = "sc"
+    SD = "sd"
+    SE = "se"
+    SG = "sg"
+    SI = "si"
+    SK = "sk"
+    SL = "sl"
+    SM = "sm"
+    SN = "sn"
+    SO = "so"
+    SQ = "sq"
+    SR = "sr"
+    SS = "ss"
+    ST = "st"
+    SU = "su"
+    SV = "sv"
+    SW = "sw"
+    TA = "ta"
+    TE = "te"
+    TG = "tg"
+    TH = "th"
+    TI = "ti"
+    TK = "tk"
+    TL = "tl"
+    TN = "tn"
+    TO = "to"
+    TR = "tr"
+    TS = "ts"
+    TT = "tt"
+    TW = "tw"
+    TY = "ty"
+    UG = "ug"
+    UK = "uk"
+    UR = "ur"
+    UZ = "uz"
+    VE = "ve"
+    VI = "vi"
+    VO = "vo"
+    WA = "wa"
+    WO = "wo"
+    XH = "xh"
+    YI = "yi"
+    YUE = "yue"
+    YO = "yo"
+    ZA = "za"
+    ZH = "zh"
+    ZU = "zu"
+  end
+end

data/lib/vapi_server_sdk/types/cartesia_voice.rb

@@ -2,6 +2,7 @@
 
 require_relative "cartesia_voice_model"
 require_relative "cartesia_voice_language"
+require_relative "cartesia_experimental_controls"
 require_relative "chunk_plan"
 require_relative "fallback_plan"
 require "ostruct"
@@ -9,17 +10,21 @@ require "json"
 
 module Vapi
   class CartesiaVoice
+    # @return [Boolean] This is the flag to toggle voice caching for the assistant.
+    attr_reader :caching_enabled
+    # @return [String] The ID of the particular voice you want to use.
+    attr_reader :voice_id
     # @return [Vapi::CartesiaVoiceModel] This is the model that will be used. This is optional and will default to the
     #  correct model for the voiceId.
     attr_reader :model
     # @return [Vapi::CartesiaVoiceLanguage] This is the language that will be used. This is optional and will default to the
     #  correct language for the voiceId.
     attr_reader :language
+    # @return [Vapi::CartesiaExperimentalControls] Experimental controls for Cartesia voice generation
+    attr_reader :experimental_controls
     # @return [Vapi::ChunkPlan] This is the plan for chunking the model output before it is sent to the voice
     #  provider.
     attr_reader :chunk_plan
-    # @return [String] This is the provider-specific ID that will be used.
-    attr_reader :voice_id
     # @return [Vapi::FallbackPlan] This is the plan for voice provider fallbacks in the event that the primary
     #  voice provider fails.
     attr_reader :fallback_plan
@@ -31,30 +36,36 @@ module Vapi
 
     OMIT = Object.new
 
+    # @param caching_enabled [Boolean] This is the flag to toggle voice caching for the assistant.
+    # @param voice_id [String] The ID of the particular voice you want to use.
     # @param model [Vapi::CartesiaVoiceModel] This is the model that will be used. This is optional and will default to the
     #  correct model for the voiceId.
     # @param language [Vapi::CartesiaVoiceLanguage] This is the language that will be used. This is optional and will default to the
     #  correct language for the voiceId.
+    # @param experimental_controls [Vapi::CartesiaExperimentalControls] Experimental controls for Cartesia voice generation
     # @param chunk_plan [Vapi::ChunkPlan] This is the plan for chunking the model output before it is sent to the voice
     #  provider.
-    # @param voice_id [String] This is the provider-specific ID that will be used.
     # @param fallback_plan [Vapi::FallbackPlan] This is the plan for voice provider fallbacks in the event that the primary
     #  voice provider fails.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::CartesiaVoice]
-    def initialize(voice_id:, model: OMIT, language: OMIT, chunk_plan: OMIT, fallback_plan: OMIT,
-                   additional_properties: nil)
+    def initialize(voice_id:, caching_enabled: OMIT, model: OMIT, language: OMIT, experimental_controls: OMIT,
+                   chunk_plan: OMIT, fallback_plan: OMIT, additional_properties: nil)
+      @caching_enabled = caching_enabled if caching_enabled != OMIT
+      @voice_id = voice_id
       @model = model if model != OMIT
       @language = language if language != OMIT
+      @experimental_controls = experimental_controls if experimental_controls != OMIT
       @chunk_plan = chunk_plan if chunk_plan != OMIT
-      @voice_id = voice_id
       @fallback_plan = fallback_plan if fallback_plan != OMIT
       @additional_properties = additional_properties
       @_field_set = {
+        "cachingEnabled": caching_enabled,
+        "voiceId": voice_id,
         "model": model,
         "language": language,
+        "experimentalControls": experimental_controls,
         "chunkPlan": chunk_plan,
-        "voiceId": voice_id,
         "fallbackPlan": fallback_plan
       }.reject do |_k, v|
         v == OMIT
@@ -68,15 +79,22 @@ module Vapi
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
+      caching_enabled = parsed_json["cachingEnabled"]
+      voice_id = parsed_json["voiceId"]
       model = parsed_json["model"]
       language = parsed_json["language"]
+      if parsed_json["experimentalControls"].nil?
+        experimental_controls = nil
+      else
+        experimental_controls = parsed_json["experimentalControls"].to_json
+        experimental_controls = Vapi::CartesiaExperimentalControls.from_json(json_object: experimental_controls)
+      end
       if parsed_json["chunkPlan"].nil?
         chunk_plan = nil
       else
         chunk_plan = parsed_json["chunkPlan"].to_json
         chunk_plan = Vapi::ChunkPlan.from_json(json_object: chunk_plan)
       end
-      voice_id = parsed_json["voiceId"]
       if parsed_json["fallbackPlan"].nil?
         fallback_plan = nil
       else
@@ -84,10 +102,12 @@ module Vapi
         fallback_plan = Vapi::FallbackPlan.from_json(json_object: fallback_plan)
       end
       new(
+        caching_enabled: caching_enabled,
+        voice_id: voice_id,
         model: model,
         language: language,
+        experimental_controls: experimental_controls,
         chunk_plan: chunk_plan,
-        voice_id: voice_id,
         fallback_plan: fallback_plan,
         additional_properties: struct
       )
@@ -107,10 +127,12 @@ module Vapi
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
+      obj.caching_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.caching_enabled is not the expected type, validation failed.")
+      obj.voice_id.is_a?(String) != false || raise("Passed value for field obj.voice_id is not the expected type, validation failed.")
       obj.model&.is_a?(Vapi::CartesiaVoiceModel) != false || raise("Passed value for field obj.model is not the expected type, validation failed.")
       obj.language&.is_a?(Vapi::CartesiaVoiceLanguage) != false || raise("Passed value for field obj.language is not the expected type, validation failed.")
+      obj.experimental_controls.nil? || Vapi::CartesiaExperimentalControls.validate_raw(obj: obj.experimental_controls)
       obj.chunk_plan.nil? || Vapi::ChunkPlan.validate_raw(obj: obj.chunk_plan)
-      obj.voice_id.is_a?(String) != false || raise("Passed value for field obj.voice_id is not the expected type, validation failed.")
       obj.fallback_plan.nil? || Vapi::FallbackPlan.validate_raw(obj: obj.fallback_plan)
     end
   end

data/lib/vapi_server_sdk/types/cartesia_voice_model.rb

@@ -4,6 +4,7 @@ module Vapi
   # This is the model that will be used. This is optional and will default to the
   #  correct model for the voiceId.
   class CartesiaVoiceModel
+    SONIC_2 = "sonic-2"
     SONIC_ENGLISH = "sonic-english"
     SONIC_MULTILINGUAL = "sonic-multilingual"
     SONIC_PREVIEW = "sonic-preview"

data/lib/vapi_server_sdk/types/cerebras_model.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+require_relative "open_ai_message"
+require_relative "cerebras_model_tools_item"
+require_relative "create_custom_knowledge_base_dto"
+require_relative "cerebras_model_model"
+require "ostruct"
+require "json"
+
+module Vapi
+  class CerebrasModel
+    # @return [Array<Vapi::OpenAiMessage>] This is the starting state for the conversation.
+    attr_reader :messages
+    # @return [Array<Vapi::CerebrasModelToolsItem>] These are the tools that the assistant can use during the call. To use existing
+    #  tools, use `toolIds`.
+    #  Both `tools` and `toolIds` can be used together.
+    attr_reader :tools
+    # @return [Array<String>] These are the tools that the assistant can use during the call. To use transient
+    #  tools, use `tools`.
+    #  Both `tools` and `toolIds` can be used together.
+    attr_reader :tool_ids
+    # @return [Vapi::CreateCustomKnowledgeBaseDto] These are the options for the knowledge base.
+    attr_reader :knowledge_base
+    # @return [String] This is the ID of the knowledge base the model will use.
+    attr_reader :knowledge_base_id
+    # @return [Vapi::CerebrasModelModel] This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b
+    attr_reader :model
+    # @return [Float] This is the temperature that will be used for calls. Default is 0 to leverage
+    #  caching for lower latency.
+    attr_reader :temperature
+    # @return [Float] This is the max number of tokens that the assistant will be allowed to generate
+    #  in each turn of the conversation. Default is 250.
+    attr_reader :max_tokens
+    # @return [Boolean] This determines whether we detect user's emotion while they speak and send it as
+    #  an additional info to model.
+    #  Default `false` because the model is usually are good at understanding the
+    #  user's emotion from text.
+    #  @default false
+    attr_reader :emotion_recognition_enabled
+    # @return [Float] This sets how many turns at the start of the conversation to use a smaller,
+    #  faster model from the same provider before switching to the primary model.
+    #  Example, gpt-3.5-turbo if provider is openai.
+    #  Default is 0.
+    #  @default 0
+    attr_reader :num_fast_turns
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param messages [Array<Vapi::OpenAiMessage>] This is the starting state for the conversation.
+    # @param tools [Array<Vapi::CerebrasModelToolsItem>] These are the tools that the assistant can use during the call. To use existing
+    #  tools, use `toolIds`.
+    #  Both `tools` and `toolIds` can be used together.
+    # @param tool_ids [Array<String>] These are the tools that the assistant can use during the call. To use transient
+    #  tools, use `tools`.
+    #  Both `tools` and `toolIds` can be used together.
+    # @param knowledge_base [Vapi::CreateCustomKnowledgeBaseDto] These are the options for the knowledge base.
+    # @param knowledge_base_id [String] This is the ID of the knowledge base the model will use.
+    # @param model [Vapi::CerebrasModelModel] This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b
+    # @param temperature [Float] This is the temperature that will be used for calls. Default is 0 to leverage
+    #  caching for lower latency.
+    # @param max_tokens [Float] This is the max number of tokens that the assistant will be allowed to generate
+    #  in each turn of the conversation. Default is 250.
+    # @param emotion_recognition_enabled [Boolean] This determines whether we detect user's emotion while they speak and send it as
+    #  an additional info to model.
+    #  Default `false` because the model is usually are good at understanding the
+    #  user's emotion from text.
+    #  @default false
+    # @param num_fast_turns [Float] This sets how many turns at the start of the conversation to use a smaller,
+    #  faster model from the same provider before switching to the primary model.
+    #  Example, gpt-3.5-turbo if provider is openai.
+    #  Default is 0.
+    #  @default 0
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CerebrasModel]
+    def initialize(model:, messages: OMIT, tools: OMIT, tool_ids: OMIT, knowledge_base: OMIT, knowledge_base_id: OMIT,
+                   temperature: OMIT, max_tokens: OMIT, emotion_recognition_enabled: OMIT, num_fast_turns: OMIT, additional_properties: nil)
+      @messages = messages if messages != OMIT
+      @tools = tools if tools != OMIT
+      @tool_ids = tool_ids if tool_ids != OMIT
+      @knowledge_base = knowledge_base if knowledge_base != OMIT
+      @knowledge_base_id = knowledge_base_id if knowledge_base_id != OMIT
+      @model = model
+      @temperature = temperature if temperature != OMIT
+      @max_tokens = max_tokens if max_tokens != OMIT
+      @emotion_recognition_enabled = emotion_recognition_enabled if emotion_recognition_enabled != OMIT
+      @num_fast_turns = num_fast_turns if num_fast_turns != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "messages": messages,
+        "tools": tools,
+        "toolIds": tool_ids,
+        "knowledgeBase": knowledge_base,
+        "knowledgeBaseId": knowledge_base_id,
+        "model": model,
+        "temperature": temperature,
+        "maxTokens": max_tokens,
+        "emotionRecognitionEnabled": emotion_recognition_enabled,
+        "numFastTurns": num_fast_turns
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of CerebrasModel
+    #
+    # @param json_object [String]
+    # @return [Vapi::CerebrasModel]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      messages = parsed_json["messages"]&.map do |item|
+        item = item.to_json
+        Vapi::OpenAiMessage.from_json(json_object: item)
+      end
+      tools = parsed_json["tools"]&.map do |item|
+        item = item.to_json
+        Vapi::CerebrasModelToolsItem.from_json(json_object: item)
+      end
+      tool_ids = parsed_json["toolIds"]
+      if parsed_json["knowledgeBase"].nil?
+        knowledge_base = nil
+      else
+        knowledge_base = parsed_json["knowledgeBase"].to_json
+        knowledge_base = Vapi::CreateCustomKnowledgeBaseDto.from_json(json_object: knowledge_base)
+      end
+      knowledge_base_id = parsed_json["knowledgeBaseId"]
+      model = parsed_json["model"]
+      temperature = parsed_json["temperature"]
+      max_tokens = parsed_json["maxTokens"]
+      emotion_recognition_enabled = parsed_json["emotionRecognitionEnabled"]
+      num_fast_turns = parsed_json["numFastTurns"]
+      new(
+        messages: messages,
+        tools: tools,
+        tool_ids: tool_ids,
+        knowledge_base: knowledge_base,
+        knowledge_base_id: knowledge_base_id,
+        model: model,
+        temperature: temperature,
+        max_tokens: max_tokens,
+        emotion_recognition_enabled: emotion_recognition_enabled,
+        num_fast_turns: num_fast_turns,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CerebrasModel to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # 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.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.messages&.is_a?(Array) != false || raise("Passed value for field obj.messages is not the expected type, validation failed.")
+      obj.tools&.is_a?(Array) != false || raise("Passed value for field obj.tools is not the expected type, validation failed.")
+      obj.tool_ids&.is_a?(Array) != false || raise("Passed value for field obj.tool_ids is not the expected type, validation failed.")
+      obj.knowledge_base.nil? || Vapi::CreateCustomKnowledgeBaseDto.validate_raw(obj: obj.knowledge_base)
+      obj.knowledge_base_id&.is_a?(String) != false || raise("Passed value for field obj.knowledge_base_id is not the expected type, validation failed.")
+      obj.model.is_a?(Vapi::CerebrasModelModel) != false || raise("Passed value for field obj.model is not the expected type, validation failed.")
+      obj.temperature&.is_a?(Float) != false || raise("Passed value for field obj.temperature is not the expected type, validation failed.")
+      obj.max_tokens&.is_a?(Float) != false || raise("Passed value for field obj.max_tokens is not the expected type, validation failed.")
+      obj.emotion_recognition_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.emotion_recognition_enabled is not the expected type, validation failed.")
+      obj.num_fast_turns&.is_a?(Float) != false || raise("Passed value for field obj.num_fast_turns is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/cerebras_model_model.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b
+  class CerebrasModelModel
+    LLAMA_318_B = "llama3.1-8b"
+    LLAMA_3370_B = "llama-3.3-70b"
+  end
+end