diff --git a/assemblyai.gemspec b/assemblyai.gemspec index 2f6e689..4e46d25 100644 --- a/assemblyai.gemspec +++ b/assemblyai.gemspec @@ -4,7 +4,7 @@ require_relative "lib/gemconfig" Gem::Specification.new do |spec| spec.name = "assemblyai" - spec.version = "1.0.0-beta.6" + spec.version = "1.0.0-beta.7" spec.authors = AssemblyAI::Gemconfig::AUTHORS spec.email = AssemblyAI::Gemconfig::EMAIL spec.summary = AssemblyAI::Gemconfig::SUMMARY diff --git a/lib/assemblyai/realtime/client.rb b/lib/assemblyai/realtime/client.rb index 56fec37..4c705ce 100644 --- a/lib/assemblyai/realtime/client.rb +++ b/lib/assemblyai/realtime/client.rb @@ -15,7 +15,7 @@ def initialize(request_client:) @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 @@ def initialize(request_client:) @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] diff --git a/lib/assemblyai/realtime/types/realtime_temporary_token_response.rb b/lib/assemblyai/realtime/types/realtime_temporary_token_response.rb index 8758f01..bd9145f 100644 --- a/lib/assemblyai/realtime/types/realtime_temporary_token_response.rb +++ b/lib/assemblyai/realtime/types/realtime_temporary_token_response.rb @@ -7,11 +7,11 @@ class Realtime 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 diff --git a/lib/assemblyai/realtime/types/receive_message.rb b/lib/assemblyai/realtime/types/receive_message.rb index b991958..0eec40f 100644 --- a/lib/assemblyai/realtime/types/receive_message.rb +++ b/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 diff --git a/lib/assemblyai/realtime/types/send_message.rb b/lib/assemblyai/realtime/types/send_message.rb index f4f4a8f..365cb79 100644 --- a/lib/assemblyai/realtime/types/send_message.rb +++ b/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 diff --git a/lib/assemblyai/realtime/types/terminate_session.rb b/lib/assemblyai/realtime/types/terminate_session.rb index 3ebd937..e48429c 100644 --- a/lib/assemblyai/realtime/types/terminate_session.rb +++ b/lib/assemblyai/realtime/types/terminate_session.rb @@ -7,11 +7,11 @@ class Realtime 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 diff --git a/lib/assemblyai/transcripts/client.rb b/lib/assemblyai/transcripts/client.rb index e2f42ba..35c8135 100644 --- a/lib/assemblyai/transcripts/client.rb +++ b/lib/assemblyai/transcripts/client.rb @@ -31,7 +31,8 @@ def initialize(request_client:) @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 @@ def initialize(request_client:) @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 diff --git a/lib/assemblyai/transcripts/types/page_details.rb b/lib/assemblyai/transcripts/types/page_details.rb index f4483b0..e126a00 100644 --- a/lib/assemblyai/transcripts/types/page_details.rb +++ b/lib/assemblyai/transcripts/types/page_details.rb @@ -4,26 +4,27 @@ 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 @@ def self.validate_raw(obj:) 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 diff --git a/lib/assemblyai/transcripts/types/speech_model.rb b/lib/assemblyai/transcripts/types/speech_model.rb index f44bcdf..b01fc72 100644 --- a/lib/assemblyai/transcripts/types/speech_model.rb +++ b/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 diff --git a/lib/assemblyai/transcripts/types/substitution_policy.rb b/lib/assemblyai/transcripts/types/substitution_policy.rb index 09dcc39..259abdf 100644 --- a/lib/assemblyai/transcripts/types/substitution_policy.rb +++ b/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 diff --git a/lib/assemblyai/transcripts/types/transcript_list.rb b/lib/assemblyai/transcripts/types/transcript_list.rb index aa49a0b..41b0785 100644 --- a/lib/assemblyai/transcripts/types/transcript_list.rb +++ b/lib/assemblyai/transcripts/types/transcript_list.rb @@ -6,6 +6,7 @@ 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 diff --git a/lib/assemblyai/transcripts/types/transcript_list_item.rb b/lib/assemblyai/transcripts/types/transcript_list_item.rb index 75c3812..235d838 100644 --- a/lib/assemblyai/transcripts/types/transcript_list_item.rb +++ b/lib/assemblyai/transcripts/types/transcript_list_item.rb @@ -7,7 +7,7 @@ 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 @@ class TranscriptListItem # @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 @@ def initialize(id:, resource_url:, status:, created:, completed:, audio_url:, ad @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 @@ def self.from_json(json_object:) 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 @@ def to_json(*_args) "status": @status, "created": @created, "completed": @completed, - "audio_url": @audio_url + "audio_url": @audio_url, + "error": @error }.to_json end @@ -76,6 +82,7 @@ def self.validate_raw(obj:) 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 diff --git a/lib/requests.rb b/lib/requests.rb index c79a06c..9c35655 100644 --- a/lib/requests.rb +++ b/lib/requests.rb @@ -20,7 +20,7 @@ def initialize(api_key:, environment: Environment::DEFAULT, max_retries: nil, ti @headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "assemblyai", - "X-Fern-SDK-Version": "1.0.0-beta.6", + "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 @@ def initialize(api_key:, environment: Environment::DEFAULT, max_retries: nil, ti @headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "assemblyai", - "X-Fern-SDK-Version": "1.0.0-beta.6", + "X-Fern-SDK-Version": "1.0.0-beta.7", "Authorization": api_key.to_s } @conn = Faraday.new(@base_url, headers: @headers) do |faraday| diff --git a/lib/types_export.rb b/lib/types_export.rb index 7b38834..932e69d 100644 --- a/lib/types_export.rb +++ b/lib/types_export.rb @@ -46,26 +46,26 @@ 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"