assemblyai 1.0.0.pre.beta.5 → 1.0.0.pre.beta.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d91bff775d7a91af629545e3aebf04fd8af3757c0593c9782eff3bd6e838170
-  data.tar.gz: 27b065dedebaab7a01389e58870f322dd7c7f7eb2e0aafac71077b73eff4833a
+  metadata.gz: 76ddcd8ef7bd03dab334e872387e6ea6f01d1c93d26ec1a1ffc57a29ec498f1a
+  data.tar.gz: 57abade0a92ef0dd0031f27098d9f7bdebfc17f7445776409af4b8627afe11a0
 SHA512:
-  metadata.gz: 82a793a096563db2d9f57be102e5076fd6a2b2a8c293cac817c83bf578f32dac03ee7ab1f05246200a9f87eafd8451eb2fb71d86aa2302e26191c6ac8bfe2634
-  data.tar.gz: 591118e0a7fde11c070e19518e338498defda2187bd8e4d1fa0a8205c5baba910e29d64c22462c1fce4c57f969b6b9bb657c1da64f29d1e9eeb8194fb4c3f650
+  metadata.gz: 17410d40ef0225953ff55910ad561334b7ef6a7cda2e9b190103885878c920b573abcffc9fddc904aefccf896e03629640e7884efde32e4df39e549e17847252
+  data.tar.gz: 1c4739c4fee6647ac9edffd00a1a84c7bd7b6fa0064e5126097e6194372a967a976acfecee128a5c7a08738f9864044278247574c91ddb5b40b0903197f49cbd

data/lib/assemblyai/files/client.rb

@@ -17,16 +17,39 @@ module AssemblyAI
 
     # Upload your media file directly to the AssemblyAI API if it isn't accessible via a URL already.
     #
-    # @param request [String] Base64 encoded bytes
+    # @param file [String, IO] File path, Base64 String, or an IO object (e.g. Faraday::UploadIO, etc.)
     # @param request_options [RequestOptions]
     # @return [Files::UploadedFile]
-    def upload(request:, request_options: nil)
+    def upload(file:, request_options: nil)
       response = @request_client.conn.post("/v2/upload") do |req|
+        if file.is_a? String
+          begin
+            path = Pathname.new(file)
+          rescue StandardError
+            file_data = file
+          end
+          unless path.nil?
+            if path.file?
+              file_data = File.new(file)
+            elsif path.directory?
+              raise "file path has to be a path to file, but is a path to directory"
+            else
+              raise "file at path does not exist"
+            end
+          end
+        else
+          file_data = file
+        end
         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.headers["Content-Type"] = "application/octet-stream"
-        req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+        if file.is_a? File
+          req.headers["Content-Length"] = File.size(file_data.path).to_s
+        else
+          req.headers["Transfer-Encoding"] = "chunked"
+        end
+        req.body = file_data
       end
       Files::UploadedFile.from_json(json_object: response.body)
     end
@@ -44,17 +67,40 @@ module AssemblyAI
 
     # Upload your media file directly to the AssemblyAI API if it isn't accessible via a URL already.
     #
-    # @param request [String] Base64 encoded bytes
+    # @param file [String, IO] File path, Base64 String, or an IO object (e.g. Faraday::UploadIO, etc.)
     # @param request_options [RequestOptions]
     # @return [Files::UploadedFile]
-    def upload(request:, request_options: nil)
+    def upload(file:, request_options: nil)
       Async do
         response = @request_client.conn.post("/v2/upload") do |req|
+          if file.is_a? String
+            begin
+              path = Pathname.new(file)
+            rescue StandardError
+              file_data = file
+            end
+            unless path.nil?
+              if path.file?
+                file_data = File.new(file)
+              elsif path.directory?
+                raise "file path has to be a path to file, but is a path to directory"
+              else
+                raise "file at path does not exist"
+              end
+            end
+          else
+            file_data = file
+          end
           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.headers["Content-Type"] = "application/octet-stream"
-          req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+          if file.is_a? File
+            req.headers["Content-Length"] = File.size(file_data.path).to_s
+          else
+            req.headers["Transfer-Encoding"] = "chunked"
+          end
+          req.body = file_data
         end
         Files::UploadedFile.from_json(json_object: response.body)
       end

data/lib/assemblyai/realtime/client.rb

@@ -15,7 +15,7 @@ module AssemblyAI
       @request_client = request_client
     end
 
-    # Create a temporary authentication token for real-time transcription
+    # Create a temporary authentication token for Streaming Speech-to-Text
     #
     # @param expires_in [Integer] The amount of time until the token expires in seconds
     # @param request_options [RequestOptions]
@@ -41,7 +41,7 @@ module AssemblyAI
       @request_client = request_client
     end
 
-    # Create a temporary authentication token for real-time transcription
+    # Create a temporary authentication token for Streaming Speech-to-Text
     #
     # @param expires_in [Integer] The amount of time until the token expires in seconds
     # @param request_options [RequestOptions]

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

@@ -7,11 +7,11 @@ module AssemblyAI
     class RealtimeTemporaryTokenResponse
       attr_reader :token, :additional_properties
 
-      # @param token [String] The temporary authentication token for real-time transcription
+      # @param token [String] The temporary authentication token for Streaming Speech-to-Text
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Realtime::RealtimeTemporaryTokenResponse]
       def initialize(token:, additional_properties: nil)
-        # @type [String] The temporary authentication token for real-time transcription
+        # @type [String] The temporary authentication token for Streaming Speech-to-Text
         @token = token
         # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties

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

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 require "json"
-require_relative "session_begins"
-require_relative "partial_transcript"
-require_relative "final_transcript"
-require_relative "session_terminated"
-require_relative "realtime_error"
+require_relative "../../realtime/types/session_begins"
+require_relative "../../realtime/types/partial_transcript"
+require_relative "../../realtime/types/final_transcript"
+require_relative "../../realtime/types/session_terminated"
+require_relative "../../realtime/types/realtime_error"
 
 module AssemblyAI
   class Realtime

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 require "json"
-require_relative "terminate_session"
-require_relative "force_end_utterance"
-require_relative "configure_end_utterance_silence_threshold"
+require_relative "../../realtime/types/terminate_session"
+require_relative "../../realtime/types/force_end_utterance"
+require_relative "../../realtime/types/configure_end_utterance_silence_threshold"
 
 module AssemblyAI
   class Realtime

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

@@ -7,11 +7,11 @@ module AssemblyAI
     class TerminateSession
       attr_reader :terminate_session, :additional_properties
 
-      # @param terminate_session [Boolean] Set to true to end your real-time session forever
+      # @param terminate_session [Boolean] Set to true to end your streaming session forever
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Realtime::TerminateSession]
       def initialize(terminate_session:, additional_properties: nil)
-        # @type [Boolean] Set to true to end your real-time session forever
+        # @type [Boolean] Set to true to end your streaming session forever
         @terminate_session = terminate_session
         # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties

data/lib/assemblyai/transcripts/client.rb

@@ -31,7 +31,8 @@ module AssemblyAI
       @request_client = request_client
     end
 
-    # Retrieve a list of transcripts you created
+    # Retrieve a list of transcripts you created.
+    # Transcripts are sorted from newest to oldest. The previous URL always points to a page with older transcripts.
     #
     # @param limit [Integer] Maximum amount of transcripts to retrieve
     # @param status [Transcripts::TranscriptStatus] Filter by transcript status
@@ -273,7 +274,8 @@ module AssemblyAI
       @request_client = request_client
     end
 
-    # Retrieve a list of transcripts you created
+    # Retrieve a list of transcripts you created.
+    # Transcripts are sorted from newest to oldest. The previous URL always points to a page with older transcripts.
     #
     # @param limit [Integer] Maximum amount of transcripts to retrieve
     # @param status [Transcripts::TranscriptStatus] Filter by transcript status

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

@@ -4,26 +4,27 @@ require "json"
 
 module AssemblyAI
   class Transcripts
+    # Details of the transcript page. Transcripts are sorted from newest to oldest. The previous URL always points to a page with older transcripts.
     class PageDetails
       attr_reader :limit, :result_count, :current_url, :prev_url, :next_url, :additional_properties
 
       # @param limit [Integer]
       # @param result_count [Integer]
       # @param current_url [String]
-      # @param prev_url [String]
-      # @param next_url [String]
+      # @param prev_url [String] The URL to the next page of transcripts. The previous URL always points to a page with older transcripts.
+      # @param next_url [String] The URL to the next page of transcripts. The next URL always points to a page with newer transcripts.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Transcripts::PageDetails]
-      def initialize(limit:, result_count:, current_url:, prev_url:, next_url: nil, additional_properties: nil)
+      def initialize(limit:, result_count:, current_url:, prev_url: nil, next_url: nil, additional_properties: nil)
         # @type [Integer]
         @limit = limit
         # @type [Integer]
         @result_count = result_count
         # @type [String]
         @current_url = current_url
-        # @type [String]
+        # @type [String] The URL to the next page of transcripts. The previous URL always points to a page with older transcripts.
         @prev_url = prev_url
-        # @type [String]
+        # @type [String] The URL to the next page of transcripts. The next URL always points to a page with newer transcripts.
         @next_url = next_url
         # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties
@@ -66,7 +67,7 @@ module AssemblyAI
         obj.limit.is_a?(Integer) != false || raise("Passed value for field obj.limit is not the expected type, validation failed.")
         obj.result_count.is_a?(Integer) != false || raise("Passed value for field obj.result_count is not the expected type, validation failed.")
         obj.current_url.is_a?(String) != false || raise("Passed value for field obj.current_url is not the expected type, validation failed.")
-        obj.prev_url.is_a?(String) != false || raise("Passed value for field obj.prev_url is not the expected type, validation failed.")
+        obj.prev_url&.is_a?(String) != false || raise("Passed value for field obj.prev_url is not the expected type, validation failed.")
         obj.next_url&.is_a?(String) != false || raise("Passed value for field obj.next_url is not the expected type, validation failed.")
       end
     end

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

@@ -4,6 +4,7 @@ module AssemblyAI
   class Transcripts
     # The speech model to use for the transcription.
     class SpeechModel
+      BEST = "best"
       NANO = "nano"
       CONFORMER2 = "conformer-2"
     end

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

@@ -2,9 +2,9 @@
 
 module AssemblyAI
   class Transcripts
-    # The replacement logic for detected PII, can be "entity_type" or "hash". See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
+    # The replacement logic for detected PII, can be "entity_name" or "hash". See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
     class SubstitutionPolicy
-      ENTITY_TYPE = "entity_type"
+      ENTITY_NAME = "entity_name"
       HASH = "hash"
     end
   end

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

@@ -6,6 +6,7 @@ require "json"
 
 module AssemblyAI
   class Transcripts
+    # A list of transcripts. Transcripts are sorted from newest to oldest. The previous URL always points to a page with older transcripts.
     class TranscriptList
       attr_reader :page_details, :transcripts, :additional_properties
 

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

@@ -7,7 +7,7 @@ require "json"
 module AssemblyAI
   class Transcripts
     class TranscriptListItem
-      attr_reader :id, :resource_url, :status, :created, :completed, :audio_url, :additional_properties
+      attr_reader :id, :resource_url, :status, :created, :completed, :audio_url, :error, :additional_properties
 
       # @param id [String]
       # @param resource_url [String]
@@ -15,9 +15,11 @@ module AssemblyAI
       # @param created [DateTime]
       # @param completed [DateTime]
       # @param audio_url [String]
+      # @param error [String] Error message of why the transcript failed
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Transcripts::TranscriptListItem]
-      def initialize(id:, resource_url:, status:, created:, completed:, audio_url:, additional_properties: nil)
+      def initialize(id:, resource_url:, status:, created:, completed:, audio_url:, error: nil,
+                     additional_properties: nil)
         # @type [String]
         @id = id
         # @type [String]
@@ -30,6 +32,8 @@ module AssemblyAI
         @completed = completed
         # @type [String]
         @audio_url = audio_url
+        # @type [String] Error message of why the transcript failed
+        @error = error
         # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties
       end
@@ -47,8 +51,9 @@ module AssemblyAI
         created = (DateTime.parse(parsed_json["created"]) unless parsed_json["created"].nil?)
         completed = (DateTime.parse(parsed_json["completed"]) unless parsed_json["completed"].nil?)
         audio_url = struct.audio_url
+        error = struct.error
         new(id: id, resource_url: resource_url, status: status, created: created, completed: completed,
-            audio_url: audio_url, additional_properties: struct)
+            audio_url: audio_url, error: error, additional_properties: struct)
       end
 
       # Serialize an instance of TranscriptListItem to a JSON object
@@ -61,7 +66,8 @@ module AssemblyAI
           "status": @status,
           "created": @created,
           "completed": @completed,
-          "audio_url": @audio_url
+          "audio_url": @audio_url,
+          "error": @error
         }.to_json
       end
 
@@ -76,6 +82,7 @@ module AssemblyAI
         obj.created.is_a?(DateTime) != false || raise("Passed value for field obj.created is not the expected type, validation failed.")
         obj.completed.is_a?(DateTime) != false || raise("Passed value for field obj.completed is not the expected type, validation failed.")
         obj.audio_url.is_a?(String) != false || raise("Passed value for field obj.audio_url is not the expected type, validation failed.")
+        obj.error&.is_a?(String) != false || raise("Passed value for field obj.error is not the expected type, validation failed.")
       end
     end
   end

data/lib/requests.rb

@@ -20,7 +20,7 @@ module AssemblyAI
       @headers = {
         "X-Fern-Language": "Ruby",
         "X-Fern-SDK-Name": "assemblyai",
-        "X-Fern-SDK-Version": "1.0.0-beta.5",
+        "X-Fern-SDK-Version": "1.0.0-beta.7",
         "Authorization": api_key.to_s
       }
       @conn = Faraday.new(@base_url, headers: @headers) do |faraday|
@@ -46,7 +46,7 @@ module AssemblyAI
       @headers = {
         "X-Fern-Language": "Ruby",
         "X-Fern-SDK-Name": "assemblyai",
-        "X-Fern-SDK-Version": "1.0.0-beta.5",
+        "X-Fern-SDK-Version": "1.0.0-beta.7",
         "Authorization": api_key.to_s
       }
       @conn = Faraday.new(@base_url, headers: @headers) do |faraday|

data/lib/types_export.rb

@@ -46,26 +46,26 @@ require_relative "assemblyai/transcripts/types/page_details"
 require_relative "assemblyai/transcripts/types/transcript_list_item"
 require_relative "assemblyai/transcripts/types/transcript_list"
 require_relative "assemblyai/transcripts/types/audio_intelligence_model_status"
+require_relative "assemblyai/realtime/types/realtime_base_message"
 require_relative "assemblyai/realtime/types/session_begins"
 require_relative "assemblyai/realtime/types/partial_transcript"
 require_relative "assemblyai/realtime/types/final_transcript"
 require_relative "assemblyai/realtime/types/session_terminated"
 require_relative "assemblyai/realtime/types/realtime_error"
-require_relative "assemblyai/realtime/types/receive_message"
-require_relative "assemblyai/realtime/types/audio_data"
-require_relative "assemblyai/realtime/types/terminate_session"
-require_relative "assemblyai/realtime/types/force_end_utterance"
-require_relative "assemblyai/realtime/types/configure_end_utterance_silence_threshold"
-require_relative "assemblyai/realtime/types/send_message"
-require_relative "assemblyai/realtime/types/realtime_temporary_token_response"
-require_relative "assemblyai/realtime/types/realtime_base_message"
 require_relative "assemblyai/realtime/types/realtime_message"
 require_relative "assemblyai/realtime/types/message_type"
 require_relative "assemblyai/realtime/types/realtime_transcript_type"
 require_relative "assemblyai/realtime/types/realtime_transcript"
 require_relative "assemblyai/realtime/types/realtime_base_transcript"
 require_relative "assemblyai/realtime/types/word"
+require_relative "assemblyai/realtime/types/audio_data"
+require_relative "assemblyai/realtime/types/force_end_utterance"
+require_relative "assemblyai/realtime/types/configure_end_utterance_silence_threshold"
+require_relative "assemblyai/realtime/types/terminate_session"
 require_relative "assemblyai/realtime/types/audio_encoding"
+require_relative "assemblyai/realtime/types/realtime_temporary_token_response"
+require_relative "assemblyai/realtime/types/receive_message"
+require_relative "assemblyai/realtime/types/send_message"
 require_relative "assemblyai/lemur/types/purge_lemur_request_data_response"
 require_relative "assemblyai/lemur/types/lemur_base_response"
 require_relative "assemblyai/lemur/types/lemur_summary_response"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: assemblyai
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta.5
+  version: 1.0.0.pre.beta.7
 platform: ruby
 authors:
 - ''
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-19 00:00:00.000000000 Z
+date: 2024-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http-faraday