vapi_server_sdk 0.1.0 → 0.2.0

data/lib/vapi_server_sdk/types/custom_knowledge_base.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+require_relative "server"
+require "ostruct"
+require "json"
+
+module Vapi
+  class CustomKnowledgeBase
+    # @return [Vapi::Server] /**
+    #  This is where the knowledge base request will be sent.
+    #  Request Example:
+    #  POST https://{server.url}
+    #  Content-Type: application/json
+    #  {
+    #  "messsage": {
+    #  "type": "knowledge-base-request",
+    #  "messages": [
+    #  {
+    #  "role": "user",
+    #  "content": "Why is ocean blue?"
+    #  }
+    #  ],
+    #  ...other metadata about the call...
+    #  }
+    #  }
+    #  Response Expected:
+    #  ```
+    #  {
+    #  "message": {
+    #  "role": "assistant",
+    #  "content": "The ocean is blue because water absorbs everything but blue.",
+    #  }, // YOU CAN RETURN THE EXACT RESPONSE TO SPEAK
+    #  "documents": [
+    #  {
+    #  "content": "The ocean is blue primarily because water absorbs colors in
+    #  the red part of the light spectrum and scatters the blue light, making it more
+    #  visible to our eyes.",
+    #  "similarity": 1
+    #  },
+    #  {
+    #  "content": "Blue light is scattered more by the water molecules than other
+    #  colors, enhancing the blue appearance of the ocean.",
+    #  "similarity": .5
+    #  }
+    #  ] // OR, YOU CAN RETURN AN ARRAY OF DOCUMENTS THAT WILL BE SENT TO THE MODEL
+    #  }
+    #  ```
+    attr_reader :server
+    # @return [String] This is the id of the knowledge base.
+    attr_reader :id
+    # @return [String] This is the org id of the knowledge base.
+    attr_reader :org_id
+    # @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 server [Vapi::Server] /**
+    #  This is where the knowledge base request will be sent.
+    #  Request Example:
+    #  POST https://{server.url}
+    #  Content-Type: application/json
+    #  {
+    #  "messsage": {
+    #  "type": "knowledge-base-request",
+    #  "messages": [
+    #  {
+    #  "role": "user",
+    #  "content": "Why is ocean blue?"
+    #  }
+    #  ],
+    #  ...other metadata about the call...
+    #  }
+    #  }
+    #  Response Expected:
+    #  ```
+    #  {
+    #  "message": {
+    #  "role": "assistant",
+    #  "content": "The ocean is blue because water absorbs everything but blue.",
+    #  }, // YOU CAN RETURN THE EXACT RESPONSE TO SPEAK
+    #  "documents": [
+    #  {
+    #  "content": "The ocean is blue primarily because water absorbs colors in
+    #  the red part of the light spectrum and scatters the blue light, making it more
+    #  visible to our eyes.",
+    #  "similarity": 1
+    #  },
+    #  {
+    #  "content": "Blue light is scattered more by the water molecules than other
+    #  colors, enhancing the blue appearance of the ocean.",
+    #  "similarity": .5
+    #  }
+    #  ] // OR, YOU CAN RETURN AN ARRAY OF DOCUMENTS THAT WILL BE SENT TO THE MODEL
+    #  }
+    #  ```
+    # @param id [String] This is the id of the knowledge base.
+    # @param org_id [String] This is the org id of the knowledge base.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CustomKnowledgeBase]
+    def initialize(server:, id:, org_id:, additional_properties: nil)
+      @server = server
+      @id = id
+      @org_id = org_id
+      @additional_properties = additional_properties
+      @_field_set = { "server": server, "id": id, "orgId": org_id }
+    end
+
+    # Deserialize a JSON object to an instance of CustomKnowledgeBase
+    #
+    # @param json_object [String]
+    # @return [Vapi::CustomKnowledgeBase]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      if parsed_json["server"].nil?
+        server = nil
+      else
+        server = parsed_json["server"].to_json
+        server = Vapi::Server.from_json(json_object: server)
+      end
+      id = parsed_json["id"]
+      org_id = parsed_json["orgId"]
+      new(
+        server: server,
+        id: id,
+        org_id: org_id,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CustomKnowledgeBase 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:)
+      Vapi::Server.validate_raw(obj: obj.server)
+      obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.org_id.is_a?(String) != false || raise("Passed value for field obj.org_id is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/custom_llm_credential.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
+require_relative "o_auth_2_authentication_plan"
 require "date"
+require_relative "oauth_2_authentication_session"
 require "ostruct"
 require "json"
 
@@ -10,6 +12,9 @@ module Vapi
     attr_reader :provider
     # @return [String] This is not returned in the API.
     attr_reader :api_key
+    # @return [Vapi::OAuth2AuthenticationPlan] This is the authentication plan. Currently supports OAuth2 RFC 6749. To use
+    #  Bearer authentication, use apiKey
+    attr_reader :authentication_plan
     # @return [String] This is the unique identifier for the credential.
     attr_reader :id
     # @return [String] This is the unique identifier for the org that this credential belongs to.
@@ -18,6 +23,11 @@ module Vapi
     attr_reader :created_at
     # @return [DateTime] This is the ISO 8601 date-time string of when the assistant was last updated.
     attr_reader :updated_at
+    # @return [Vapi::Oauth2AuthenticationSession] This is the authentication session for the credential. Available for credentials
+    #  that have an authentication plan.
+    attr_reader :authentication_session
+    # @return [String] This is the name of credential. This is just for your reference.
+    attr_reader :name
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -28,28 +38,42 @@ module Vapi
 
     # @param provider [String]
     # @param api_key [String] This is not returned in the API.
+    # @param authentication_plan [Vapi::OAuth2AuthenticationPlan] This is the authentication plan. Currently supports OAuth2 RFC 6749. To use
+    #  Bearer authentication, use apiKey
     # @param id [String] This is the unique identifier for the credential.
     # @param org_id [String] This is the unique identifier for the org that this credential belongs to.
     # @param created_at [DateTime] This is the ISO 8601 date-time string of when the credential was created.
     # @param updated_at [DateTime] This is the ISO 8601 date-time string of when the assistant was last updated.
+    # @param authentication_session [Vapi::Oauth2AuthenticationSession] This is the authentication session for the credential. Available for credentials
+    #  that have an authentication plan.
+    # @param name [String] This is the name of credential. This is just for your reference.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::CustomLlmCredential]
-    def initialize(provider:, api_key:, id:, org_id:, created_at:, updated_at:, additional_properties: nil)
+    def initialize(provider:, api_key:, id:, org_id:, created_at:, updated_at:, authentication_plan: OMIT,
+                   authentication_session: OMIT, name: OMIT, additional_properties: nil)
       @provider = provider
       @api_key = api_key
+      @authentication_plan = authentication_plan if authentication_plan != OMIT
       @id = id
       @org_id = org_id
       @created_at = created_at
       @updated_at = updated_at
+      @authentication_session = authentication_session if authentication_session != OMIT
+      @name = name if name != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "provider": provider,
         "apiKey": api_key,
+        "authenticationPlan": authentication_plan,
         "id": id,
         "orgId": org_id,
         "createdAt": created_at,
-        "updatedAt": updated_at
-      }
+        "updatedAt": updated_at,
+        "authenticationSession": authentication_session,
+        "name": name
+      }.reject do |_k, v|
+        v == OMIT
+      end
     end
 
     # Deserialize a JSON object to an instance of CustomLlmCredential
@@ -61,17 +85,33 @@ module Vapi
       parsed_json = JSON.parse(json_object)
       provider = parsed_json["provider"]
       api_key = parsed_json["apiKey"]
+      if parsed_json["authenticationPlan"].nil?
+        authentication_plan = nil
+      else
+        authentication_plan = parsed_json["authenticationPlan"].to_json
+        authentication_plan = Vapi::OAuth2AuthenticationPlan.from_json(json_object: authentication_plan)
+      end
       id = parsed_json["id"]
       org_id = parsed_json["orgId"]
       created_at = (DateTime.parse(parsed_json["createdAt"]) unless parsed_json["createdAt"].nil?)
       updated_at = (DateTime.parse(parsed_json["updatedAt"]) unless parsed_json["updatedAt"].nil?)
+      if parsed_json["authenticationSession"].nil?
+        authentication_session = nil
+      else
+        authentication_session = parsed_json["authenticationSession"].to_json
+        authentication_session = Vapi::Oauth2AuthenticationSession.from_json(json_object: authentication_session)
+      end
+      name = parsed_json["name"]
       new(
         provider: provider,
         api_key: api_key,
+        authentication_plan: authentication_plan,
         id: id,
         org_id: org_id,
         created_at: created_at,
         updated_at: updated_at,
+        authentication_session: authentication_session,
+        name: name,
         additional_properties: struct
       )
     end
@@ -92,10 +132,13 @@ module Vapi
     def self.validate_raw(obj:)
       obj.provider.is_a?(String) != false || raise("Passed value for field obj.provider is not the expected type, validation failed.")
       obj.api_key.is_a?(String) != false || raise("Passed value for field obj.api_key is not the expected type, validation failed.")
+      obj.authentication_plan.nil? || Vapi::OAuth2AuthenticationPlan.validate_raw(obj: obj.authentication_plan)
       obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
       obj.org_id.is_a?(String) != false || raise("Passed value for field obj.org_id is not the expected type, validation failed.")
       obj.created_at.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
       obj.updated_at.is_a?(DateTime) != false || raise("Passed value for field obj.updated_at is not the expected type, validation failed.")
+      obj.authentication_session.nil? || Vapi::Oauth2AuthenticationSession.validate_raw(obj: obj.authentication_session)
+      obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
     end
   end
 end

data/lib/vapi_server_sdk/types/custom_llm_model.rb

@@ -2,8 +2,8 @@
 
 require_relative "open_ai_message"
 require_relative "custom_llm_model_tools_item"
+require_relative "create_custom_knowledge_base_dto"
 require_relative "custom_llm_model_metadata_send_mode"
-require_relative "knowledge_base"
 require "ostruct"
 require "json"
 
@@ -19,6 +19,10 @@ module Vapi
     #  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::CustomLlmModelMetadataSendMode] This determines whether metadata is sent in requests to the custom provider.
     #  - `off` will not send any metadata. payload will look like `{ messages }`
     #  - `variable` will send `assistant.metadata` as a variable on the payload.
@@ -37,8 +41,6 @@ module Vapi
     # @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 [Vapi::KnowledgeBase] These are the options for the knowledge base.
-    attr_reader :knowledge_base
     # @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
@@ -69,6 +71,8 @@ module Vapi
     # @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 metadata_send_mode [Vapi::CustomLlmModelMetadataSendMode] This determines whether metadata is sent in requests to the custom provider.
     #  - `off` will not send any metadata. payload will look like `{ messages }`
     #  - `variable` will send `assistant.metadata` as a variable on the payload.
@@ -83,7 +87,6 @@ module Vapi
     # @param model [String] 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 knowledge_base [Vapi::KnowledgeBase] These are the options for the knowledge base.
     # @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
@@ -98,16 +101,17 @@ module Vapi
     #  @default 0
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::CustomLlmModel]
-    def initialize(url:, model:, messages: OMIT, tools: OMIT, tool_ids: OMIT, metadata_send_mode: OMIT,
-                   temperature: OMIT, knowledge_base: OMIT, max_tokens: OMIT, emotion_recognition_enabled: OMIT, num_fast_turns: OMIT, additional_properties: nil)
+    def initialize(url:, model:, messages: OMIT, tools: OMIT, tool_ids: OMIT, knowledge_base: OMIT, knowledge_base_id: OMIT,
+                   metadata_send_mode: 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
       @metadata_send_mode = metadata_send_mode if metadata_send_mode != OMIT
       @url = url
       @model = model
       @temperature = temperature if temperature != OMIT
-      @knowledge_base = knowledge_base if knowledge_base != 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
@@ -116,11 +120,12 @@ module Vapi
         "messages": messages,
         "tools": tools,
         "toolIds": tool_ids,
+        "knowledgeBase": knowledge_base,
+        "knowledgeBaseId": knowledge_base_id,
         "metadataSendMode": metadata_send_mode,
         "url": url,
         "model": model,
         "temperature": temperature,
-        "knowledgeBase": knowledge_base,
         "maxTokens": max_tokens,
         "emotionRecognitionEnabled": emotion_recognition_enabled,
         "numFastTurns": num_fast_turns
@@ -145,16 +150,17 @@ module Vapi
         Vapi::CustomLlmModelToolsItem.from_json(json_object: item)
       end
       tool_ids = parsed_json["toolIds"]
-      metadata_send_mode = parsed_json["metadataSendMode"]
-      url = parsed_json["url"]
-      model = parsed_json["model"]
-      temperature = parsed_json["temperature"]
       if parsed_json["knowledgeBase"].nil?
         knowledge_base = nil
       else
         knowledge_base = parsed_json["knowledgeBase"].to_json
-        knowledge_base = Vapi::KnowledgeBase.from_json(json_object: knowledge_base)
+        knowledge_base = Vapi::CreateCustomKnowledgeBaseDto.from_json(json_object: knowledge_base)
       end
+      knowledge_base_id = parsed_json["knowledgeBaseId"]
+      metadata_send_mode = parsed_json["metadataSendMode"]
+      url = parsed_json["url"]
+      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"]
@@ -162,11 +168,12 @@ module Vapi
         messages: messages,
         tools: tools,
         tool_ids: tool_ids,
+        knowledge_base: knowledge_base,
+        knowledge_base_id: knowledge_base_id,
         metadata_send_mode: metadata_send_mode,
         url: url,
         model: model,
         temperature: temperature,
-        knowledge_base: knowledge_base,
         max_tokens: max_tokens,
         emotion_recognition_enabled: emotion_recognition_enabled,
         num_fast_turns: num_fast_turns,
@@ -191,11 +198,12 @@ module Vapi
       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.metadata_send_mode&.is_a?(Vapi::CustomLlmModelMetadataSendMode) != false || raise("Passed value for field obj.metadata_send_mode is not the expected type, validation failed.")
       obj.url.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
       obj.model.is_a?(String) != 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.knowledge_base.nil? || Vapi::KnowledgeBase.validate_raw(obj: obj.knowledge_base)
       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.")

data/lib/vapi_server_sdk/types/custom_message.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require_relative "text_content"
+require "ostruct"
+require "json"
+
+module Vapi
+  class CustomMessage
+    # @return [Array<Vapi::TextContent>] This is an alternative to the `content` property. It allows to specify variants
+    #  of the same content, one per language.
+    #  Usage:
+    #  - If your assistants are multilingual, you can provide content for each
+    #  language.
+    #  - If you don't provide content for a language, the first item in the array will
+    #  be automatically translated to the active language at that moment.
+    #  This will override the `content` property.
+    attr_reader :contents
+    # @return [String] This is a custom message.
+    attr_reader :type
+    # @return [String] This is the content that the assistant will say when this message is triggered.
+    attr_reader :content
+    # @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 contents [Array<Vapi::TextContent>] This is an alternative to the `content` property. It allows to specify variants
+    #  of the same content, one per language.
+    #  Usage:
+    #  - If your assistants are multilingual, you can provide content for each
+    #  language.
+    #  - If you don't provide content for a language, the first item in the array will
+    #  be automatically translated to the active language at that moment.
+    #  This will override the `content` property.
+    # @param type [String] This is a custom message.
+    # @param content [String] This is the content that the assistant will say when this message is triggered.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CustomMessage]
+    def initialize(type:, contents: OMIT, content: OMIT, additional_properties: nil)
+      @contents = contents if contents != OMIT
+      @type = type
+      @content = content if content != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "contents": contents, "type": type, "content": content }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of CustomMessage
+    #
+    # @param json_object [String]
+    # @return [Vapi::CustomMessage]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      contents = parsed_json["contents"]&.map do |item|
+        item = item.to_json
+        Vapi::TextContent.from_json(json_object: item)
+      end
+      type = parsed_json["type"]
+      content = parsed_json["content"]
+      new(
+        contents: contents,
+        type: type,
+        content: content,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CustomMessage 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.contents&.is_a?(Array) != false || raise("Passed value for field obj.contents 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.")
+      obj.content&.is_a?(String) != false || raise("Passed value for field obj.content is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/custom_transcriber.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require_relative "server"
+require "ostruct"
+require "json"
+
+module Vapi
+  class CustomTranscriber
+    # @return [Vapi::Server] This is where the transcription request will be sent.
+    #  Usage:
+    #  1. Vapi will initiate a websocket connection with `server.url`.
+    #  2. Vapi will send an initial text frame with the sample rate. Format:
+    #  ```
+    #  {
+    #  "type": "start",
+    #  "encoding": "linear16", // 16-bit raw PCM format
+    #  "container": "raw",
+    #  "sampleRate": {{sampleRate}},
+    #  "channels": 2 // customer is channel 0, assistant is channel 1
+    #  }
+    #  ```
+    #  3. Vapi will send the audio data in 16-bit raw PCM format as binary frames.
+    #  4. You can read the messages something like this:
+    #  ```
+    #  ws.on('message', (data, isBinary) => {
+    #  if (isBinary) {
+    #  pcmBuffer = Buffer.concat([pcmBuffer, data]);
+    #  console.log(`Received PCM data, buffer size: ${pcmBuffer.length}`);
+    #  } else {
+    #  console.log('Received message:', JSON.parse(data.toString()));
+    #  }
+    #  });
+    #  ```
+    #  5. You will respond with transcriptions as you have them. Format:
+    #  ```
+    #  {
+    #  "type": "transcriber-response",
+    #  "transcription": "Hello, world!",
+    #  "channel": "customer" | "assistant"
+    #  }
+    #  ```
+    attr_reader :server
+    # @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 server [Vapi::Server] This is where the transcription request will be sent.
+    #  Usage:
+    #  1. Vapi will initiate a websocket connection with `server.url`.
+    #  2. Vapi will send an initial text frame with the sample rate. Format:
+    #  ```
+    #  {
+    #  "type": "start",
+    #  "encoding": "linear16", // 16-bit raw PCM format
+    #  "container": "raw",
+    #  "sampleRate": {{sampleRate}},
+    #  "channels": 2 // customer is channel 0, assistant is channel 1
+    #  }
+    #  ```
+    #  3. Vapi will send the audio data in 16-bit raw PCM format as binary frames.
+    #  4. You can read the messages something like this:
+    #  ```
+    #  ws.on('message', (data, isBinary) => {
+    #  if (isBinary) {
+    #  pcmBuffer = Buffer.concat([pcmBuffer, data]);
+    #  console.log(`Received PCM data, buffer size: ${pcmBuffer.length}`);
+    #  } else {
+    #  console.log('Received message:', JSON.parse(data.toString()));
+    #  }
+    #  });
+    #  ```
+    #  5. You will respond with transcriptions as you have them. Format:
+    #  ```
+    #  {
+    #  "type": "transcriber-response",
+    #  "transcription": "Hello, world!",
+    #  "channel": "customer" | "assistant"
+    #  }
+    #  ```
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CustomTranscriber]
+    def initialize(server:, additional_properties: nil)
+      @server = server
+      @additional_properties = additional_properties
+      @_field_set = { "server": server }
+    end
+
+    # Deserialize a JSON object to an instance of CustomTranscriber
+    #
+    # @param json_object [String]
+    # @return [Vapi::CustomTranscriber]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      if parsed_json["server"].nil?
+        server = nil
+      else
+        server = parsed_json["server"].to_json
+        server = Vapi::Server.from_json(json_object: server)
+      end
+      new(server: server, additional_properties: struct)
+    end
+
+    # Serialize an instance of CustomTranscriber 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:)
+      Vapi::Server.validate_raw(obj: obj.server)
+    end
+  end
+end