vapi_server_sdk 0.0.0.pre.alpha7 → 0.2.0

data/lib/vapi_server_sdk/types/server_message_tool_calls_tool_with_tool_call_list_item.rb

@@ -7,22 +7,6 @@ require_relative "make_tool_with_tool_call"
 
 module Vapi
   class ServerMessageToolCallsToolWithToolCallListItem
-    # @return [Object]
-    attr_reader :member
-    # @return [String]
-    attr_reader :discriminant
-
-    private_class_method :new
-    alias kind_of? is_a?
-
-    # @param member [Object]
-    # @param discriminant [String]
-    # @return [Vapi::ServerMessageToolCallsToolWithToolCallListItem]
-    def initialize(member:, discriminant:)
-      @member = member
-      @discriminant = discriminant
-    end
-
     # Deserialize a JSON object to an instance of
     #  ServerMessageToolCallsToolWithToolCallListItem
     #
@@ -30,34 +14,55 @@ module Vapi
     # @return [Vapi::ServerMessageToolCallsToolWithToolCallListItem]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
-      member = case struct.type
-               when "function"
-                 Vapi::FunctionToolWithToolCall.from_json(json_object: json_object)
-               when "ghl"
-                 Vapi::GhlToolWithToolCall.from_json(json_object: json_object)
-               when "make"
-                 Vapi::MakeToolWithToolCall.from_json(json_object: json_object)
-               else
-                 Vapi::FunctionToolWithToolCall.from_json(json_object: json_object)
-               end
-      new(member: member, discriminant: struct.type)
-    end
+      begin
+        Vapi::FunctionToolWithToolCall.validate_raw(obj: struct)
+        return Vapi::FunctionToolWithToolCall.from_json(json_object: struct) unless struct.nil?
 
-    # For Union Types, to_json functionality is delegated to the wrapped member.
-    #
-    # @return [String]
-    def to_json(*_args)
-      case @discriminant
-      when "function"
-        { **@member.to_json, type: @discriminant }.to_json
-      when "ghl"
-        { **@member.to_json, type: @discriminant }.to_json
-      when "make"
-        { **@member.to_json, type: @discriminant }.to_json
-      else
-        { "type": @discriminant, value: @member }.to_json
+        return nil
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vapi::GhlToolWithToolCall.validate_raw(obj: struct)
+        return Vapi::GhlToolWithToolCall.from_json(json_object: struct) unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
       end
-      @member.to_json
+      begin
+        Vapi::MakeToolWithToolCall.validate_raw(obj: struct)
+        return Vapi::MakeToolWithToolCall.from_json(json_object: struct) unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      begin
+        struct.is_a?(Object) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+        return struct unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      begin
+        struct.is_a?(Object) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+        return struct unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      begin
+        struct.is_a?(Object) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+        return struct unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      struct
     end
 
     # Leveraged for Union-type generation, validate_raw attempts to parse the given
@@ -67,42 +72,37 @@ module Vapi
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
-      case obj.type
-      when "function"
-        Vapi::FunctionToolWithToolCall.validate_raw(obj: obj)
-      when "ghl"
-        Vapi::GhlToolWithToolCall.validate_raw(obj: obj)
-      when "make"
-        Vapi::MakeToolWithToolCall.validate_raw(obj: obj)
-      else
-        raise("Passed value matched no type within the union, validation failed.")
+      begin
+        return Vapi::FunctionToolWithToolCall.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
       end
-    end
-
-    # For Union Types, is_a? functionality is delegated to the wrapped member.
-    #
-    # @param obj [Object]
-    # @return [Boolean]
-    def is_a?(obj)
-      @member.is_a?(obj)
-    end
-
-    # @param member [Vapi::FunctionToolWithToolCall]
-    # @return [Vapi::ServerMessageToolCallsToolWithToolCallListItem]
-    def self.function(member:)
-      new(member: member, discriminant: "function")
-    end
-
-    # @param member [Vapi::GhlToolWithToolCall]
-    # @return [Vapi::ServerMessageToolCallsToolWithToolCallListItem]
-    def self.ghl(member:)
-      new(member: member, discriminant: "ghl")
-    end
-
-    # @param member [Vapi::MakeToolWithToolCall]
-    # @return [Vapi::ServerMessageToolCallsToolWithToolCallListItem]
-    def self.make(member:)
-      new(member: member, discriminant: "make")
+      begin
+        return Vapi::GhlToolWithToolCall.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vapi::MakeToolWithToolCall.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return obj.is_a?(Object) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+      rescue StandardError
+        # noop
+      end
+      begin
+        return obj.is_a?(Object) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+      rescue StandardError
+        # noop
+      end
+      begin
+        return obj.is_a?(Object) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+      rescue StandardError
+        # noop
+      end
+      raise("Passed value matched no type within the union, validation failed.")
     end
   end
 end

data/lib/vapi_server_sdk/types/server_message_transfer_update.rb

@@ -49,6 +49,10 @@ module Vapi
     # @return [Vapi::CreateAssistantDto] This is the assistant that the call is being transferred from. This is only sent
     #  if `destination.type` is "assistant".
     attr_reader :from_assistant
+    # @return [Hash{String => Object}] This is the step that the conversation moved to.
+    attr_reader :to_step_record
+    # @return [Hash{String => Object}] This is the step that the conversation moved from. =
+    attr_reader :from_step_record
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -86,10 +90,12 @@ module Vapi
     #  if `destination.type` is "assistant".
     # @param from_assistant [Vapi::CreateAssistantDto] This is the assistant that the call is being transferred from. This is only sent
     #  if `destination.type` is "assistant".
+    # @param to_step_record [Hash{String => Object}] This is the step that the conversation moved to.
+    # @param from_step_record [Hash{String => Object}] This is the step that the conversation moved from. =
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::ServerMessageTransferUpdate]
     def initialize(phone_number: OMIT, destination: OMIT, timestamp: OMIT, artifact: OMIT, assistant: OMIT,
-                   customer: OMIT, call: OMIT, to_assistant: OMIT, from_assistant: OMIT, additional_properties: nil)
+                   customer: OMIT, call: OMIT, to_assistant: OMIT, from_assistant: OMIT, to_step_record: OMIT, from_step_record: OMIT, additional_properties: nil)
       @phone_number = phone_number if phone_number != OMIT
       @destination = destination if destination != OMIT
       @timestamp = timestamp if timestamp != OMIT
@@ -99,6 +105,8 @@ module Vapi
       @call = call if call != OMIT
       @to_assistant = to_assistant if to_assistant != OMIT
       @from_assistant = from_assistant if from_assistant != OMIT
+      @to_step_record = to_step_record if to_step_record != OMIT
+      @from_step_record = from_step_record if from_step_record != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "phoneNumber": phone_number,
@@ -109,7 +117,9 @@ module Vapi
         "customer": customer,
         "call": call,
         "toAssistant": to_assistant,
-        "fromAssistant": from_assistant
+        "fromAssistant": from_assistant,
+        "toStepRecord": to_step_record,
+        "fromStepRecord": from_step_record
       }.reject do |_k, v|
         v == OMIT
       end
@@ -171,6 +181,8 @@ module Vapi
         from_assistant = parsed_json["fromAssistant"].to_json
         from_assistant = Vapi::CreateAssistantDto.from_json(json_object: from_assistant)
       end
+      to_step_record = parsed_json["toStepRecord"]
+      from_step_record = parsed_json["fromStepRecord"]
       new(
         phone_number: phone_number,
         destination: destination,
@@ -181,6 +193,8 @@ module Vapi
         call: call,
         to_assistant: to_assistant,
         from_assistant: from_assistant,
+        to_step_record: to_step_record,
+        from_step_record: from_step_record,
         additional_properties: struct
       )
     end
@@ -208,6 +222,8 @@ module Vapi
       obj.call.nil? || Vapi::Call.validate_raw(obj: obj.call)
       obj.to_assistant.nil? || Vapi::CreateAssistantDto.validate_raw(obj: obj.to_assistant)
       obj.from_assistant.nil? || Vapi::CreateAssistantDto.validate_raw(obj: obj.from_assistant)
+      obj.to_step_record&.is_a?(Hash) != false || raise("Passed value for field obj.to_step_record is not the expected type, validation failed.")
+      obj.from_step_record&.is_a?(Hash) != false || raise("Passed value for field obj.from_step_record is not the expected type, validation failed.")
     end
   end
 end

data/lib/vapi_server_sdk/types/sip_authentication.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class SipAuthentication
+    # @return [String] This will be expected in the `realm` field of the `authorization` header of the
+    #  SIP INVITE. Defaults to sip.vapi.ai.
+    attr_reader :realm
+    # @return [String] This will be expected in the `username` field of the `authorization` header of
+    #  the SIP INVITE.
+    attr_reader :username
+    # @return [String] This will be expected to generate the `response` field of the `authorization`
+    #  header of the SIP INVITE, through digest authentication.
+    attr_reader :password
+    # @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 realm [String] This will be expected in the `realm` field of the `authorization` header of the
+    #  SIP INVITE. Defaults to sip.vapi.ai.
+    # @param username [String] This will be expected in the `username` field of the `authorization` header of
+    #  the SIP INVITE.
+    # @param password [String] This will be expected to generate the `response` field of the `authorization`
+    #  header of the SIP INVITE, through digest authentication.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::SipAuthentication]
+    def initialize(username:, password:, realm: OMIT, additional_properties: nil)
+      @realm = realm if realm != OMIT
+      @username = username
+      @password = password
+      @additional_properties = additional_properties
+      @_field_set = { "realm": realm, "username": username, "password": password }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of SipAuthentication
+    #
+    # @param json_object [String]
+    # @return [Vapi::SipAuthentication]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      realm = parsed_json["realm"]
+      username = parsed_json["username"]
+      password = parsed_json["password"]
+      new(
+        realm: realm,
+        username: username,
+        password: password,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of SipAuthentication 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.realm&.is_a?(String) != false || raise("Passed value for field obj.realm is not the expected type, validation failed.")
+      obj.username.is_a?(String) != false || raise("Passed value for field obj.username is not the expected type, validation failed.")
+      obj.password.is_a?(String) != false || raise("Passed value for field obj.password is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/start_speaking_plan.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "start_speaking_plan_custom_endpointing_rules_item"
 require_relative "transcription_endpointing_plan"
 require "ostruct"
 require "json"
@@ -8,7 +9,7 @@ module Vapi
   class StartSpeakingPlan
     # @return [Float] This is how long assistant waits before speaking. Defaults to 0.4.
     #  This is the minimum it will wait but if there is latency is the pipeline, this
-    #  minimum will be exceeded. This is really a stopgap in case the pipeline is
+    #  minimum will be exceeded. This is intended as a stopgap in case the pipeline is
     #  moving too fast.
     #  Example:
     #  - If model generates tokens and voice generates bytes within 100ms, the pipeline
@@ -19,12 +20,30 @@ module Vapi
     #  value.
     #  @default 0.4
     attr_reader :wait_seconds
-    # @return [Boolean] This determines if a customer speech is considered done (endpointing) using the
-    #  VAP model on customer's speech. This is good for middle-of-thought detection.
+    # @return [Boolean] This determines if a customer speech is considered done (endpointing) using a
+    #  Vapi custom-trained model on customer's speech. This is good for
+    #  middle-of-thought detection.
     #  Once an endpoint is triggered, the request is sent to `assistant.model`.
-    #  Default `false` since experimental.
+    #  Usage:
+    #  - If your conversations are long-form and you want assistant to wait smartly
+    #  even if customer pauses for a bit to think, you can use this instead.
+    #  This overrides `transcriptionEndpointingPlan`.
     #  @default false
     attr_reader :smart_endpointing_enabled
+    # @return [Array<Vapi::StartSpeakingPlanCustomEndpointingRulesItem>] These are the custom endpointing rules to set an endpointing timeout based on a
+    #  regex on the customer's speech or the assistant's last message.
+    #  Usage:
+    #  - If you have yes/no questions like "are you interested in a loan?", you can set
+    #  a shorter timeout.
+    #  - If you have questions where the customer may pause to look up information like
+    #  "what's my account number?", you can set a longer timeout.
+    #  - If you want to wait longer while customer is enumerating a list of numbers,
+    #  you can set a longer timeout.
+    #  These override `transcriptionEndpointingPlan` and `smartEndpointingEnabled` when
+    #  a rule is matched.
+    #  The rules are evaluated in order and the first one that matches will be used.
+    #  @default []
+    attr_reader :custom_endpointing_rules
     # @return [Vapi::TranscriptionEndpointingPlan] This determines how a customer speech is considered done (endpointing) using the
     #  transcription of customer's speech.
     #  Once an endpoint is triggered, the request is sent to `assistant.model`.
@@ -39,7 +58,7 @@ module Vapi
 
     # @param wait_seconds [Float] This is how long assistant waits before speaking. Defaults to 0.4.
     #  This is the minimum it will wait but if there is latency is the pipeline, this
-    #  minimum will be exceeded. This is really a stopgap in case the pipeline is
+    #  minimum will be exceeded. This is intended as a stopgap in case the pipeline is
     #  moving too fast.
     #  Example:
     #  - If model generates tokens and voice generates bytes within 100ms, the pipeline
@@ -49,25 +68,44 @@ module Vapi
     #  - If the assistant is accidentally jumping in too much, set this to a higher
     #  value.
     #  @default 0.4
-    # @param smart_endpointing_enabled [Boolean] This determines if a customer speech is considered done (endpointing) using the
-    #  VAP model on customer's speech. This is good for middle-of-thought detection.
+    # @param smart_endpointing_enabled [Boolean] This determines if a customer speech is considered done (endpointing) using a
+    #  Vapi custom-trained model on customer's speech. This is good for
+    #  middle-of-thought detection.
     #  Once an endpoint is triggered, the request is sent to `assistant.model`.
-    #  Default `false` since experimental.
+    #  Usage:
+    #  - If your conversations are long-form and you want assistant to wait smartly
+    #  even if customer pauses for a bit to think, you can use this instead.
+    #  This overrides `transcriptionEndpointingPlan`.
     #  @default false
+    # @param custom_endpointing_rules [Array<Vapi::StartSpeakingPlanCustomEndpointingRulesItem>] These are the custom endpointing rules to set an endpointing timeout based on a
+    #  regex on the customer's speech or the assistant's last message.
+    #  Usage:
+    #  - If you have yes/no questions like "are you interested in a loan?", you can set
+    #  a shorter timeout.
+    #  - If you have questions where the customer may pause to look up information like
+    #  "what's my account number?", you can set a longer timeout.
+    #  - If you want to wait longer while customer is enumerating a list of numbers,
+    #  you can set a longer timeout.
+    #  These override `transcriptionEndpointingPlan` and `smartEndpointingEnabled` when
+    #  a rule is matched.
+    #  The rules are evaluated in order and the first one that matches will be used.
+    #  @default []
     # @param transcription_endpointing_plan [Vapi::TranscriptionEndpointingPlan] This determines how a customer speech is considered done (endpointing) using the
     #  transcription of customer's speech.
     #  Once an endpoint is triggered, the request is sent to `assistant.model`.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::StartSpeakingPlan]
-    def initialize(wait_seconds: OMIT, smart_endpointing_enabled: OMIT, transcription_endpointing_plan: OMIT,
-                   additional_properties: nil)
+    def initialize(wait_seconds: OMIT, smart_endpointing_enabled: OMIT, custom_endpointing_rules: OMIT,
+                   transcription_endpointing_plan: OMIT, additional_properties: nil)
       @wait_seconds = wait_seconds if wait_seconds != OMIT
       @smart_endpointing_enabled = smart_endpointing_enabled if smart_endpointing_enabled != OMIT
+      @custom_endpointing_rules = custom_endpointing_rules if custom_endpointing_rules != OMIT
       @transcription_endpointing_plan = transcription_endpointing_plan if transcription_endpointing_plan != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "waitSeconds": wait_seconds,
         "smartEndpointingEnabled": smart_endpointing_enabled,
+        "customEndpointingRules": custom_endpointing_rules,
         "transcriptionEndpointingPlan": transcription_endpointing_plan
       }.reject do |_k, v|
         v == OMIT
@@ -83,6 +121,10 @@ module Vapi
       parsed_json = JSON.parse(json_object)
       wait_seconds = parsed_json["waitSeconds"]
       smart_endpointing_enabled = parsed_json["smartEndpointingEnabled"]
+      custom_endpointing_rules = parsed_json["customEndpointingRules"]&.map do |item|
+        item = item.to_json
+        Vapi::StartSpeakingPlanCustomEndpointingRulesItem.from_json(json_object: item)
+      end
       if parsed_json["transcriptionEndpointingPlan"].nil?
         transcription_endpointing_plan = nil
       else
@@ -92,6 +134,7 @@ module Vapi
       new(
         wait_seconds: wait_seconds,
         smart_endpointing_enabled: smart_endpointing_enabled,
+        custom_endpointing_rules: custom_endpointing_rules,
         transcription_endpointing_plan: transcription_endpointing_plan,
         additional_properties: struct
       )
@@ -113,6 +156,7 @@ module Vapi
     def self.validate_raw(obj:)
       obj.wait_seconds&.is_a?(Float) != false || raise("Passed value for field obj.wait_seconds is not the expected type, validation failed.")
       obj.smart_endpointing_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.smart_endpointing_enabled is not the expected type, validation failed.")
+      obj.custom_endpointing_rules&.is_a?(Array) != false || raise("Passed value for field obj.custom_endpointing_rules is not the expected type, validation failed.")
       obj.transcription_endpointing_plan.nil? || Vapi::TranscriptionEndpointingPlan.validate_raw(obj: obj.transcription_endpointing_plan)
     end
   end

data/lib/vapi_server_sdk/types/start_speaking_plan_custom_endpointing_rules_item.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "assistant_custom_endpointing_rule"
+require_relative "customer_custom_endpointing_rule"
+require_relative "both_custom_endpointing_rule"
+
+module Vapi
+  class StartSpeakingPlanCustomEndpointingRulesItem
+    # @return [Object]
+    attr_reader :member
+    # @return [String]
+    attr_reader :discriminant
+
+    private_class_method :new
+    alias kind_of? is_a?
+
+    # @param member [Object]
+    # @param discriminant [String]
+    # @return [Vapi::StartSpeakingPlanCustomEndpointingRulesItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of
+    #  StartSpeakingPlanCustomEndpointingRulesItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::StartSpeakingPlanCustomEndpointingRulesItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.type
+               when "assistant"
+                 Vapi::AssistantCustomEndpointingRule.from_json(json_object: json_object)
+               when "customer"
+                 Vapi::CustomerCustomEndpointingRule.from_json(json_object: json_object)
+               when "both"
+                 Vapi::BothCustomEndpointingRule.from_json(json_object: json_object)
+               else
+                 Vapi::AssistantCustomEndpointingRule.from_json(json_object: json_object)
+               end
+      new(member: member, discriminant: struct.type)
+    end
+
+    # For Union Types, to_json functionality is delegated to the wrapped member.
+    #
+    # @return [String]
+    def to_json(*_args)
+      case @discriminant
+      when "assistant"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "customer"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "both"
+        { **@member.to_json, type: @discriminant }.to_json
+      else
+        { "type": @discriminant, value: @member }.to_json
+      end
+      @member.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:)
+      case obj.type
+      when "assistant"
+        Vapi::AssistantCustomEndpointingRule.validate_raw(obj: obj)
+      when "customer"
+        Vapi::CustomerCustomEndpointingRule.validate_raw(obj: obj)
+      when "both"
+        Vapi::BothCustomEndpointingRule.validate_raw(obj: obj)
+      else
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+
+    # For Union Types, is_a? functionality is delegated to the wrapped member.
+    #
+    # @param obj [Object]
+    # @return [Boolean]
+    def is_a?(obj)
+      @member.is_a?(obj)
+    end
+
+    # @param member [Vapi::AssistantCustomEndpointingRule]
+    # @return [Vapi::StartSpeakingPlanCustomEndpointingRulesItem]
+    def self.assistant(member:)
+      new(member: member, discriminant: "assistant")
+    end
+
+    # @param member [Vapi::CustomerCustomEndpointingRule]
+    # @return [Vapi::StartSpeakingPlanCustomEndpointingRulesItem]
+    def self.customer(member:)
+      new(member: member, discriminant: "customer")
+    end
+
+    # @param member [Vapi::BothCustomEndpointingRule]
+    # @return [Vapi::StartSpeakingPlanCustomEndpointingRulesItem]
+    def self.both(member:)
+      new(member: member, discriminant: "both")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/structured_data_plan.rb

@@ -7,11 +7,20 @@ require "json"
 module Vapi
   class StructuredDataPlan
     # @return [Array<Hash{String => Object}>] These are the messages used to generate the structured data.
-    #  @default: ` [ { "role": "system", "content": "You are an expert data extractor.
-    #  You will be given a transcript of a call. Extract structured data per the JSON
-    #  Schema. DO NOT return anything except the structured data.\n\nJson
-    #  Schema:\\n{{schema}}\n\nOnly respond with the JSON." }, { "role": "user",
-    #  "content": "Here is the transcript:\n\n{{transcript}}\n\n" } ]`
+    #  @default: ```
+    #  [
+    #  {
+    #  "role": "system",
+    #  "content": "You are an expert data extractor. You will be given a transcript
+    #  of a call. Extract structured data per the JSON Schema. DO NOT return anything
+    #  except the structured data.\n\nJson Schema:\\n{{schema}}\n\nOnly respond with
+    #  the JSON."
+    #  },
+    #  {
+    #  "role": "user",
+    #  "content": "Here is the transcript:\n\n{{transcript}}\n\n"
+    #  }
+    #  ]```
     #  You can customize by providing any messages you want.
     #  Here are the template variables available:
     #  - {{transcript}}: the transcript of the call from `call.artifact.transcript`-
@@ -47,11 +56,20 @@ module Vapi
     OMIT = Object.new
 
     # @param messages [Array<Hash{String => Object}>] These are the messages used to generate the structured data.
-    #  @default: ` [ { "role": "system", "content": "You are an expert data extractor.
-    #  You will be given a transcript of a call. Extract structured data per the JSON
-    #  Schema. DO NOT return anything except the structured data.\n\nJson
-    #  Schema:\\n{{schema}}\n\nOnly respond with the JSON." }, { "role": "user",
-    #  "content": "Here is the transcript:\n\n{{transcript}}\n\n" } ]`
+    #  @default: ```
+    #  [
+    #  {
+    #  "role": "system",
+    #  "content": "You are an expert data extractor. You will be given a transcript
+    #  of a call. Extract structured data per the JSON Schema. DO NOT return anything
+    #  except the structured data.\n\nJson Schema:\\n{{schema}}\n\nOnly respond with
+    #  the JSON."
+    #  },
+    #  {
+    #  "role": "user",
+    #  "content": "Here is the transcript:\n\n{{transcript}}\n\n"
+    #  }
+    #  ]```
     #  You can customize by providing any messages you want.
     #  Here are the template variables available:
     #  - {{transcript}}: the transcript of the call from `call.artifact.transcript`-