assemblyai 1.0.0.pre.beta

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "json"
+
+module AssemblyAI
+  class Lemur
+    # Context to provide the model. This can be a string or a free-form JSON value.
+    class LemurBaseParamsContext
+      attr_reader :member
+      alias kind_of? is_a?
+      # @param member [Object]
+      # @return [Lemur::LemurBaseParamsContext]
+      def initialize(member:)
+        # @type [Object]
+        @member = member
+      end
+
+      # Deserialize a JSON object to an instance of LemurBaseParamsContext
+      #
+      # @param json_object [JSON]
+      # @return [Lemur::LemurBaseParamsContext]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        begin
+          struct.is_a?(String) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+          member = json_object
+          return new(member: member)
+        rescue StandardError
+          # noop
+        end
+        begin
+          struct.is_a?(Hash) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+          member = json_object
+          return new(member: member)
+        rescue StandardError
+          # noop
+        end
+        new(member: struct)
+      end
+
+      # For Union Types, to_json functionality is delegated to the wrapped member.
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        @member.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        begin
+          return obj.is_a?(String) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+        rescue StandardError
+          # noop
+        end
+        begin
+          return obj.is_a?(Hash) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+        rescue StandardError
+          # noop
+        end
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+
+      # For Union Types, is_a? functionality is delegated to the wrapped member.
+      #
+      # @param obj [Object]
+      # @return [Boolean]
+      def is_a?(obj)
+        @member.is_a?(obj)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "json"
+
+module AssemblyAI
+  class Lemur
+    class LemurBaseResponse
+      attr_reader :request_id, :additional_properties
+
+      # @param request_id [String] The ID of the LeMUR request
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Lemur::LemurBaseResponse]
+      def initialize(request_id:, additional_properties: nil)
+        # @type [String] The ID of the LeMUR request
+        @request_id = request_id
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of LemurBaseResponse
+      #
+      # @param json_object [JSON]
+      # @return [Lemur::LemurBaseResponse]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        JSON.parse(json_object)
+        request_id = struct.request_id
+        new(request_id: request_id, additional_properties: struct)
+      end
+
+      # Serialize an instance of LemurBaseResponse to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "request_id": @request_id }.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.request_id.is_a?(String) != false || raise("Passed value for field obj.request_id is not the expected type, validation failed.")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module AssemblyAI
+  class Lemur
+    # @type [LEMUR_MODEL]
+    LEMUR_MODEL = {
+      default: "default",
+      basic: "basic",
+      assemblyai_mistral7b: "assemblyai/mistral-7b",
+      anthropic_claude21: "anthropic/claude-2-1"
+    }.freeze
+  end
+end

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require_relative "lemur_question_context"
+require "json"
+
+module AssemblyAI
+  class Lemur
+    class LemurQuestion
+      attr_reader :question, :context, :answer_format, :answer_options, :additional_properties
+
+      # @param question [String] The question you wish to ask. For more complex questions use default model.
+      # @param context [Lemur::LemurQuestionContext] Any context about the transcripts you wish to provide. This can be a string or any object.
+      # @param answer_format [String] How you want the answer to be returned. This can be any text. Can't be used with answer_options. Examples: "short sentence", "bullet points"
+      # @param answer_options [Array<String>] What discrete options to return. Useful for precise responses. Can't be used with answer_format. Example: ["Yes", "No"]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Lemur::LemurQuestion]
+      def initialize(question:, context: nil, answer_format: nil, answer_options: nil, additional_properties: nil)
+        # @type [String] The question you wish to ask. For more complex questions use default model.
+        @question = question
+        # @type [Lemur::LemurQuestionContext] Any context about the transcripts you wish to provide. This can be a string or any object.
+        @context = context
+        # @type [String] How you want the answer to be returned. This can be any text. Can't be used with answer_options. Examples: "short sentence", "bullet points"
+        @answer_format = answer_format
+        # @type [Array<String>] What discrete options to return. Useful for precise responses. Can't be used with answer_format. Example: ["Yes", "No"]
+        @answer_options = answer_options
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of LemurQuestion
+      #
+      # @param json_object [JSON]
+      # @return [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
+        else
+          context = parsed_json["context"].to_json
+          context = Lemur::LemurQuestionContext.from_json(json_object: context)
+        end
+        answer_format = struct.answer_format
+        answer_options = struct.answer_options
+        new(question: question, context: context, answer_format: answer_format, answer_options: answer_options,
+            additional_properties: struct)
+      end
+
+      # Serialize an instance of LemurQuestion to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        {
+          "question": @question,
+          "context": @context,
+          "answer_format": @answer_format,
+          "answer_options": @answer_options
+        }.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.question.is_a?(String) != false || raise("Passed value for field obj.question is not the expected type, validation failed.")
+        obj.context.nil? || Lemur::LemurQuestionContext.validate_raw(obj: obj.context)
+        obj.answer_format&.is_a?(String) != false || raise("Passed value for field obj.answer_format is not the expected type, validation failed.")
+        obj.answer_options&.is_a?(Array) != false || raise("Passed value for field obj.answer_options is not the expected type, validation failed.")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "json"
+
+module AssemblyAI
+  class Lemur
+    # An answer generated by LeMUR and its question
+    class LemurQuestionAnswer
+      attr_reader :question, :answer, :additional_properties
+
+      # @param question [String] The question for LeMUR to answer
+      # @param answer [String] The answer generated by LeMUR
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Lemur::LemurQuestionAnswer]
+      def initialize(question:, answer:, additional_properties: nil)
+        # @type [String] The question for LeMUR to answer
+        @question = question
+        # @type [String] The answer generated by LeMUR
+        @answer = answer
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of LemurQuestionAnswer
+      #
+      # @param json_object [JSON]
+      # @return [Lemur::LemurQuestionAnswer]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        JSON.parse(json_object)
+        question = struct.question
+        answer = struct.answer
+        new(question: question, answer: answer, additional_properties: struct)
+      end
+
+      # Serialize an instance of LemurQuestionAnswer to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "question": @question, "answer": @answer }.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.question.is_a?(String) != false || raise("Passed value for field obj.question is not the expected type, validation failed.")
+        obj.answer.is_a?(String) != false || raise("Passed value for field obj.answer is not the expected type, validation failed.")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative "lemur_question_answer"
+require "json"
+
+module AssemblyAI
+  class Lemur
+    class LemurQuestionAnswerResponse
+      attr_reader :response, :request_id, :additional_properties
+
+      # @param response [Array<Lemur::LemurQuestionAnswer>] The answers generated by LeMUR and their questions
+      # @param request_id [String] The ID of the LeMUR request
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Lemur::LemurQuestionAnswerResponse]
+      def initialize(response:, request_id:, additional_properties: nil)
+        # @type [Array<Lemur::LemurQuestionAnswer>] The answers generated by LeMUR and their questions
+        @response = response
+        # @type [String] The ID of the LeMUR request
+        @request_id = request_id
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of LemurQuestionAnswerResponse
+      #
+      # @param json_object [JSON]
+      # @return [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
+          Lemur::LemurQuestionAnswer.from_json(json_object: v)
+        end
+        request_id = struct.request_id
+        new(response: response, request_id: request_id, additional_properties: struct)
+      end
+
+      # Serialize an instance of LemurQuestionAnswerResponse to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "response": @response, "request_id": @request_id }.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.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.")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "json"
+
+module AssemblyAI
+  class Lemur
+    # Any context about the transcripts you wish to provide. This can be a string or any object.
+    class LemurQuestionContext
+      attr_reader :member
+      alias kind_of? is_a?
+      # @param member [Object]
+      # @return [Lemur::LemurQuestionContext]
+      def initialize(member:)
+        # @type [Object]
+        @member = member
+      end
+
+      # Deserialize a JSON object to an instance of LemurQuestionContext
+      #
+      # @param json_object [JSON]
+      # @return [Lemur::LemurQuestionContext]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        begin
+          struct.is_a?(String) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+          member = json_object
+          return new(member: member)
+        rescue StandardError
+          # noop
+        end
+        begin
+          struct.is_a?(Hash) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+          member = json_object
+          return new(member: member)
+        rescue StandardError
+          # noop
+        end
+        new(member: struct)
+      end
+
+      # For Union Types, to_json functionality is delegated to the wrapped member.
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        @member.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        begin
+          return obj.is_a?(String) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+        rescue StandardError
+          # noop
+        end
+        begin
+          return obj.is_a?(Hash) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+        rescue StandardError
+          # noop
+        end
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+
+      # For Union Types, is_a? functionality is delegated to the wrapped member.
+      #
+      # @param obj [Object]
+      # @return [Boolean]
+      def is_a?(obj)
+        @member.is_a?(obj)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "json"
+
+module AssemblyAI
+  class Lemur
+    class LemurSummaryResponse
+      attr_reader :response, :request_id, :additional_properties
+
+      # @param response [String] The response generated by LeMUR
+      # @param request_id [String] The ID of the LeMUR request
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Lemur::LemurSummaryResponse]
+      def initialize(response:, request_id:, additional_properties: nil)
+        # @type [String] The response generated by LeMUR
+        @response = response
+        # @type [String] The ID of the LeMUR request
+        @request_id = request_id
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of LemurSummaryResponse
+      #
+      # @param json_object [JSON]
+      # @return [Lemur::LemurSummaryResponse]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        JSON.parse(json_object)
+        response = struct.response
+        request_id = struct.request_id
+        new(response: response, request_id: request_id, additional_properties: struct)
+      end
+
+      # Serialize an instance of LemurSummaryResponse to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "response": @response, "request_id": @request_id }.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.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.")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "json"
+
+module AssemblyAI
+  class Lemur
+    class LemurTaskResponse
+      attr_reader :response, :request_id, :additional_properties
+
+      # @param response [String] The response generated by LeMUR.
+      # @param request_id [String] The ID of the LeMUR request
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Lemur::LemurTaskResponse]
+      def initialize(response:, request_id:, additional_properties: nil)
+        # @type [String] The response generated by LeMUR.
+        @response = response
+        # @type [String] The ID of the LeMUR request
+        @request_id = request_id
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of LemurTaskResponse
+      #
+      # @param json_object [JSON]
+      # @return [Lemur::LemurTaskResponse]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        JSON.parse(json_object)
+        response = struct.response
+        request_id = struct.request_id
+        new(response: response, request_id: request_id, additional_properties: struct)
+      end
+
+      # Serialize an instance of LemurTaskResponse to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "response": @response, "request_id": @request_id }.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.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.")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "json"
+
+module AssemblyAI
+  class Lemur
+    class PurgeLemurRequestDataResponse
+      attr_reader :request_id, :request_id_to_purge, :deleted, :additional_properties
+
+      # @param request_id [String] The ID of the deletion request of the LeMUR request
+      # @param request_id_to_purge [String] The ID of the LeMUR request to purge the data for
+      # @param deleted [Boolean] Whether the request data was deleted
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Lemur::PurgeLemurRequestDataResponse]
+      def initialize(request_id:, request_id_to_purge:, deleted:, additional_properties: nil)
+        # @type [String] The ID of the deletion request of the LeMUR request
+        @request_id = request_id
+        # @type [String] The ID of the LeMUR request to purge the data for
+        @request_id_to_purge = request_id_to_purge
+        # @type [Boolean] Whether the request data was deleted
+        @deleted = deleted
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of PurgeLemurRequestDataResponse
+      #
+      # @param json_object [JSON]
+      # @return [Lemur::PurgeLemurRequestDataResponse]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        JSON.parse(json_object)
+        request_id = struct.request_id
+        request_id_to_purge = struct.request_id_to_purge
+        deleted = struct.deleted
+        new(request_id: request_id, request_id_to_purge: request_id_to_purge, deleted: deleted,
+            additional_properties: struct)
+      end
+
+      # Serialize an instance of PurgeLemurRequestDataResponse to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "request_id": @request_id, "request_id_to_purge": @request_id_to_purge, "deleted": @deleted }.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.request_id.is_a?(String) != false || raise("Passed value for field obj.request_id is not the expected type, validation failed.")
+        obj.request_id_to_purge.is_a?(String) != false || raise("Passed value for field obj.request_id_to_purge is not the expected type, validation failed.")
+        obj.deleted.is_a?(Boolean) != false || raise("Passed value for field obj.deleted is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/assemblyai/realtime/client.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "types/realtime_temporary_token_response"
+require "async"
+
+module AssemblyAI
+  class RealtimeClient
+    attr_reader :request_client
+
+    # @param request_client [RequestClient]
+    # @return [RealtimeClient]
+    def initialize(request_client:)
+      # @type [RequestClient]
+      @request_client = request_client
+    end
+
+    # Create a temporary authentication token for real-time transcription
+    #
+    # @param expires_in [Integer] The amount of time until the token expires in seconds
+    # @param request_options [RequestOptions]
+    # @return [Realtime::RealtimeTemporaryTokenResponse]
+    def create_temporary_token(expires_in:, request_options: nil)
+      response = @request_client.conn.post("/v2/realtime/token") 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.body = { **(request_options&.additional_body_parameters || {}), expires_in: expires_in }.compact
+      end
+      Realtime::RealtimeTemporaryTokenResponse.from_json(json_object: response.body)
+    end
+  end
+
+  class AsyncRealtimeClient
+    attr_reader :request_client
+
+    # @param request_client [AsyncRequestClient]
+    # @return [AsyncRealtimeClient]
+    def initialize(request_client:)
+      # @type [AsyncRequestClient]
+      @request_client = request_client
+    end
+
+    # Create a temporary authentication token for real-time transcription
+    #
+    # @param expires_in [Integer] The amount of time until the token expires in seconds
+    # @param request_options [RequestOptions]
+    # @return [Realtime::RealtimeTemporaryTokenResponse]
+    def create_temporary_token(expires_in:, request_options: nil)
+      Async do
+        response = @request_client.conn.post("/v2/realtime/token") 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.body = { **(request_options&.additional_body_parameters || {}), expires_in: expires_in }.compact
+        end
+        Realtime::RealtimeTemporaryTokenResponse.from_json(json_object: response.body)
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module AssemblyAI
+  class Realtime
+    # @type [AUDIO_ENCODING]
+    AUDIO_ENCODING = { pcm_s16le: "pcm_s16le", pcm_mulaw: "pcm_mulaw" }.freeze
+  end
+end