assemblyai 1.0.0.pre.beta.9 → 1.0.0.pre.beta.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8966cf8fd4bf25ddc706a276125abd055e0d959ab9a9e08a244cf62e673f5117
-  data.tar.gz: 49482eed13d7dbdd01846510dcfad1e9c22a910a79bf96f50c01932bb858a821
+  metadata.gz: 157742ad6decb8b828c23cf549a4e700d4cb0b2fdd9435bef9ca5e44424fdbda
+  data.tar.gz: a97d6acfec405cb63d78c6388602ede6ff6c885053feb054f82044ea17658a92
 SHA512:
-  metadata.gz: 01705c2608ea28815a847e01bffb4f7224e050e6b61dd3692b1f44d16eeabf2e6561e93356331709b32a2702c3c1c3a75864a1659a75d48a354739d832f0853f
-  data.tar.gz: 2789963c8e6e1f1b39013d0c398eaad39b8bd05dd13af4b80389bddf1337101465804360e6585ca29ab44ded1a9580bed610e3fcc8405537414a2557b12bf819
+  metadata.gz: 3136c68cf8ebeefb44cde0e3e55f968726bbf1d748a414d727ea6e0d73f244ac6a51f4edd688d4343ba857d2db28475fdcd4786f911ab2ce854d9206a3945b8a
+  data.tar.gz: 8f28783285bea24b5bd283f4385d748d81b0187276f6fedb4923df3be63493191391a99adcc478fd15d9b551186ca054a7822f76d16eae690292420c78d23339

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"
 
@@ -44,11 +45,11 @@ module AssemblyAI
     # @return [AssemblyAI::Lemur::LemurTaskResponse]
     # @example
     #  api = AssemblyAI::Client.new(
-    #    environment: Environment::DEFAULT,
+    #    environment: AssemblyAI::Environment::DEFAULT,
     #    base_url: "https://api.example.com",
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.task(prompt: "List all the locations affected by wildfires.")
+    #  api.lemur.task(prompt: "List all the locations affected by wildfires.")
     def task(prompt:, transcript_ids: nil, input_text: nil, context: nil, final_model: nil, max_output_size: nil,
              temperature: nil, request_options: nil)
       response = @request_client.conn.post do |req|
@@ -95,11 +96,11 @@ module AssemblyAI
     # @return [AssemblyAI::Lemur::LemurSummaryResponse]
     # @example
     #  api = AssemblyAI::Client.new(
-    #    environment: Environment::DEFAULT,
+    #    environment: AssemblyAI::Environment::DEFAULT,
     #    base_url: "https://api.example.com",
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.summary
+    #  api.lemur.summary
     def summary(transcript_ids: nil, input_text: nil, context: nil, final_model: nil, max_output_size: nil,
                 temperature: nil, answer_format: nil, request_options: nil)
       response = @request_client.conn.post do |req|
@@ -150,11 +151,11 @@ module AssemblyAI
     # @return [AssemblyAI::Lemur::LemurQuestionAnswerResponse]
     # @example
     #  api = AssemblyAI::Client.new(
-    #    environment: Environment::DEFAULT,
+    #    environment: AssemblyAI::Environment::DEFAULT,
     #    base_url: "https://api.example.com",
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.question_answer(questions: [{ question: "Where are there wildfires?", answer_format: "List of countries in ISO 3166-1 alpha-2 format", answer_options: ["US", "CA"] }, { question: "Is global warming affecting wildfires?", answer_options: ["yes", "no"] }])
+    #  api.lemur.question_answer(questions: [{ question: "Where are there wildfires?", answer_format: "List of countries in ISO 3166-1 alpha-2 format", answer_options: ["US", "CA"] }, { question: "Is global warming affecting wildfires?", answer_options: ["yes", "no"] }])
     def question_answer(questions:, transcript_ids: nil, input_text: nil, context: nil, final_model: nil, max_output_size: nil,
                         temperature: nil, request_options: nil)
       response = @request_client.conn.post do |req|
@@ -198,11 +199,11 @@ module AssemblyAI
     # @return [AssemblyAI::Lemur::LemurActionItemsResponse]
     # @example
     #  api = AssemblyAI::Client.new(
-    #    environment: Environment::DEFAULT,
+    #    environment: AssemblyAI::Environment::DEFAULT,
     #    base_url: "https://api.example.com",
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.action_items(answer_format: "Bullet Points")
+    #  api.lemur.action_items(answer_format: "Bullet Points")
     def action_items(transcript_ids: nil, input_text: nil, context: nil, final_model: nil, max_output_size: nil,
                      temperature: nil, answer_format: nil, request_options: nil)
       response = @request_client.conn.post do |req|
@@ -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.
@@ -234,11 +258,11 @@ module AssemblyAI
     # @return [AssemblyAI::Lemur::PurgeLemurRequestDataResponse]
     # @example
     #  api = AssemblyAI::Client.new(
-    #    environment: Environment::DEFAULT,
+    #    environment: AssemblyAI::Environment::DEFAULT,
     #    base_url: "https://api.example.com",
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.purge_request_data(request_id: "request_id")
+    #  api.lemur.purge_request_data(request_id: "request_id")
     def purge_request_data(request_id:, request_options: nil)
       response = @request_client.conn.delete do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -282,11 +306,11 @@ module AssemblyAI
     # @return [AssemblyAI::Lemur::LemurTaskResponse]
     # @example
     #  api = AssemblyAI::Client.new(
-    #    environment: Environment::DEFAULT,
+    #    environment: AssemblyAI::Environment::DEFAULT,
     #    base_url: "https://api.example.com",
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.task(prompt: "List all the locations affected by wildfires.")
+    #  api.lemur.task(prompt: "List all the locations affected by wildfires.")
     def task(prompt:, transcript_ids: nil, input_text: nil, context: nil, final_model: nil, max_output_size: nil,
              temperature: nil, request_options: nil)
       Async do
@@ -335,11 +359,11 @@ module AssemblyAI
     # @return [AssemblyAI::Lemur::LemurSummaryResponse]
     # @example
     #  api = AssemblyAI::Client.new(
-    #    environment: Environment::DEFAULT,
+    #    environment: AssemblyAI::Environment::DEFAULT,
     #    base_url: "https://api.example.com",
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.summary
+    #  api.lemur.summary
     def summary(transcript_ids: nil, input_text: nil, context: nil, final_model: nil, max_output_size: nil,
                 temperature: nil, answer_format: nil, request_options: nil)
       Async do
@@ -392,11 +416,11 @@ module AssemblyAI
     # @return [AssemblyAI::Lemur::LemurQuestionAnswerResponse]
     # @example
     #  api = AssemblyAI::Client.new(
-    #    environment: Environment::DEFAULT,
+    #    environment: AssemblyAI::Environment::DEFAULT,
     #    base_url: "https://api.example.com",
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.question_answer(questions: [{ question: "Where are there wildfires?", answer_format: "List of countries in ISO 3166-1 alpha-2 format", answer_options: ["US", "CA"] }, { question: "Is global warming affecting wildfires?", answer_options: ["yes", "no"] }])
+    #  api.lemur.question_answer(questions: [{ question: "Where are there wildfires?", answer_format: "List of countries in ISO 3166-1 alpha-2 format", answer_options: ["US", "CA"] }, { question: "Is global warming affecting wildfires?", answer_options: ["yes", "no"] }])
     def question_answer(questions:, transcript_ids: nil, input_text: nil, context: nil, final_model: nil, max_output_size: nil,
                         temperature: nil, request_options: nil)
       Async do
@@ -442,11 +466,11 @@ module AssemblyAI
     # @return [AssemblyAI::Lemur::LemurActionItemsResponse]
     # @example
     #  api = AssemblyAI::Client.new(
-    #    environment: Environment::DEFAULT,
+    #    environment: AssemblyAI::Environment::DEFAULT,
     #    base_url: "https://api.example.com",
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.action_items(answer_format: "Bullet Points")
+    #  api.lemur.action_items(answer_format: "Bullet Points")
     def action_items(transcript_ids: nil, input_text: nil, context: nil, final_model: nil, max_output_size: nil,
                      temperature: nil, answer_format: nil, request_options: nil)
       Async do
@@ -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.
@@ -480,11 +529,11 @@ module AssemblyAI
     # @return [AssemblyAI::Lemur::PurgeLemurRequestDataResponse]
     # @example
     #  api = AssemblyAI::Client.new(
-    #    environment: Environment::DEFAULT,
+    #    environment: AssemblyAI::Environment::DEFAULT,
     #    base_url: "https://api.example.com",
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.purge_request_data(request_id: "request_id")
+    #  api.lemur.purge_request_data(request_id: "request_id")
     def purge_request_data(request_id:, request_options: nil)
       Async do
         response = @request_client.conn.delete do |req|

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_params.rb

@@ -79,6 +79,7 @@ module AssemblyAI
       # @return [AssemblyAI::Lemur::LemurBaseParams]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
         transcript_ids = struct["transcript_ids"]
         input_text = struct["input_text"]
         if parsed_json["context"].nil?

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.rb

@@ -57,6 +57,7 @@ module AssemblyAI
       # @return [AssemblyAI::Lemur::LemurQuestion]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
         question = struct["question"]
         if parsed_json["context"].nil?
           context = nil

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
@@ -36,14 +41,22 @@ module AssemblyAI
       # @return [AssemblyAI::Lemur::LemurQuestionAnswerResponse]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
         response = parsed_json["response"]&.map do |v|
           v = v.to_json
           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
@@ -64,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/realtime/client.rb

@@ -22,11 +22,11 @@ module AssemblyAI
     # @return [AssemblyAI::Realtime::RealtimeTemporaryTokenResponse]
     # @example
     #  api = AssemblyAI::Client.new(
-    #    environment: Environment::DEFAULT,
+    #    environment: AssemblyAI::Environment::DEFAULT,
     #    base_url: "https://api.example.com",
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.create_temporary_token(expires_in: 480)
+    #  api.realtime.create_temporary_token(expires_in: 480)
     def create_temporary_token(expires_in:, request_options: nil)
       response = @request_client.conn.post do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -56,11 +56,11 @@ module AssemblyAI
     # @return [AssemblyAI::Realtime::RealtimeTemporaryTokenResponse]
     # @example
     #  api = AssemblyAI::Client.new(
-    #    environment: Environment::DEFAULT,
+    #    environment: AssemblyAI::Environment::DEFAULT,
     #    base_url: "https://api.example.com",
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.create_temporary_token(expires_in: 480)
+    #  api.realtime.create_temporary_token(expires_in: 480)
     def create_temporary_token(expires_in:, request_options: nil)
       Async do
         response = @request_client.conn.post do |req|

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

@@ -2,34 +2,52 @@
 
 module AssemblyAI
   class Transcripts
+    # The type of PII to redact
     class PiiPolicy
-      MEDICAL_PROCESS = "medical_process"
-      MEDICAL_CONDITION = "medical_condition"
+      ACCOUNT_NUMBER = "account_number"
+      BANKING_INFORMATION = "banking_information"
       BLOOD_TYPE = "blood_type"
-      DRUG = "drug"
-      INJURY = "injury"
-      NUMBER_SEQUENCE = "number_sequence"
-      EMAIL_ADDRESS = "email_address"
-      DATE_OF_BIRTH = "date_of_birth"
-      PHONE_NUMBER = "phone_number"
-      US_SOCIAL_SECURITY_NUMBER = "us_social_security_number"
-      CREDIT_CARD_NUMBER = "credit_card_number"
-      CREDIT_CARD_EXPIRATION = "credit_card_expiration"
       CREDIT_CARD_CVV = "credit_card_cvv"
+      CREDIT_CARD_EXPIRATION = "credit_card_expiration"
+      CREDIT_CARD_NUMBER = "credit_card_number"
       DATE = "date"
-      NATIONALITY = "nationality"
+      DATE_INTERVAL = "date_interval"
+      DATE_OF_BIRTH = "date_of_birth"
+      DRIVERS_LICENSE = "drivers_license"
+      DRUG = "drug"
+      DURATION = "duration"
+      EMAIL_ADDRESS = "email_address"
       EVENT = "event"
+      FILENAME = "filename"
+      GENDER_SEXUALITY = "gender_sexuality"
+      HEALTHCARE_NUMBER = "healthcare_number"
+      INJURY = "injury"
+      IP_ADDRESS = "ip_address"
       LANGUAGE = "language"
       LOCATION = "location"
+      MARITAL_STATUS = "marital_status"
+      MEDICAL_CONDITION = "medical_condition"
+      MEDICAL_PROCESS = "medical_process"
       MONEY_AMOUNT = "money_amount"
-      PERSON_NAME = "person_name"
-      PERSON_AGE = "person_age"
+      NATIONALITY = "nationality"
+      NUMBER_SEQUENCE = "number_sequence"
+      OCCUPATION = "occupation"
       ORGANIZATION = "organization"
+      PASSPORT_NUMBER = "passport_number"
+      PASSWORD = "password"
+      PERSON_AGE = "person_age"
+      PERSON_NAME = "person_name"
+      PHONE_NUMBER = "phone_number"
+      PHYSICAL_ATTRIBUTE = "physical_attribute"
       POLITICAL_AFFILIATION = "political_affiliation"
-      OCCUPATION = "occupation"
       RELIGION = "religion"
-      DRIVERS_LICENSE = "drivers_license"
-      BANKING_INFORMATION = "banking_information"
+      STATISTICS = "statistics"
+      TIME = "time"
+      URL = "url"
+      US_SOCIAL_SECURITY_NUMBER = "us_social_security_number"
+      USERNAME = "username"
+      VEHICLE_ID = "vehicle_id"
+      ZODIAC_SIGN = "zodiac_sign"
     end
   end
 end

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

@@ -46,6 +46,7 @@ module AssemblyAI
       # @return [AssemblyAI::Transcripts::TopicDetectionModelResult]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
         status = struct["status"]
         results = parsed_json["results"]&.map do |v|
           v = v.to_json

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

@@ -443,6 +443,7 @@ module AssemblyAI
       # @return [AssemblyAI::Transcripts::Transcript]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
         id = struct["id"]
         language_model = struct["language_model"]
         acoustic_model = struct["acoustic_model"]

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

@@ -68,6 +68,7 @@ module AssemblyAI
       # @return [AssemblyAI::Transcripts::TranscriptListItem]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
         id = struct["id"]
         resource_url = struct["resource_url"]
         status = struct["status"]

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

@@ -283,6 +283,7 @@ module AssemblyAI
       # @return [AssemblyAI::Transcripts::TranscriptOptionalParams]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
         language_code = struct["language_code"]
         punctuate = struct["punctuate"]
         format_text = struct["format_text"]

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

@@ -65,6 +65,7 @@ module AssemblyAI
       # @return [AssemblyAI::Transcripts::TranscriptParagraph]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
         text = struct["text"]
         start = struct["start"]
         end_ = struct["end"]

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

@@ -65,6 +65,7 @@ module AssemblyAI
       # @return [AssemblyAI::Transcripts::TranscriptSentence]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
         text = struct["text"]
         start = struct["start"]
         end_ = struct["end"]

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

@@ -61,6 +61,7 @@ module AssemblyAI
       # @return [AssemblyAI::Transcripts::TranscriptUtterance]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
         confidence = struct["confidence"]
         start = struct["start"]
         end_ = struct["end"]

data/lib/requests.rb

@@ -22,14 +22,14 @@ module AssemblyAI
     # @param timeout_in_seconds [Long]
     # @param api_key [String]
     # @return [AssemblyAI::RequestClient]
-    def initialize(api_key:, environment: Environment::DEFAULT, base_url: nil, max_retries: nil,
+    def initialize(api_key:, environment: AssemblyAI::Environment::DEFAULT, base_url: nil, max_retries: nil,
                    timeout_in_seconds: 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.9",
+        "X-Fern-SDK-Version": "1.0.0-beta.11",
         "Authorization": api_key.to_s
       }
       @conn = Faraday.new(headers: @headers) do |faraday|
@@ -63,14 +63,14 @@ module AssemblyAI
     # @param timeout_in_seconds [Long]
     # @param api_key [String]
     # @return [AssemblyAI::AsyncRequestClient]
-    def initialize(api_key:, environment: Environment::DEFAULT, base_url: nil, max_retries: nil,
+    def initialize(api_key:, environment: AssemblyAI::Environment::DEFAULT, base_url: nil, max_retries: nil,
                    timeout_in_seconds: 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.9",
+        "X-Fern-SDK-Version": "1.0.0-beta.11",
         "Authorization": api_key.to_s
       }
       @conn = Faraday.new(headers: @headers) do |faraday|

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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: assemblyai
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta.9
+  version: 1.0.0.pre.beta.11
 platform: ruby
 authors:
 - ''
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-30 00:00:00.000000000 Z
+date: 2024-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http-faraday
@@ -109,8 +109,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