assemblyai 1.0.0.pre.beta.7 → 1.0.0.pre.beta.9

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

@@ -1,58 +1,76 @@
 # frozen_string_literal: true
 
 require_relative "transcript_paragraph"
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Transcripts
     class ParagraphsResponse
-      attr_reader :id, :confidence, :audio_duration, :paragraphs, :additional_properties
+      # @return [String]
+      attr_reader :id
+      # @return [Float]
+      attr_reader :confidence
+      # @return [Float]
+      attr_reader :audio_duration
+      # @return [Array<AssemblyAI::Transcripts::TranscriptParagraph>]
+      attr_reader :paragraphs
+      # @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 id [String]
       # @param confidence [Float]
       # @param audio_duration [Float]
-      # @param paragraphs [Array<Transcripts::TranscriptParagraph>]
+      # @param paragraphs [Array<AssemblyAI::Transcripts::TranscriptParagraph>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Transcripts::ParagraphsResponse]
+      # @return [AssemblyAI::Transcripts::ParagraphsResponse]
       def initialize(id:, confidence:, audio_duration:, paragraphs:, additional_properties: nil)
-        # @type [String]
         @id = id
-        # @type [Float]
         @confidence = confidence
-        # @type [Float]
         @audio_duration = audio_duration
-        # @type [Array<Transcripts::TranscriptParagraph>]
         @paragraphs = paragraphs
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties
+        @_field_set = { "id": id, "confidence": confidence, "audio_duration": audio_duration, "paragraphs": paragraphs }
       end
 
       # Deserialize a JSON object to an instance of ParagraphsResponse
       #
-      # @param json_object [JSON]
-      # @return [Transcripts::ParagraphsResponse]
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::ParagraphsResponse]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        id = struct.id
-        confidence = struct.confidence
-        audio_duration = struct.audio_duration
+        id = struct["id"]
+        confidence = struct["confidence"]
+        audio_duration = struct["audio_duration"]
         paragraphs = parsed_json["paragraphs"]&.map do |v|
           v = v.to_json
-          Transcripts::TranscriptParagraph.from_json(json_object: v)
+          AssemblyAI::Transcripts::TranscriptParagraph.from_json(json_object: v)
         end
-        new(id: id, confidence: confidence, audio_duration: audio_duration, paragraphs: paragraphs,
-            additional_properties: struct)
+        new(
+          id: id,
+          confidence: confidence,
+          audio_duration: audio_duration,
+          paragraphs: paragraphs,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of ParagraphsResponse to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        { "id": @id, "confidence": @confidence, "audio_duration": @audio_duration, "paragraphs": @paragraphs }.to_json
+        @_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.
+      # 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]

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

@@ -2,7 +2,10 @@
 
 module AssemblyAI
   class Transcripts
-    # Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
+    # Controls the filetype of the audio created by redact_pii_audio. Currently
+    #  supports mp3 (default) and wav. See [PII
+    #  redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more
+    #  details.
     class RedactPiiAudioQuality
       MP3 = "mp3"
       WAV = "wav"

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

@@ -1,46 +1,60 @@
 # frozen_string_literal: true
 
 require_relative "redacted_audio_status"
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Transcripts
     class RedactedAudioResponse
-      attr_reader :status, :redacted_audio_url, :additional_properties
+      # @return [AssemblyAI::Transcripts::REDACTED_AUDIO_STATUS] The status of the redacted audio
+      attr_reader :status
+      # @return [String] The URL of the redacted audio file
+      attr_reader :redacted_audio_url
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
 
-      # @param status [Transcripts::REDACTED_AUDIO_STATUS] The status of the redacted audio
+      OMIT = Object.new
+
+      # @param status [AssemblyAI::Transcripts::REDACTED_AUDIO_STATUS] The status of the redacted audio
       # @param redacted_audio_url [String] The URL of the redacted audio file
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Transcripts::RedactedAudioResponse]
+      # @return [AssemblyAI::Transcripts::RedactedAudioResponse]
       def initialize(status:, redacted_audio_url:, additional_properties: nil)
-        # @type [Transcripts::REDACTED_AUDIO_STATUS] The status of the redacted audio
         @status = status
-        # @type [String] The URL of the redacted audio file
         @redacted_audio_url = redacted_audio_url
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties
+        @_field_set = { "status": status, "redacted_audio_url": redacted_audio_url }
       end
 
       # Deserialize a JSON object to an instance of RedactedAudioResponse
       #
-      # @param json_object [JSON]
-      # @return [Transcripts::RedactedAudioResponse]
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::RedactedAudioResponse]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
-        JSON.parse(json_object)
-        status = struct.status
-        redacted_audio_url = struct.redacted_audio_url
-        new(status: status, redacted_audio_url: redacted_audio_url, additional_properties: struct)
+        status = struct["status"]
+        redacted_audio_url = struct["redacted_audio_url"]
+        new(
+          status: status,
+          redacted_audio_url: redacted_audio_url,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of RedactedAudioResponse to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        { "status": @status, "redacted_audio_url": @redacted_audio_url }.to_json
+        @_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.
+      # 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]

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

@@ -1,58 +1,76 @@
 # frozen_string_literal: true
 
 require_relative "transcript_sentence"
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Transcripts
     class SentencesResponse
-      attr_reader :id, :confidence, :audio_duration, :sentences, :additional_properties
+      # @return [String]
+      attr_reader :id
+      # @return [Float]
+      attr_reader :confidence
+      # @return [Float]
+      attr_reader :audio_duration
+      # @return [Array<AssemblyAI::Transcripts::TranscriptSentence>]
+      attr_reader :sentences
+      # @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 id [String]
       # @param confidence [Float]
       # @param audio_duration [Float]
-      # @param sentences [Array<Transcripts::TranscriptSentence>]
+      # @param sentences [Array<AssemblyAI::Transcripts::TranscriptSentence>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Transcripts::SentencesResponse]
+      # @return [AssemblyAI::Transcripts::SentencesResponse]
       def initialize(id:, confidence:, audio_duration:, sentences:, additional_properties: nil)
-        # @type [String]
         @id = id
-        # @type [Float]
         @confidence = confidence
-        # @type [Float]
         @audio_duration = audio_duration
-        # @type [Array<Transcripts::TranscriptSentence>]
         @sentences = sentences
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties
+        @_field_set = { "id": id, "confidence": confidence, "audio_duration": audio_duration, "sentences": sentences }
       end
 
       # Deserialize a JSON object to an instance of SentencesResponse
       #
-      # @param json_object [JSON]
-      # @return [Transcripts::SentencesResponse]
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::SentencesResponse]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        id = struct.id
-        confidence = struct.confidence
-        audio_duration = struct.audio_duration
+        id = struct["id"]
+        confidence = struct["confidence"]
+        audio_duration = struct["audio_duration"]
         sentences = parsed_json["sentences"]&.map do |v|
           v = v.to_json
-          Transcripts::TranscriptSentence.from_json(json_object: v)
+          AssemblyAI::Transcripts::TranscriptSentence.from_json(json_object: v)
         end
-        new(id: id, confidence: confidence, audio_duration: audio_duration, sentences: sentences,
-            additional_properties: struct)
+        new(
+          id: id,
+          confidence: confidence,
+          audio_duration: audio_duration,
+          sentences: sentences,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of SentencesResponse to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        { "id": @id, "confidence": @confidence, "audio_duration": @audio_duration, "sentences": @sentences }.to_json
+        @_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.
+      # 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]

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

@@ -1,71 +1,98 @@
 # frozen_string_literal: true
 
 require_relative "sentiment"
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Transcripts
-    # The result of the sentiment analysis model
+    # The result of the Sentiment Analysis model
     class SentimentAnalysisResult
-      attr_reader :text, :start, :end_, :sentiment, :confidence, :speaker, :additional_properties
+      # @return [String] The transcript of the sentence
+      attr_reader :text
+      # @return [Integer] The starting time, in milliseconds, of the sentence
+      attr_reader :start
+      # @return [Integer] The ending time, in milliseconds, of the sentence
+      attr_reader :end_
+      # @return [AssemblyAI::Transcripts::Sentiment] The detected sentiment for the sentence, one of POSITIVE, NEUTRAL, NEGATIVE
+      attr_reader :sentiment
+      # @return [Float] The confidence score for the detected sentiment of the sentence, from 0 to 1
+      attr_reader :confidence
+      # @return [String] The speaker of the sentence if [Speaker
+      #  Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is
+      #  enabled, else null
+      attr_reader :speaker
+      # @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 text [String] The transcript of the sentence
       # @param start [Integer] The starting time, in milliseconds, of the sentence
       # @param end_ [Integer] The ending time, in milliseconds, of the sentence
-      # @param sentiment [Transcripts::Sentiment] The detected sentiment for the sentence, one of POSITIVE, NEUTRAL, NEGATIVE
+      # @param sentiment [AssemblyAI::Transcripts::Sentiment] The detected sentiment for the sentence, one of POSITIVE, NEUTRAL, NEGATIVE
       # @param confidence [Float] The confidence score for the detected sentiment of the sentence, from 0 to 1
-      # @param speaker [String] The speaker of the sentence if [Speaker Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, else null
+      # @param speaker [String] The speaker of the sentence if [Speaker
+      #  Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is
+      #  enabled, else null
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Transcripts::SentimentAnalysisResult]
-      def initialize(text:, start:, end_:, sentiment:, confidence:, speaker: nil, additional_properties: nil)
-        # @type [String] The transcript of the sentence
+      # @return [AssemblyAI::Transcripts::SentimentAnalysisResult]
+      def initialize(text:, start:, end_:, sentiment:, confidence:, speaker: OMIT, additional_properties: nil)
         @text = text
-        # @type [Integer] The starting time, in milliseconds, of the sentence
         @start = start
-        # @type [Integer] The ending time, in milliseconds, of the sentence
         @end_ = end_
-        # @type [Transcripts::Sentiment] The detected sentiment for the sentence, one of POSITIVE, NEUTRAL, NEGATIVE
         @sentiment = sentiment
-        # @type [Float] The confidence score for the detected sentiment of the sentence, from 0 to 1
         @confidence = confidence
-        # @type [String] The speaker of the sentence if [Speaker Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, else null
-        @speaker = speaker
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @speaker = speaker if speaker != OMIT
         @additional_properties = additional_properties
+        @_field_set = {
+          "text": text,
+          "start": start,
+          "end": end_,
+          "sentiment": sentiment,
+          "confidence": confidence,
+          "speaker": speaker
+        }.reject do |_k, v|
+          v == OMIT
+        end
       end
 
       # Deserialize a JSON object to an instance of SentimentAnalysisResult
       #
-      # @param json_object [JSON]
-      # @return [Transcripts::SentimentAnalysisResult]
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::SentimentAnalysisResult]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
-        JSON.parse(json_object)
-        text = struct.text
-        start = struct.start
-        end_ = struct.end
-        sentiment = struct.sentiment
-        confidence = struct.confidence
-        speaker = struct.speaker
-        new(text: text, start: start, end_: end_, sentiment: sentiment, confidence: confidence, speaker: speaker,
-            additional_properties: struct)
+        text = struct["text"]
+        start = struct["start"]
+        end_ = struct["end"]
+        sentiment = struct["sentiment"]
+        confidence = struct["confidence"]
+        speaker = struct["speaker"]
+        new(
+          text: text,
+          start: start,
+          end_: end_,
+          sentiment: sentiment,
+          confidence: confidence,
+          speaker: speaker,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of SentimentAnalysisResult to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        {
-          "text": @text,
-          "start": @start,
-          "end": @end_,
-          "sentiment": @sentiment,
-          "confidence": @confidence,
-          "speaker": @speaker
-        }.to_json
+        @_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.
+      # 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]
@@ -73,7 +100,7 @@ module AssemblyAI
         obj.text.is_a?(String) != false || raise("Passed value for field obj.text is not the expected type, validation failed.")
         obj.start.is_a?(Integer) != false || raise("Passed value for field obj.start is not the expected type, validation failed.")
         obj.end_.is_a?(Integer) != false || raise("Passed value for field obj.end_ is not the expected type, validation failed.")
-        obj.sentiment.is_a?(Transcripts::Sentiment) != false || raise("Passed value for field obj.sentiment is not the expected type, validation failed.")
+        obj.sentiment.is_a?(AssemblyAI::Transcripts::Sentiment) != false || raise("Passed value for field obj.sentiment is not the expected type, validation failed.")
         obj.confidence.is_a?(Float) != false || raise("Passed value for field obj.confidence is not the expected type, validation failed.")
         obj.speaker&.is_a?(String) != false || raise("Passed value for field obj.speaker is not the expected type, validation failed.")
       end

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

@@ -1,49 +1,65 @@
 # frozen_string_literal: true
 
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Transcripts
     class SeverityScoreSummary
-      attr_reader :low, :medium, :high, :additional_properties
+      # @return [Float]
+      attr_reader :low
+      # @return [Float]
+      attr_reader :medium
+      # @return [Float]
+      attr_reader :high
+      # @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 low [Float]
       # @param medium [Float]
       # @param high [Float]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Transcripts::SeverityScoreSummary]
+      # @return [AssemblyAI::Transcripts::SeverityScoreSummary]
       def initialize(low:, medium:, high:, additional_properties: nil)
-        # @type [Float]
         @low = low
-        # @type [Float]
         @medium = medium
-        # @type [Float]
         @high = high
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties
+        @_field_set = { "low": low, "medium": medium, "high": high }
       end
 
       # Deserialize a JSON object to an instance of SeverityScoreSummary
       #
-      # @param json_object [JSON]
-      # @return [Transcripts::SeverityScoreSummary]
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::SeverityScoreSummary]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
-        JSON.parse(json_object)
-        low = struct.low
-        medium = struct.medium
-        high = struct.high
-        new(low: low, medium: medium, high: high, additional_properties: struct)
+        low = struct["low"]
+        medium = struct["medium"]
+        high = struct["high"]
+        new(
+          low: low,
+          medium: medium,
+          high: high,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of SeverityScoreSummary to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        { "low": @low, "medium": @medium, "high": @high }.to_json
+        @_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.
+      # 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]

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

@@ -6,6 +6,7 @@ module AssemblyAI
     class SpeechModel
       BEST = "best"
       NANO = "nano"
+      # @deprecated This option will stop working in the near future. Please use {#BEST} or {#NANO} instead
       CONFORMER2 = "conformer-2"
     end
   end

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

@@ -2,7 +2,9 @@
 
 module AssemblyAI
   class Transcripts
-    # 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.
+    # 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_NAME = "entity_name"
       HASH = "hash"

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

@@ -1,46 +1,60 @@
 # frozen_string_literal: true
 
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Transcripts
     # Timestamp containing a start and end property in milliseconds
     class Timestamp
-      attr_reader :start, :end_, :additional_properties
+      # @return [Integer] The start time in milliseconds
+      attr_reader :start
+      # @return [Integer] The end time in milliseconds
+      attr_reader :end_
+      # @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 start [Integer] The start time in milliseconds
       # @param end_ [Integer] The end time in milliseconds
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Transcripts::Timestamp]
+      # @return [AssemblyAI::Transcripts::Timestamp]
       def initialize(start:, end_:, additional_properties: nil)
-        # @type [Integer] The start time in milliseconds
         @start = start
-        # @type [Integer] The end time in milliseconds
         @end_ = end_
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties
+        @_field_set = { "start": start, "end": end_ }
       end
 
       # Deserialize a JSON object to an instance of Timestamp
       #
-      # @param json_object [JSON]
-      # @return [Transcripts::Timestamp]
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::Timestamp]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
-        JSON.parse(json_object)
-        start = struct.start
-        end_ = struct.end
-        new(start: start, end_: end_, additional_properties: struct)
+        start = struct["start"]
+        end_ = struct["end"]
+        new(
+          start: start,
+          end_: end_,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of Timestamp to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        { "start": @start, "end": @end_ }.to_json
+        @_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.
+      # 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]