assemblyai 1.0.0.pre.beta.7 → 1.0.0.pre.beta.8

data/lib/assemblyai/transcripts/types/word_search_match.rb

@@ -1,54 +1,74 @@
 # frozen_string_literal: true
 
 require_relative "word_search_timestamp"
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Transcripts
     class WordSearchMatch
-      attr_reader :text, :count, :timestamps, :indexes, :additional_properties
+      # @return [String] The matched word
+      attr_reader :text
+      # @return [Integer] The total amount of times the word is in the transcript
+      attr_reader :count
+      # @return [Array<AssemblyAI::Transcripts::WORD_SEARCH_TIMESTAMP>] An array of timestamps
+      attr_reader :timestamps
+      # @return [Array<Integer>] An array of all index locations for that word within the `words` array of the
+      #  completed transcript
+      attr_reader :indexes
+      # @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 text [String] The matched word
       # @param count [Integer] The total amount of times the word is in the transcript
-      # @param timestamps [Array<Transcripts::WORD_SEARCH_TIMESTAMP>] An array of timestamps
-      # @param indexes [Array<Integer>] An array of all index locations for that word within the `words` array of the completed transcript
+      # @param timestamps [Array<AssemblyAI::Transcripts::WORD_SEARCH_TIMESTAMP>] An array of timestamps
+      # @param indexes [Array<Integer>] An array of all index locations for that word within the `words` array of the
+      #  completed transcript
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Transcripts::WordSearchMatch]
+      # @return [AssemblyAI::Transcripts::WordSearchMatch]
       def initialize(text:, count:, timestamps:, indexes:, additional_properties: nil)
-        # @type [String] The matched word
         @text = text
-        # @type [Integer] The total amount of times the word is in the transcript
         @count = count
-        # @type [Array<Transcripts::WORD_SEARCH_TIMESTAMP>] An array of timestamps
         @timestamps = timestamps
-        # @type [Array<Integer>] An array of all index locations for that word within the `words` array of the completed transcript
         @indexes = indexes
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties
+        @_field_set = { "text": text, "count": count, "timestamps": timestamps, "indexes": indexes }
       end
 
       # Deserialize a JSON object to an instance of WordSearchMatch
       #
-      # @param json_object [JSON]
-      # @return [Transcripts::WordSearchMatch]
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::WordSearchMatch]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
-        JSON.parse(json_object)
-        text = struct.text
-        count = struct.count
-        timestamps = struct.timestamps
-        indexes = struct.indexes
-        new(text: text, count: count, timestamps: timestamps, indexes: indexes, additional_properties: struct)
+        text = struct["text"]
+        count = struct["count"]
+        timestamps = struct["timestamps"]
+        indexes = struct["indexes"]
+        new(
+          text: text,
+          count: count,
+          timestamps: timestamps,
+          indexes: indexes,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of WordSearchMatch to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        { "text": @text, "count": @count, "timestamps": @timestamps, "indexes": @indexes }.to_json
+        @_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.
+      # 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]

data/lib/assemblyai/transcripts/types/word_search_response.rb

@@ -1,53 +1,72 @@
 # frozen_string_literal: true
 
 require_relative "word_search_match"
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Transcripts
     class WordSearchResponse
-      attr_reader :id, :total_count, :matches, :additional_properties
+      # @return [String] The ID of the transcript
+      attr_reader :id
+      # @return [Integer] The total count of all matched instances. For e.g., word 1 matched 2 times, and
+      #  word 2 matched 3 times, `total_count` will equal 5.
+      attr_reader :total_count
+      # @return [Array<AssemblyAI::Transcripts::WordSearchMatch>] The matches of the search
+      attr_reader :matches
+      # @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 id [String] The ID of the transcript
-      # @param total_count [Integer] The total count of all matched instances. For e.g., word 1 matched 2 times, and word 2 matched 3 times, `total_count` will equal 5.
-      # @param matches [Array<Transcripts::WordSearchMatch>] The matches of the search
+      # @param total_count [Integer] The total count of all matched instances. For e.g., word 1 matched 2 times, and
+      #  word 2 matched 3 times, `total_count` will equal 5.
+      # @param matches [Array<AssemblyAI::Transcripts::WordSearchMatch>] The matches of the search
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Transcripts::WordSearchResponse]
+      # @return [AssemblyAI::Transcripts::WordSearchResponse]
       def initialize(id:, total_count:, matches:, additional_properties: nil)
-        # @type [String] The ID of the transcript
         @id = id
-        # @type [Integer] The total count of all matched instances. For e.g., word 1 matched 2 times, and word 2 matched 3 times, `total_count` will equal 5.
         @total_count = total_count
-        # @type [Array<Transcripts::WordSearchMatch>] The matches of the search
         @matches = matches
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties
+        @_field_set = { "id": id, "total_count": total_count, "matches": matches }
       end
 
       # Deserialize a JSON object to an instance of WordSearchResponse
       #
-      # @param json_object [JSON]
-      # @return [Transcripts::WordSearchResponse]
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::WordSearchResponse]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        id = struct.id
-        total_count = struct.total_count
+        id = struct["id"]
+        total_count = struct["total_count"]
         matches = parsed_json["matches"]&.map do |v|
           v = v.to_json
-          Transcripts::WordSearchMatch.from_json(json_object: v)
+          AssemblyAI::Transcripts::WordSearchMatch.from_json(json_object: v)
         end
-        new(id: id, total_count: total_count, matches: matches, additional_properties: struct)
+        new(
+          id: id,
+          total_count: total_count,
+          matches: matches,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of WordSearchResponse to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        { "id": @id, "total_count": @total_count, "matches": @matches }.to_json
+        @_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.
+      # 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]

data/lib/assemblyai/types/error.rb

@@ -1,44 +1,60 @@
 # frozen_string_literal: true
 
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Error
-    attr_reader :error, :status, :additional_properties
+    # @return [String] Error message
+    attr_reader :error
+    # @return [String]
+    attr_reader :status
+    # @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 error [String] Error message
     # @param status [String]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [Error]
-    def initialize(error:, status: nil, additional_properties: nil)
-      # @type [String] Error message
+    # @return [AssemblyAI::Error]
+    def initialize(error:, status: OMIT, additional_properties: nil)
       @error = error
-      # @type [String]
-      @status = status
-      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @status = status if status != OMIT
       @additional_properties = additional_properties
+      @_field_set = { "error": error, "status": status }.reject do |_k, v|
+        v == OMIT
+      end
     end
 
     # Deserialize a JSON object to an instance of Error
     #
-    # @param json_object [JSON]
-    # @return [Error]
+    # @param json_object [String]
+    # @return [AssemblyAI::Error]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
-      JSON.parse(json_object)
-      error = struct.error
-      status = struct.status
-      new(error: error, status: status, additional_properties: struct)
+      error = struct["error"]
+      status = struct["status"]
+      new(
+        error: error,
+        status: status,
+        additional_properties: struct
+      )
     end
 
     # Serialize an instance of Error to a JSON object
     #
-    # @return [JSON]
+    # @return [String]
     def to_json(*_args)
-      { "error": @error, "status": @status }.to_json
+      @_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.
+    # 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]

data/lib/requests.rb

@@ -7,49 +7,73 @@ require "async/http/faraday"
 
 module AssemblyAI
   class RequestClient
-    attr_reader :headers, :base_url, :conn
+    # @return [Hash{String => String}]
+    attr_reader :headers
+    # @return [Faraday]
+    attr_reader :conn
+    # @return [String]
+    attr_reader :base_url
+    # @return [String]
+    attr_reader :default_environment
 
-    # @param environment [Environment]
+    # @param environment [AssemblyAI::Environment]
+    # @param base_url [String]
     # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
     # @param timeout_in_seconds [Long]
     # @param api_key [String]
-    # @return [RequestClient]
-    def initialize(api_key:, environment: Environment::DEFAULT, max_retries: nil, timeout_in_seconds: nil)
+    # @return [AssemblyAI::RequestClient]
+    def initialize(api_key:, environment: Environment::DEFAULT, base_url: nil, max_retries: nil,
+                   timeout_in_seconds: nil)
       @default_environment = environment
-      @base_url = environment
+      @base_url = environment || base_url
       @headers = {
         "X-Fern-Language": "Ruby",
         "X-Fern-SDK-Name": "assemblyai",
-        "X-Fern-SDK-Version": "1.0.0-beta.7",
+        "X-Fern-SDK-Version": "1.0.0-beta.8",
         "Authorization": api_key.to_s
       }
-      @conn = Faraday.new(@base_url, headers: @headers) do |faraday|
+      @conn = Faraday.new(headers: @headers) do |faraday|
         faraday.request :json
         faraday.response :raise_error, include_request: true
         faraday.request :retry, { max: max_retries } unless max_retries.nil?
         faraday.options.timeout = timeout_in_seconds unless timeout_in_seconds.nil?
       end
     end
+
+    # @param request_options [AssemblyAI::RequestOptions]
+    # @return [String]
+    def get_url(request_options: nil)
+      request_options&.base_url || @default_environment || @base_url
+    end
   end
 
   class AsyncRequestClient
-    attr_reader :headers, :base_url, :conn
+    # @return [Hash{String => String}]
+    attr_reader :headers
+    # @return [Faraday]
+    attr_reader :conn
+    # @return [String]
+    attr_reader :base_url
+    # @return [String]
+    attr_reader :default_environment
 
-    # @param environment [Environment]
+    # @param environment [AssemblyAI::Environment]
+    # @param base_url [String]
     # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
     # @param timeout_in_seconds [Long]
     # @param api_key [String]
-    # @return [AsyncRequestClient]
-    def initialize(api_key:, environment: Environment::DEFAULT, max_retries: nil, timeout_in_seconds: nil)
+    # @return [AssemblyAI::AsyncRequestClient]
+    def initialize(api_key:, environment: Environment::DEFAULT, base_url: nil, max_retries: nil,
+                   timeout_in_seconds: nil)
       @default_environment = environment
-      @base_url = environment
+      @base_url = environment || base_url
       @headers = {
         "X-Fern-Language": "Ruby",
         "X-Fern-SDK-Name": "assemblyai",
-        "X-Fern-SDK-Version": "1.0.0-beta.7",
+        "X-Fern-SDK-Version": "1.0.0-beta.8",
         "Authorization": api_key.to_s
       }
-      @conn = Faraday.new(@base_url, headers: @headers) do |faraday|
+      @conn = Faraday.new(headers: @headers) do |faraday|
         faraday.request :json
         faraday.response :raise_error, include_request: true
         faraday.adapter :async_http
@@ -57,56 +81,78 @@ module AssemblyAI
         faraday.options.timeout = timeout_in_seconds unless timeout_in_seconds.nil?
       end
     end
+
+    # @param request_options [AssemblyAI::RequestOptions]
+    # @return [String]
+    def get_url(request_options: nil)
+      request_options&.base_url || @default_environment || @base_url
+    end
   end
 
-  # Additional options for request-specific configuration when calling APIs via the SDK.
+  # Additional options for request-specific configuration when calling APIs via the
+  #  SDK.
   class RequestOptions
-    attr_reader :api_key, :additional_headers, :additional_query_parameters, :additional_body_parameters,
-                :timeout_in_seconds
+    # @return [String]
+    attr_reader :base_url
+    # @return [String]
+    attr_reader :api_key
+    # @return [Hash{String => Object}]
+    attr_reader :additional_headers
+    # @return [Hash{String => Object}]
+    attr_reader :additional_query_parameters
+    # @return [Hash{String => Object}]
+    attr_reader :additional_body_parameters
+    # @return [Long]
+    attr_reader :timeout_in_seconds
 
+    # @param base_url [String]
     # @param api_key [String]
     # @param additional_headers [Hash{String => Object}]
     # @param additional_query_parameters [Hash{String => Object}]
     # @param additional_body_parameters [Hash{String => Object}]
     # @param timeout_in_seconds [Long]
-    # @return [RequestOptions]
-    def initialize(api_key: nil, additional_headers: nil, additional_query_parameters: nil,
+    # @return [AssemblyAI::RequestOptions]
+    def initialize(base_url: nil, api_key: nil, additional_headers: nil, additional_query_parameters: nil,
                    additional_body_parameters: nil, timeout_in_seconds: nil)
-      # @type [String]
+      @base_url = base_url
       @api_key = api_key
-      # @type [Hash{String => Object}]
       @additional_headers = additional_headers
-      # @type [Hash{String => Object}]
       @additional_query_parameters = additional_query_parameters
-      # @type [Hash{String => Object}]
       @additional_body_parameters = additional_body_parameters
-      # @type [Long]
       @timeout_in_seconds = timeout_in_seconds
     end
   end
 
-  # Additional options for request-specific configuration when calling APIs via the SDK.
+  # Additional options for request-specific configuration when calling APIs via the
+  #  SDK.
   class IdempotencyRequestOptions
-    attr_reader :api_key, :additional_headers, :additional_query_parameters, :additional_body_parameters,
-                :timeout_in_seconds
+    # @return [String]
+    attr_reader :base_url
+    # @return [String]
+    attr_reader :api_key
+    # @return [Hash{String => Object}]
+    attr_reader :additional_headers
+    # @return [Hash{String => Object}]
+    attr_reader :additional_query_parameters
+    # @return [Hash{String => Object}]
+    attr_reader :additional_body_parameters
+    # @return [Long]
+    attr_reader :timeout_in_seconds
 
+    # @param base_url [String]
     # @param api_key [String]
     # @param additional_headers [Hash{String => Object}]
     # @param additional_query_parameters [Hash{String => Object}]
     # @param additional_body_parameters [Hash{String => Object}]
     # @param timeout_in_seconds [Long]
-    # @return [IdempotencyRequestOptions]
-    def initialize(api_key: nil, additional_headers: nil, additional_query_parameters: nil,
+    # @return [AssemblyAI::IdempotencyRequestOptions]
+    def initialize(base_url: nil, api_key: nil, additional_headers: nil, additional_query_parameters: nil,
                    additional_body_parameters: nil, timeout_in_seconds: nil)
-      # @type [String]
+      @base_url = base_url
       @api_key = api_key
-      # @type [Hash{String => Object}]
       @additional_headers = additional_headers
-      # @type [Hash{String => Object}]
       @additional_query_parameters = additional_query_parameters
-      # @type [Hash{String => Object}]
       @additional_body_parameters = additional_body_parameters
-      # @type [Long]
       @timeout_in_seconds = timeout_in_seconds
     end
   end

data/lib/types_export.rb

@@ -50,6 +50,7 @@ require_relative "assemblyai/realtime/types/realtime_base_message"
 require_relative "assemblyai/realtime/types/session_begins"
 require_relative "assemblyai/realtime/types/partial_transcript"
 require_relative "assemblyai/realtime/types/final_transcript"
+require_relative "assemblyai/realtime/types/session_information"
 require_relative "assemblyai/realtime/types/session_terminated"
 require_relative "assemblyai/realtime/types/realtime_error"
 require_relative "assemblyai/realtime/types/realtime_message"
@@ -58,14 +59,11 @@ require_relative "assemblyai/realtime/types/realtime_transcript_type"
 require_relative "assemblyai/realtime/types/realtime_transcript"
 require_relative "assemblyai/realtime/types/realtime_base_transcript"
 require_relative "assemblyai/realtime/types/word"
-require_relative "assemblyai/realtime/types/audio_data"
 require_relative "assemblyai/realtime/types/force_end_utterance"
 require_relative "assemblyai/realtime/types/configure_end_utterance_silence_threshold"
 require_relative "assemblyai/realtime/types/terminate_session"
 require_relative "assemblyai/realtime/types/audio_encoding"
 require_relative "assemblyai/realtime/types/realtime_temporary_token_response"
-require_relative "assemblyai/realtime/types/receive_message"
-require_relative "assemblyai/realtime/types/send_message"
 require_relative "assemblyai/lemur/types/purge_lemur_request_data_response"
 require_relative "assemblyai/lemur/types/lemur_base_response"
 require_relative "assemblyai/lemur/types/lemur_summary_response"
@@ -78,4 +76,7 @@ require_relative "assemblyai/lemur/types/lemur_base_params"
 require_relative "assemblyai/lemur/types/lemur_question_context"
 require_relative "assemblyai/lemur/types/lemur_question"
 require_relative "assemblyai/lemur/types/lemur_model"
+require_relative "assemblyai/streaming/types/streaming"
+require_relative "assemblyai/streaming/types/receive_message"
+require_relative "assemblyai/streaming/types/send_message"
 require_relative "assemblyai/types/error"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: assemblyai
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta.7
+  version: 1.0.0.pre.beta.8
 platform: ruby
 authors:
 - ''
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-04-01 00:00:00.000000000 Z
+date: 2024-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http-faraday
@@ -113,7 +113,6 @@ files:
 - lib/assemblyai/lemur/types/lemur_task_response.rb
 - lib/assemblyai/lemur/types/purge_lemur_request_data_response.rb
 - lib/assemblyai/realtime/client.rb
-- lib/assemblyai/realtime/types/audio_data.rb
 - lib/assemblyai/realtime/types/audio_encoding.rb
 - lib/assemblyai/realtime/types/configure_end_utterance_silence_threshold.rb
 - lib/assemblyai/realtime/types/final_transcript.rb
@@ -127,12 +126,14 @@ files:
 - lib/assemblyai/realtime/types/realtime_temporary_token_response.rb
 - lib/assemblyai/realtime/types/realtime_transcript.rb
 - lib/assemblyai/realtime/types/realtime_transcript_type.rb
-- lib/assemblyai/realtime/types/receive_message.rb
-- lib/assemblyai/realtime/types/send_message.rb
 - lib/assemblyai/realtime/types/session_begins.rb
+- lib/assemblyai/realtime/types/session_information.rb
 - lib/assemblyai/realtime/types/session_terminated.rb
 - lib/assemblyai/realtime/types/terminate_session.rb
 - lib/assemblyai/realtime/types/word.rb
+- lib/assemblyai/streaming/types/receive_message.rb
+- lib/assemblyai/streaming/types/send_message.rb
+- lib/assemblyai/streaming/types/streaming.rb
 - lib/assemblyai/transcripts/client.rb
 - lib/assemblyai/transcripts/list_by_url_client.rb
 - lib/assemblyai/transcripts/polling_client.rb

data/lib/assemblyai/realtime/types/audio_data.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module AssemblyAI
-  class Realtime
-    AUDIO_DATA = String
-  end
-end

data/lib/assemblyai/realtime/types/receive_message.rb

@@ -1,87 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-require_relative "../../realtime/types/session_begins"
-require_relative "../../realtime/types/partial_transcript"
-require_relative "../../realtime/types/final_transcript"
-require_relative "../../realtime/types/session_terminated"
-require_relative "../../realtime/types/realtime_error"
-
-module AssemblyAI
-  class Realtime
-    # Receive messages from the WebSocket
-    class ReceiveMessage
-      # Deserialize a JSON object to an instance of ReceiveMessage
-      #
-      # @param json_object [JSON]
-      # @return [Realtime::ReceiveMessage]
-      def self.from_json(json_object:)
-        struct = JSON.parse(json_object, object_class: OpenStruct)
-        begin
-          Realtime::SessionBegins.validate_raw(obj: struct)
-          return Realtime::SessionBegins.from_json(json_object: json_object)
-        rescue StandardError
-          # noop
-        end
-        begin
-          Realtime::PartialTranscript.validate_raw(obj: struct)
-          return Realtime::PartialTranscript.from_json(json_object: json_object)
-        rescue StandardError
-          # noop
-        end
-        begin
-          Realtime::FinalTranscript.validate_raw(obj: struct)
-          return Realtime::FinalTranscript.from_json(json_object: json_object)
-        rescue StandardError
-          # noop
-        end
-        begin
-          Realtime::SessionTerminated.validate_raw(obj: struct)
-          return Realtime::SessionTerminated.from_json(json_object: json_object)
-        rescue StandardError
-          # noop
-        end
-        begin
-          Realtime::RealtimeError.validate_raw(obj: struct)
-          return Realtime::RealtimeError.from_json(json_object: json_object)
-        rescue StandardError
-          # noop
-        end
-        struct
-      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:)
-        begin
-          return Realtime::SessionBegins.validate_raw(obj: obj)
-        rescue StandardError
-          # noop
-        end
-        begin
-          return Realtime::PartialTranscript.validate_raw(obj: obj)
-        rescue StandardError
-          # noop
-        end
-        begin
-          return Realtime::FinalTranscript.validate_raw(obj: obj)
-        rescue StandardError
-          # noop
-        end
-        begin
-          return Realtime::SessionTerminated.validate_raw(obj: obj)
-        rescue StandardError
-          # noop
-        end
-        begin
-          return Realtime::RealtimeError.validate_raw(obj: obj)
-        rescue StandardError
-          # noop
-        end
-        raise("Passed value matched no type within the union, validation failed.")
-      end
-    end
-  end
-end