assemblyai 1.0.0.pre.beta.10 → 1.0.0.pre.beta.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 267dae8c6c4c9cd73c6b547bb0aaf560f283a7f483437f5edddbfc8fc091edde
-  data.tar.gz: 6a8b1f420988acbce05a04d78e5114241a6fc5abef6c6ed0b3549979c868b9ec
+  metadata.gz: 9034fb96ca90c8408fbfd7fc97683c4d9a3ece611dd24c48cf1c4359fdb34f60
+  data.tar.gz: dcac6189a3a041f59a0b3eb67f4c27fa9bae181d3823fd514e3dbbd52ff69d71
 SHA512:
-  metadata.gz: b25c9bc1531c0c97c5bef27c5067575afb3722d6aa826024e5e3d2b9cae03f24902a1787977436a3cd19cb9f1edcea51de42c656eb939b817b8e4aacb63c364e
-  data.tar.gz: edef4f4676465a37222e4c559b2179cfecd3a479c0181b3b947539fd1aef5e04d457b5ff7fd92fefb20d34ba57874ff34db87b9ca416c1faf0222501a5f56b16
+  metadata.gz: 8c949d40ee00af765612f85dd2291050d67b86171d8861927c7f70bc32bcfa06dd7af93e3877ac8d3ed3b2432b9c11c5e9394cc60aa1e34341ec05ad786c8939
+  data.tar.gz: 2b2f829a93d8d6c86c8d39c19190f2610edcb154882ba5b0e7b2a49be4ccbf6c6557835a6161ba327ab27bb47fad1b2acbe290c9f221e284f6168eb726d6e039

data/lib/assemblyai/lemur/client.rb

@@ -8,6 +8,7 @@ require_relative "types/lemur_summary_response"
 require_relative "types/lemur_question"
 require_relative "types/lemur_question_answer_response"
 require_relative "types/lemur_action_items_response"
+require_relative "types/lemur_response"
 require_relative "types/purge_lemur_request_data_response"
 require "async"
 
@@ -224,6 +225,29 @@ module AssemblyAI
       AssemblyAI::Lemur::LemurActionItemsResponse.from_json(json_object: response.body)
     end
 
+    # Retrieve a LeMUR response that was previously generated.
+    #
+    # @param request_id [String] The ID of the LeMUR request you previously made.
+    #  This would be found in the response of the original request.
+    # @param request_options [AssemblyAI::RequestOptions]
+    # @return [AssemblyAI::Lemur::LemurTaskResponse, AssemblyAI::Lemur::LemurSummaryResponse, AssemblyAI::Lemur::LemurQuestionAnswerResponse, AssemblyAI::Lemur::LemurActionItemsResponse]
+    # @example
+    #  api = AssemblyAI::Client.new(
+    #    environment: AssemblyAI::Environment::DEFAULT,
+    #    base_url: "https://api.example.com",
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.lemur.get_response(request_id: "request_id")
+    def get_response(request_id:, request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/lemur/v3/#{request_id}"
+      end
+      AssemblyAI::Lemur::LemurResponse.from_json(json_object: response.body)
+    end
+
     # Delete the data for a previously submitted LeMUR request.
     #  The LLM response data, as well as any context provided in the original request
     #  will be removed.
@@ -470,6 +494,31 @@ module AssemblyAI
       end
     end
 
+    # Retrieve a LeMUR response that was previously generated.
+    #
+    # @param request_id [String] The ID of the LeMUR request you previously made.
+    #  This would be found in the response of the original request.
+    # @param request_options [AssemblyAI::RequestOptions]
+    # @return [AssemblyAI::Lemur::LemurTaskResponse, AssemblyAI::Lemur::LemurSummaryResponse, AssemblyAI::Lemur::LemurQuestionAnswerResponse, AssemblyAI::Lemur::LemurActionItemsResponse]
+    # @example
+    #  api = AssemblyAI::Client.new(
+    #    environment: AssemblyAI::Environment::DEFAULT,
+    #    base_url: "https://api.example.com",
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.lemur.get_response(request_id: "request_id")
+    def get_response(request_id:, request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/lemur/v3/#{request_id}"
+        end
+        AssemblyAI::Lemur::LemurResponse.from_json(json_object: response.body)
+      end
+    end
+
     # Delete the data for a previously submitted LeMUR request.
     #  The LLM response data, as well as any context provided in the original request
     #  will be removed.

data/lib/assemblyai/lemur/types/lemur_action_items_response.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "lemur_usage"
 require "ostruct"
 require "json"
 
@@ -10,6 +11,8 @@ module AssemblyAI
       attr_reader :response
       # @return [String] The ID of the LeMUR request
       attr_reader :request_id
+      # @return [AssemblyAI::Lemur::LemurUsage] The usage numbers for the LeMUR request
+      attr_reader :usage
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
       # @return [Object]
@@ -20,13 +23,15 @@ module AssemblyAI
 
       # @param response [String] The response generated by LeMUR
       # @param request_id [String] The ID of the LeMUR request
+      # @param usage [AssemblyAI::Lemur::LemurUsage] The usage numbers for the LeMUR request
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [AssemblyAI::Lemur::LemurActionItemsResponse]
-      def initialize(response:, request_id:, additional_properties: nil)
+      def initialize(response:, request_id:, usage:, additional_properties: nil)
         @response = response
         @request_id = request_id
+        @usage = usage
         @additional_properties = additional_properties
-        @_field_set = { "response": response, "request_id": request_id }
+        @_field_set = { "response": response, "request_id": request_id, "usage": usage }
       end
 
       # Deserialize a JSON object to an instance of LemurActionItemsResponse
@@ -35,11 +40,19 @@ module AssemblyAI
       # @return [AssemblyAI::Lemur::LemurActionItemsResponse]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
         response = struct["response"]
         request_id = struct["request_id"]
+        if parsed_json["usage"].nil?
+          usage = nil
+        else
+          usage = parsed_json["usage"].to_json
+          usage = AssemblyAI::Lemur::LemurUsage.from_json(json_object: usage)
+        end
         new(
           response: response,
           request_id: request_id,
+          usage: usage,
           additional_properties: struct
         )
       end
@@ -60,6 +73,7 @@ module AssemblyAI
       def self.validate_raw(obj:)
         obj.response.is_a?(String) != false || raise("Passed value for field obj.response is not the expected type, validation failed.")
         obj.request_id.is_a?(String) != false || raise("Passed value for field obj.request_id is not the expected type, validation failed.")
+        AssemblyAI::Lemur::LemurUsage.validate_raw(obj: obj.usage)
       end
     end
   end

data/lib/assemblyai/lemur/types/lemur_base_response.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "lemur_usage"
 require "ostruct"
 require "json"
 
@@ -8,6 +9,8 @@ module AssemblyAI
     class LemurBaseResponse
       # @return [String] The ID of the LeMUR request
       attr_reader :request_id
+      # @return [AssemblyAI::Lemur::LemurUsage] The usage numbers for the LeMUR request
+      attr_reader :usage
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
       # @return [Object]
@@ -17,12 +20,14 @@ module AssemblyAI
       OMIT = Object.new
 
       # @param request_id [String] The ID of the LeMUR request
+      # @param usage [AssemblyAI::Lemur::LemurUsage] The usage numbers for the LeMUR request
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [AssemblyAI::Lemur::LemurBaseResponse]
-      def initialize(request_id:, additional_properties: nil)
+      def initialize(request_id:, usage:, additional_properties: nil)
         @request_id = request_id
+        @usage = usage
         @additional_properties = additional_properties
-        @_field_set = { "request_id": request_id }
+        @_field_set = { "request_id": request_id, "usage": usage }
       end
 
       # Deserialize a JSON object to an instance of LemurBaseResponse
@@ -31,8 +36,19 @@ module AssemblyAI
       # @return [AssemblyAI::Lemur::LemurBaseResponse]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
         request_id = struct["request_id"]
-        new(request_id: request_id, additional_properties: struct)
+        if parsed_json["usage"].nil?
+          usage = nil
+        else
+          usage = parsed_json["usage"].to_json
+          usage = AssemblyAI::Lemur::LemurUsage.from_json(json_object: usage)
+        end
+        new(
+          request_id: request_id,
+          usage: usage,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of LemurBaseResponse to a JSON object
@@ -50,6 +66,7 @@ module AssemblyAI
       # @return [Void]
       def self.validate_raw(obj:)
         obj.request_id.is_a?(String) != false || raise("Passed value for field obj.request_id is not the expected type, validation failed.")
+        AssemblyAI::Lemur::LemurUsage.validate_raw(obj: obj.usage)
       end
     end
   end

data/lib/assemblyai/lemur/types/lemur_question_answer_response.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "lemur_question_answer"
+require_relative "lemur_usage"
 require "ostruct"
 require "json"
 
@@ -11,6 +12,8 @@ module AssemblyAI
       attr_reader :response
       # @return [String] The ID of the LeMUR request
       attr_reader :request_id
+      # @return [AssemblyAI::Lemur::LemurUsage] The usage numbers for the LeMUR request
+      attr_reader :usage
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
       # @return [Object]
@@ -21,13 +24,15 @@ module AssemblyAI
 
       # @param response [Array<AssemblyAI::Lemur::LemurQuestionAnswer>] The answers generated by LeMUR and their questions
       # @param request_id [String] The ID of the LeMUR request
+      # @param usage [AssemblyAI::Lemur::LemurUsage] The usage numbers for the LeMUR request
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [AssemblyAI::Lemur::LemurQuestionAnswerResponse]
-      def initialize(response:, request_id:, additional_properties: nil)
+      def initialize(response:, request_id:, usage:, additional_properties: nil)
         @response = response
         @request_id = request_id
+        @usage = usage
         @additional_properties = additional_properties
-        @_field_set = { "response": response, "request_id": request_id }
+        @_field_set = { "response": response, "request_id": request_id, "usage": usage }
       end
 
       # Deserialize a JSON object to an instance of LemurQuestionAnswerResponse
@@ -42,9 +47,16 @@ module AssemblyAI
           AssemblyAI::Lemur::LemurQuestionAnswer.from_json(json_object: v)
         end
         request_id = struct["request_id"]
+        if parsed_json["usage"].nil?
+          usage = nil
+        else
+          usage = parsed_json["usage"].to_json
+          usage = AssemblyAI::Lemur::LemurUsage.from_json(json_object: usage)
+        end
         new(
           response: response,
           request_id: request_id,
+          usage: usage,
           additional_properties: struct
         )
       end
@@ -65,6 +77,7 @@ module AssemblyAI
       def self.validate_raw(obj:)
         obj.response.is_a?(Array) != false || raise("Passed value for field obj.response is not the expected type, validation failed.")
         obj.request_id.is_a?(String) != false || raise("Passed value for field obj.request_id is not the expected type, validation failed.")
+        AssemblyAI::Lemur::LemurUsage.validate_raw(obj: obj.usage)
       end
     end
   end

data/lib/assemblyai/lemur/types/lemur_response.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "lemur_task_response"
+require_relative "lemur_summary_response"
+require_relative "lemur_question_answer_response"
+require_relative "lemur_action_items_response"
+
+module AssemblyAI
+  class Lemur
+    class LemurResponse
+      # Deserialize a JSON object to an instance of LemurResponse
+      #
+      # @param json_object [String]
+      # @return [AssemblyAI::Lemur::LemurResponse]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        begin
+          AssemblyAI::Lemur::LemurTaskResponse.validate_raw(obj: struct)
+          return AssemblyAI::Lemur::LemurTaskResponse.from_json(json_object: json_object) unless json_object.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          AssemblyAI::Lemur::LemurSummaryResponse.validate_raw(obj: struct)
+          return AssemblyAI::Lemur::LemurSummaryResponse.from_json(json_object: json_object) unless json_object.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          AssemblyAI::Lemur::LemurQuestionAnswerResponse.validate_raw(obj: struct)
+          unless json_object.nil?
+            return AssemblyAI::Lemur::LemurQuestionAnswerResponse.from_json(json_object: json_object)
+          end
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          AssemblyAI::Lemur::LemurActionItemsResponse.validate_raw(obj: struct)
+          return AssemblyAI::Lemur::LemurActionItemsResponse.from_json(json_object: json_object) unless json_object.nil?
+
+          return nil
+        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 AssemblyAI::Lemur::LemurTaskResponse.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return AssemblyAI::Lemur::LemurSummaryResponse.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return AssemblyAI::Lemur::LemurQuestionAnswerResponse.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return AssemblyAI::Lemur::LemurActionItemsResponse.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+  end
+end

data/lib/assemblyai/lemur/types/lemur_summary_response.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "lemur_usage"
 require "ostruct"
 require "json"
 
@@ -10,6 +11,8 @@ module AssemblyAI
       attr_reader :response
       # @return [String] The ID of the LeMUR request
       attr_reader :request_id
+      # @return [AssemblyAI::Lemur::LemurUsage] The usage numbers for the LeMUR request
+      attr_reader :usage
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
       # @return [Object]
@@ -20,13 +23,15 @@ module AssemblyAI
 
       # @param response [String] The response generated by LeMUR
       # @param request_id [String] The ID of the LeMUR request
+      # @param usage [AssemblyAI::Lemur::LemurUsage] The usage numbers for the LeMUR request
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [AssemblyAI::Lemur::LemurSummaryResponse]
-      def initialize(response:, request_id:, additional_properties: nil)
+      def initialize(response:, request_id:, usage:, additional_properties: nil)
         @response = response
         @request_id = request_id
+        @usage = usage
         @additional_properties = additional_properties
-        @_field_set = { "response": response, "request_id": request_id }
+        @_field_set = { "response": response, "request_id": request_id, "usage": usage }
       end
 
       # Deserialize a JSON object to an instance of LemurSummaryResponse
@@ -35,11 +40,19 @@ module AssemblyAI
       # @return [AssemblyAI::Lemur::LemurSummaryResponse]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
         response = struct["response"]
         request_id = struct["request_id"]
+        if parsed_json["usage"].nil?
+          usage = nil
+        else
+          usage = parsed_json["usage"].to_json
+          usage = AssemblyAI::Lemur::LemurUsage.from_json(json_object: usage)
+        end
         new(
           response: response,
           request_id: request_id,
+          usage: usage,
           additional_properties: struct
         )
       end
@@ -60,6 +73,7 @@ module AssemblyAI
       def self.validate_raw(obj:)
         obj.response.is_a?(String) != false || raise("Passed value for field obj.response is not the expected type, validation failed.")
         obj.request_id.is_a?(String) != false || raise("Passed value for field obj.request_id is not the expected type, validation failed.")
+        AssemblyAI::Lemur::LemurUsage.validate_raw(obj: obj.usage)
       end
     end
   end

data/lib/assemblyai/lemur/types/lemur_task_response.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "lemur_usage"
 require "ostruct"
 require "json"
 
@@ -10,6 +11,8 @@ module AssemblyAI
       attr_reader :response
       # @return [String] The ID of the LeMUR request
       attr_reader :request_id
+      # @return [AssemblyAI::Lemur::LemurUsage] The usage numbers for the LeMUR request
+      attr_reader :usage
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
       # @return [Object]
@@ -20,13 +23,15 @@ module AssemblyAI
 
       # @param response [String] The response generated by LeMUR.
       # @param request_id [String] The ID of the LeMUR request
+      # @param usage [AssemblyAI::Lemur::LemurUsage] The usage numbers for the LeMUR request
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [AssemblyAI::Lemur::LemurTaskResponse]
-      def initialize(response:, request_id:, additional_properties: nil)
+      def initialize(response:, request_id:, usage:, additional_properties: nil)
         @response = response
         @request_id = request_id
+        @usage = usage
         @additional_properties = additional_properties
-        @_field_set = { "response": response, "request_id": request_id }
+        @_field_set = { "response": response, "request_id": request_id, "usage": usage }
       end
 
       # Deserialize a JSON object to an instance of LemurTaskResponse
@@ -35,11 +40,19 @@ module AssemblyAI
       # @return [AssemblyAI::Lemur::LemurTaskResponse]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
         response = struct["response"]
         request_id = struct["request_id"]
+        if parsed_json["usage"].nil?
+          usage = nil
+        else
+          usage = parsed_json["usage"].to_json
+          usage = AssemblyAI::Lemur::LemurUsage.from_json(json_object: usage)
+        end
         new(
           response: response,
           request_id: request_id,
+          usage: usage,
           additional_properties: struct
         )
       end
@@ -60,6 +73,7 @@ module AssemblyAI
       def self.validate_raw(obj:)
         obj.response.is_a?(String) != false || raise("Passed value for field obj.response is not the expected type, validation failed.")
         obj.request_id.is_a?(String) != false || raise("Passed value for field obj.request_id is not the expected type, validation failed.")
+        AssemblyAI::Lemur::LemurUsage.validate_raw(obj: obj.usage)
       end
     end
   end

data/lib/assemblyai/lemur/types/lemur_usage.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module AssemblyAI
+  class Lemur
+    # The usage numbers for the LeMUR request
+    class LemurUsage
+      # @return [Integer] The number of input tokens used by the model
+      attr_reader :input_tokens
+      # @return [Integer] The number of output tokens generated by the model
+      attr_reader :output_tokens
+      # @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 input_tokens [Integer] The number of input tokens used by the model
+      # @param output_tokens [Integer] The number of output tokens generated by the model
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [AssemblyAI::Lemur::LemurUsage]
+      def initialize(input_tokens:, output_tokens:, additional_properties: nil)
+        @input_tokens = input_tokens
+        @output_tokens = output_tokens
+        @additional_properties = additional_properties
+        @_field_set = { "input_tokens": input_tokens, "output_tokens": output_tokens }
+      end
+
+      # Deserialize a JSON object to an instance of LemurUsage
+      #
+      # @param json_object [String]
+      # @return [AssemblyAI::Lemur::LemurUsage]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        input_tokens = struct["input_tokens"]
+        output_tokens = struct["output_tokens"]
+        new(
+          input_tokens: input_tokens,
+          output_tokens: output_tokens,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of LemurUsage 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.input_tokens.is_a?(Integer) != false || raise("Passed value for field obj.input_tokens is not the expected type, validation failed.")
+        obj.output_tokens.is_a?(Integer) != false || raise("Passed value for field obj.output_tokens is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/assemblyai/transcripts/polling_client.rb

@@ -75,10 +75,15 @@ module AssemblyAI
       deprecate_conformer2(speech_model: speech_model)
       transcript = submit(audio_url: audio_url, speech_model: speech_model, language_code: language_code, punctuate: punctuate, format_text: format_text, dual_channel: dual_channel,
                           webhook_url: webhook_url, webhook_auth_header_name: webhook_auth_header_name, webhook_auth_header_value: webhook_auth_header_value, auto_highlights: auto_highlights, audio_start_from: audio_start_from, audio_end_at: audio_end_at, word_boost: word_boost, boost_param: boost_param, filter_profanity: filter_profanity, redact_pii: redact_pii, redact_pii_audio: redact_pii_audio, redact_pii_audio_quality: redact_pii_audio_quality, redact_pii_policies: redact_pii_policies, redact_pii_sub: redact_pii_sub, speaker_labels: speaker_labels, speakers_expected: speakers_expected, content_safety: content_safety, content_safety_confidence: content_safety_confidence, iab_categories: iab_categories, language_detection: language_detection, custom_spelling: custom_spelling, disfluencies: disfluencies, sentiment_analysis: sentiment_analysis, auto_chapters: auto_chapters, entity_detection: entity_detection, speech_threshold: speech_threshold, summarization: summarization, summary_model: summary_model, summary_type: summary_type, custom_topics: custom_topics, topics: topics, additional_properties: additional_properties, request_options: request_options)
-      poll_transcript(transcript_id: transcript.id, polling_options: polling_options)
+      wait_until_ready(transcript_id: transcript.id, polling_options: polling_options)
     end
 
-    def poll_transcript(transcript_id:, polling_options:)
+    # Wait until the transcript is ready. The transcript is ready when the "status" is "completed".
+    #
+    # @param transcript_id [String] ID of the transcript
+    # @param polling_options [PollingOptions]
+    # @return [Transcripts::Transcript]
+    def wait_until_ready(transcript_id:, polling_options: Transcripts::PollingOptions.new)
       start_time = Time.now
       timeout_in_seconds = polling_options.timeout / 1000 if polling_options.timeout.positive?
       loop do
@@ -97,7 +102,8 @@ module AssemblyAI
     def deprecate_conformer2(speech_model: nil)
       warn "[DEPRECATION] `conformer-2` is deprecated.  Please use `best` or `nano` instead." if speech_model == "conformer-2"
     end
-    private :poll_transcript, :deprecate_conformer2
+
+    private :deprecate_conformer2
   end
 
   # :nodoc:
@@ -155,18 +161,23 @@ module AssemblyAI
       Async do
         transcript = submit(audio_url: audio_url, speech_model: speech_model, language_code: language_code, punctuate: punctuate, format_text: format_text, dual_channel: dual_channel,
                             webhook_url: webhook_url, webhook_auth_header_name: webhook_auth_header_name, webhook_auth_header_value: webhook_auth_header_value, auto_highlights: auto_highlights, audio_start_from: audio_start_from, audio_end_at: audio_end_at, word_boost: word_boost, boost_param: boost_param, filter_profanity: filter_profanity, redact_pii: redact_pii, redact_pii_audio: redact_pii_audio, redact_pii_audio_quality: redact_pii_audio_quality, redact_pii_policies: redact_pii_policies, redact_pii_sub: redact_pii_sub, speaker_labels: speaker_labels, speakers_expected: speakers_expected, content_safety: content_safety, content_safety_confidence: content_safety_confidence, iab_categories: iab_categories, language_detection: language_detection, custom_spelling: custom_spelling, disfluencies: disfluencies, sentiment_analysis: sentiment_analysis, auto_chapters: auto_chapters, entity_detection: entity_detection, speech_threshold: speech_threshold, summarization: summarization, summary_model: summary_model, summary_type: summary_type, custom_topics: custom_topics, topics: topics, additional_properties: additional_properties, request_options: request_options).wait
-        poll_transcript(transcript_id: transcript.id, polling_options: polling_options).wait
+        wait_until_ready(transcript_id: transcript.id, polling_options: polling_options).wait
       end
     end
 
-    def poll_transcript(transcript_id:, polling_options:)
+    # Wait until the transcript is ready. The transcript is ready when the "status" is "completed".
+    #
+    # @param transcript_id [String] ID of the transcript
+    # @param polling_options [PollingOptions]
+    # @return [Transcripts::Transcript]
+    def wait_until_ready(transcript_id:, polling_options: Transcripts::PollingOptions.new)
       Async do
         start_time = Time.now
         timeout_in_seconds = polling_options.timeout / 1000 if polling_options.timeout.positive?
         loop do
-          transcript = get(transcript_id: transcript_id).wait
+          transcript = get(transcript_id: transcript_id)
           if transcript.status == Transcripts::TranscriptStatus::COMPLETED || transcript.status == Transcripts::TranscriptStatus::ERROR
-            break transcript
+            return transcript
           elsif polling_options.timeout.positive? && Time.now - start_time > timeout_in_seconds
             raise StandardError, "Polling timeout"
           end
@@ -180,6 +191,7 @@ module AssemblyAI
     def deprecate_conformer2(speech_model:)
       warn "[DEPRECATION] `conformer-2` is deprecated.  Please use `best` or `nano` instead." if speech_model == "conformer-2"
     end
-    private :poll_transcript, :deprecate_conformer2
+
+    private :deprecate_conformer2
   end
 end

data/lib/assemblyai.rb

@@ -14,14 +14,15 @@ module AssemblyAI
   class Client
     attr_reader :files, :transcripts, :realtime, :lemur
 
+    # @param api_key [String]
     # @param environment [Environment]
     # @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]
+    # @param user_agent [AssemblyAI::UserAgent]
     # @return [Client]
-    def initialize(api_key:, environment: Environment::DEFAULT, max_retries: nil, timeout_in_seconds: nil)
+    def initialize(api_key:, environment: Environment::DEFAULT, max_retries: nil, timeout_in_seconds: nil, user_agent: nil)
       @request_client = RequestClient.new(environment: environment, max_retries: max_retries,
-                                          timeout_in_seconds: timeout_in_seconds, api_key: api_key)
+                                          timeout_in_seconds: timeout_in_seconds, api_key: api_key, user_agent: user_agent)
       @files = FilesClient.new(request_client: @request_client)
       @transcripts = TranscriptsClient.new(request_client: @request_client)
       @realtime = RealtimeClient.new(request_client: @request_client)
@@ -32,14 +33,15 @@ module AssemblyAI
   class AsyncClient
     attr_reader :files, :transcripts, :realtime, :lemur
 
+    # @param api_key [String]
     # @param environment [Environment]
     # @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]
+    # @param user_agent [AssemblyAI::UserAgent]
     # @return [AsyncClient]
-    def initialize(api_key:, environment: Environment::DEFAULT, max_retries: nil, timeout_in_seconds: nil)
+    def initialize(api_key:, environment: Environment::DEFAULT, max_retries: nil, timeout_in_seconds: nil, user_agent: nil)
       @async_request_client = AsyncRequestClient.new(environment: environment, max_retries: max_retries,
-                                                     timeout_in_seconds: timeout_in_seconds, api_key: api_key)
+                                                     timeout_in_seconds: timeout_in_seconds, api_key: api_key, user_agent: user_agent)
       @files = AsyncFilesClient.new(request_client: @async_request_client)
       @transcripts = AsyncTranscriptsClient.new(request_client: @async_request_client)
       @realtime = AsyncRealtimeClient.new(request_client: @async_request_client)

data/lib/gemconfig.rb

@@ -2,11 +2,12 @@
 
 module AssemblyAI
   module Gemconfig
-    VERSION = ""
+    VERSION = "1.0.0-beta.12"
     AUTHORS = [""].freeze
-    EMAIL = ""
-    SUMMARY = ""
-    DESCRIPTION = ""
+    EMAIL = "support@assemblyai.com"
+    SUMMARY = "AssemblyAI Ruby SDK"
+    DESCRIPTION = "The AssemblyAI Ruby SDK provides an easy-to-use interface for interacting with the AssemblyAI API, which supports async, audio intelligence models, as well as the latest LeMUR models.
+The Ruby SDK does not support Streaming STT at this time."
     HOMEPAGE = "https://github.com/AssemblyAI/assemblyai-ruby-sdk"
     SOURCE_CODE_URI = "https://github.com/AssemblyAI/assemblyai-ruby-sdk"
     CHANGELOG_URI = "https://github.com/AssemblyAI/assemblyai-ruby-sdk/blob/master/CHANGELOG.md"

data/lib/requests.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "environment"
+require_relative "user_agent"
 require "faraday"
 require "faraday/retry"
 require "async/http/faraday"
@@ -16,21 +17,23 @@ module AssemblyAI
     # @return [String]
     attr_reader :default_environment
 
+    # @param api_key [String]
     # @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]
+    # @param user_agent [AssemblyAI::UserAgent]
     # @return [AssemblyAI::RequestClient]
     def initialize(api_key:, environment: AssemblyAI::Environment::DEFAULT, base_url: nil, max_retries: nil,
-                   timeout_in_seconds: nil)
+                   timeout_in_seconds: nil, user_agent: nil)
       @default_environment = environment
       @base_url = environment || base_url
       @headers = {
         "X-Fern-Language": "Ruby",
         "X-Fern-SDK-Name": "assemblyai",
-        "X-Fern-SDK-Version": "1.0.0-beta.10",
-        "Authorization": api_key.to_s
+        "X-Fern-SDK-Version": AssemblyAI::Gemconfig::VERSION,
+        "Authorization": api_key.to_s,
+        "User-Agent": AssemblyAI::UserAgent.merge(AssemblyAI::DefaultUserAgent.instance.user_agent, user_agent).serialize
       }
       @conn = Faraday.new(headers: @headers) do |faraday|
         faraday.request :json
@@ -62,16 +65,18 @@ module AssemblyAI
     # @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]
+    # @param user_agent [AssemblyAI::UserAgent]
     # @return [AssemblyAI::AsyncRequestClient]
     def initialize(api_key:, environment: AssemblyAI::Environment::DEFAULT, base_url: nil, max_retries: nil,
-                   timeout_in_seconds: nil)
+                   timeout_in_seconds: nil, user_agent: nil)
       @default_environment = environment
       @base_url = environment || base_url
       @headers = {
         "X-Fern-Language": "Ruby",
         "X-Fern-SDK-Name": "assemblyai",
-        "X-Fern-SDK-Version": "1.0.0-beta.10",
-        "Authorization": api_key.to_s
+        "X-Fern-SDK-Version": AssemblyAI::Gemconfig::VERSION,
+        "Authorization": api_key.to_s,
+        "User-Agent": AssemblyAI::UserAgent.merge(AssemblyAI::DefaultUserAgent.instance.user_agent, user_agent).serialize
       }
       @conn = Faraday.new(headers: @headers) do |faraday|
         faraday.request :json

data/lib/types_export.rb

@@ -66,16 +66,18 @@ require_relative "assemblyai/realtime/types/audio_encoding"
 require_relative "assemblyai/realtime/types/realtime_temporary_token_response"
 require_relative "assemblyai/lemur/types/purge_lemur_request_data_response"
 require_relative "assemblyai/lemur/types/lemur_base_response"
+require_relative "assemblyai/lemur/types/lemur_task_response"
 require_relative "assemblyai/lemur/types/lemur_summary_response"
 require_relative "assemblyai/lemur/types/lemur_question_answer_response"
 require_relative "assemblyai/lemur/types/lemur_question_answer"
 require_relative "assemblyai/lemur/types/lemur_action_items_response"
-require_relative "assemblyai/lemur/types/lemur_task_response"
+require_relative "assemblyai/lemur/types/lemur_response"
 require_relative "assemblyai/lemur/types/lemur_base_params_context"
 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/lemur/types/lemur_usage"
 require_relative "assemblyai/streaming/types/streaming"
 require_relative "assemblyai/streaming/types/receive_message"
 require_relative "assemblyai/streaming/types/send_message"

data/lib/user_agent.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "singleton"
+
+module AssemblyAI
+  class UserAgentItem
+    attr_reader :name, :value, :version
+
+    def initialize(name:, version:)
+      @name = name
+      @version = version
+    end
+  end
+
+  class UserAgent
+    attr_reader :user_agent_items
+
+    def initialize
+      @user_agent_items = {}
+    end
+
+    # @param key [String]
+    # @param user_agent_item [AssemblyAI::UserAgentItem]
+    def add_item(key, user_agent_item)
+      if user_agent_item.nil?
+        @user_agent_items.delete(key)
+      else
+        @user_agent_items[key] = user_agent_item
+      end
+    end
+
+    # @param user_agent1 [AssemblyAI::UserAgent]
+    # @param user_agent2 [AssemblyAI::UserAgent]
+    # @return [AssemblyAI::UserAgent]
+    def self.merge(user_agent1, user_agent2)
+      merged_user_agent = UserAgent.new
+
+      user_agent1&.user_agent_items&.each do |key, item|
+        merged_user_agent.add_item(key, item)
+      end
+
+      user_agent2&.user_agent_items&.each do |key, item|
+        merged_user_agent.add_item(key, item)
+      end
+
+      merged_user_agent
+    end
+
+    # @return [String]
+    def serialize
+      serialized_items = @user_agent_items.map do |key, item|
+        "#{key}=#{item.name}/#{item.version}"
+      end.join(" ")
+
+      "AssemblyAI/1.0 (#{serialized_items})"
+    end
+  end
+
+  class DefaultUserAgent
+    include Singleton
+
+    attr_reader :user_agent
+
+    def initialize
+      @user_agent = UserAgent.new
+      @user_agent.add_item("sdk", UserAgentItem.new(name: "Ruby", version: AssemblyAI::Gemconfig::VERSION))
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: assemblyai
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta.10
+  version: 1.0.0.pre.beta.12
 platform: ruby
 authors:
 - ''
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-05 00:00:00.000000000 Z
+date: 2024-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http-faraday
@@ -90,8 +90,10 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: ''
-email: ''
+description: |-
+  The AssemblyAI Ruby SDK provides an easy-to-use interface for interacting with the AssemblyAI API, which supports async, audio intelligence models, as well as the latest LeMUR models.
+  The Ruby SDK does not support Streaming STT at this time.
+email: support@assemblyai.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -109,8 +111,10 @@ files:
 - lib/assemblyai/lemur/types/lemur_question_answer.rb
 - lib/assemblyai/lemur/types/lemur_question_answer_response.rb
 - lib/assemblyai/lemur/types/lemur_question_context.rb
+- lib/assemblyai/lemur/types/lemur_response.rb
 - lib/assemblyai/lemur/types/lemur_summary_response.rb
 - lib/assemblyai/lemur/types/lemur_task_response.rb
+- lib/assemblyai/lemur/types/lemur_usage.rb
 - lib/assemblyai/lemur/types/purge_lemur_request_data_response.rb
 - lib/assemblyai/realtime/client.rb
 - lib/assemblyai/realtime/types/audio_encoding.rb
@@ -188,6 +192,7 @@ files:
 - lib/gemconfig.rb
 - lib/requests.rb
 - lib/types_export.rb
+- lib/user_agent.rb
 homepage: https://github.com/AssemblyAI/assemblyai-ruby-sdk
 licenses: []
 metadata:
@@ -212,5 +217,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: ''
+summary: AssemblyAI Ruby SDK
 test_files: []