telnyx 5.150.0 → 5.151.0

data/rbi/telnyx/models/ai_retrieve_conversation_histories_response.rbi

@@ -91,11 +91,6 @@ module Telnyx
         sig { returns(Integer) }
         attr_accessor :chunk_total
 
-        # Document identifier. Present only for knowledge_base records; null for all other
-        # record types.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :document_id
-
         # When the record was chunked, embedded, and indexed (ISO 8601).
         sig { returns(Time) }
         attr_accessor :ingested_at
@@ -113,14 +108,6 @@ module Telnyx
         sig { returns(String) }
         attr_accessor :record_id
 
-        # Type of the record.
-        sig do
-          returns(
-            Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::RecordType::TaggedSymbol
-          )
-        end
-        attr_accessor :record_type
-
         # The region where this record is stored.
         sig do
           returns(
@@ -142,9 +129,8 @@ module Telnyx
         sig { returns(String) }
         attr_accessor :user_id
 
-        # Arbitrary metadata attached to the record at ingestion time. Stored as a
-        # flat_object in OpenSearch and filterable via filter[field]=value query
-        # parameters.
+        # Arbitrary metadata attached to the record at ingestion time. Filterable via
+        # filter[field]=value query parameters.
         sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
         attr_reader :metadata
 
@@ -159,13 +145,10 @@ module Telnyx
             id: String,
             chunk_index: Integer,
             chunk_total: Integer,
-            document_id: T.nilable(String),
             ingested_at: Time,
             organization_id: String,
             record_created_at: Time,
             record_id: String,
-            record_type:
-              Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::RecordType::OrSymbol,
             region:
               Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::Region::OrSymbol,
             score: Float,
@@ -181,9 +164,6 @@ module Telnyx
           chunk_index:,
           # Total number of chunks the parent record was split into.
           chunk_total:,
-          # Document identifier. Present only for knowledge_base records; null for all other
-          # record types.
-          document_id:,
           # When the record was chunked, embedded, and indexed (ISO 8601).
           ingested_at:,
           # Identifier of the organization that owns this record.
@@ -193,8 +173,6 @@ module Telnyx
           # Identifier of the parent record. Multiple chunks from the same record share this
           # ID.
           record_id:,
-          # Type of the record.
-          record_type:,
           # The region where this record is stored.
           region:,
           # Cosine similarity score between the query vector and this chunk's vector. Higher
@@ -204,9 +182,8 @@ module Telnyx
           text:,
           # Identifier of the user who owns this record.
           user_id:,
-          # Arbitrary metadata attached to the record at ingestion time. Stored as a
-          # flat_object in OpenSearch and filterable via filter[field]=value query
-          # parameters.
+          # Arbitrary metadata attached to the record at ingestion time. Filterable via
+          # filter[field]=value query parameters.
           metadata: nil
         )
         end
@@ -217,13 +194,10 @@ module Telnyx
               id: String,
               chunk_index: Integer,
               chunk_total: Integer,
-              document_id: T.nilable(String),
               ingested_at: Time,
               organization_id: String,
               record_created_at: Time,
               record_id: String,
-              record_type:
-                Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::RecordType::TaggedSymbol,
               region:
                 Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::Region::TaggedSymbol,
               score: Float,
@@ -236,51 +210,6 @@ module Telnyx
         def to_hash
         end
 
-        # Type of the record.
-        module RecordType
-          extend Telnyx::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::RecordType
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          VOICE =
-            T.let(
-              :voice,
-              Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::RecordType::TaggedSymbol
-            )
-          MESSAGE =
-            T.let(
-              :message,
-              Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::RecordType::TaggedSymbol
-            )
-          AI_PIPELINE_STORAGE =
-            T.let(
-              :ai_pipeline_storage,
-              Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::RecordType::TaggedSymbol
-            )
-          KNOWLEDGE_BASE =
-            T.let(
-              :knowledge_base,
-              Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::RecordType::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                Telnyx::Models::AIRetrieveConversationHistoriesResponse::Data::RecordType::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-
         # The region where this record is stored.
         module Region
           extend Telnyx::Internal::Type::Enum
@@ -336,12 +265,11 @@ module Telnyx
             )
           end
 
-        # Current page number (always 1 — this API does not support pagination, use top_k
-        # instead).
+        # Current page number (1-based), matching the requested page[number].
         sig { returns(Integer) }
         attr_accessor :page_number
 
-        # Number of results per page (equals the effective top_k value).
+        # Number of results per page, matching the requested page[size].
         sig { returns(Integer) }
         attr_accessor :page_size
 
@@ -349,8 +277,7 @@ module Telnyx
         sig { returns(Integer) }
         attr_accessor :total_pages
 
-        # Total number of matching results across all queried regions (before top_k
-        # truncation).
+        # Total number of matching results across all queried regions.
         sig { returns(Integer) }
         attr_accessor :total_results
 
@@ -364,15 +291,13 @@ module Telnyx
           ).returns(T.attached_class)
         end
         def self.new(
-          # Current page number (always 1 — this API does not support pagination, use top_k
-          # instead).
+          # Current page number (1-based), matching the requested page[number].
           page_number:,
-          # Number of results per page (equals the effective top_k value).
+          # Number of results per page, matching the requested page[size].
           page_size:,
           # Total number of pages.
           total_pages:,
-          # Total number of matching results across all queried regions (before top_k
-          # truncation).
+          # Total number of matching results across all queried regions.
           total_results:
         )
         end

data/rbi/telnyx/models/calls/deepgram_nova2_config.rbi

@@ -23,6 +23,15 @@ module Telnyx
         end
         attr_accessor :transcription_model
 
+        # Nova-2 keyword biasing without intensifiers. Up to 100 terms to bias recognition
+        # toward. For weighted biasing, use `keywords_boosting` instead. Nova-2-only; use
+        # `keyterms` on Nova-3.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :hints
+
+        sig { params(hints: T::Array[String]).void }
+        attr_writer :hints
+
         # Whether to send also interim results. If set to false, only final results will
         # be sent.
         sig { returns(T.nilable(T::Boolean)) }
@@ -55,6 +64,17 @@ module Telnyx
         end
         attr_writer :language
 
+        # Enable Deepgram's smart formatting (capitalization, punctuation, and digit
+        # normalization). Note: Telnyx defaults this to `true`, overriding Deepgram's
+        # underlying default of `false` — omit the field to get a smart-formatted
+        # transcript, or set it to `false` to receive the raw lowercase transcript without
+        # punctuation.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :smart_format
+
+        sig { params(smart_format: T::Boolean).void }
+        attr_writer :smart_format
+
         # Number of milliseconds of silence to consider an utterance ended. Ranges from 0
         # to 5000 ms.
         sig { returns(T.nilable(Integer)) }
@@ -69,15 +89,21 @@ module Telnyx
               Telnyx::Calls::DeepgramNova2Config::TranscriptionEngine::OrSymbol,
             transcription_model:
               Telnyx::Calls::DeepgramNova2Config::TranscriptionModel::OrSymbol,
+            hints: T::Array[String],
             interim_results: T::Boolean,
             keywords_boosting: T::Hash[Symbol, Float],
             language: Telnyx::Calls::DeepgramNova2Config::Language::OrSymbol,
+            smart_format: T::Boolean,
             utterance_end_ms: Integer
           ).returns(T.attached_class)
         end
         def self.new(
           transcription_engine:,
           transcription_model:,
+          # Nova-2 keyword biasing without intensifiers. Up to 100 terms to bias recognition
+          # toward. For weighted biasing, use `keywords_boosting` instead. Nova-2-only; use
+          # `keyterms` on Nova-3.
+          hints: nil,
           # Whether to send also interim results. If set to false, only final results will
           # be sent.
           interim_results: nil,
@@ -87,6 +113,12 @@ module Telnyx
           keywords_boosting: nil,
           # Language to use for speech recognition with nova-2 model
           language: nil,
+          # Enable Deepgram's smart formatting (capitalization, punctuation, and digit
+          # normalization). Note: Telnyx defaults this to `true`, overriding Deepgram's
+          # underlying default of `false` — omit the field to get a smart-formatted
+          # transcript, or set it to `false` to receive the raw lowercase transcript without
+          # punctuation.
+          smart_format: nil,
           # Number of milliseconds of silence to consider an utterance ended. Ranges from 0
           # to 5000 ms.
           utterance_end_ms: nil
@@ -100,9 +132,11 @@ module Telnyx
                 Telnyx::Calls::DeepgramNova2Config::TranscriptionEngine::OrSymbol,
               transcription_model:
                 Telnyx::Calls::DeepgramNova2Config::TranscriptionModel::OrSymbol,
+              hints: T::Array[String],
               interim_results: T::Boolean,
               keywords_boosting: T::Hash[Symbol, Float],
               language: Telnyx::Calls::DeepgramNova2Config::Language::OrSymbol,
+              smart_format: T::Boolean,
               utterance_end_ms: Integer
             }
           )

data/rbi/telnyx/models/calls/deepgram_nova3_config.rbi

@@ -31,6 +31,14 @@ module Telnyx
         sig { params(interim_results: T::Boolean).void }
         attr_writer :interim_results
 
+        # Nova-3 keyterm prompting. Up to 100 domain-specific terms or brand names to bias
+        # recognition toward. Nova-3-only; use `hints` on Nova-2.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :keyterms
+
+        sig { params(keyterms: T::Array[String]).void }
+        attr_writer :keyterms
+
         # Keywords and their respective intensifiers (boosting values) to improve
         # transcription accuracy for specific words or phrases. The intensifier should be
         # a numeric value. Example: `{"snuffleupagus": 5, "systrom": 2, "krieger": 1}`.
@@ -55,6 +63,17 @@ module Telnyx
         end
         attr_writer :language
 
+        # Enable Deepgram's smart formatting (capitalization, punctuation, and digit
+        # normalization). Note: Telnyx defaults this to `true`, overriding Deepgram's
+        # underlying default of `false` — omit the field to get a smart-formatted
+        # transcript, or set it to `false` to receive the raw lowercase transcript without
+        # punctuation.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :smart_format
+
+        sig { params(smart_format: T::Boolean).void }
+        attr_writer :smart_format
+
         # Number of milliseconds of silence to consider an utterance ended. Ranges from 0
         # to 5000 ms.
         sig { returns(T.nilable(Integer)) }
@@ -70,8 +89,10 @@ module Telnyx
             transcription_model:
               Telnyx::Calls::DeepgramNova3Config::TranscriptionModel::OrSymbol,
             interim_results: T::Boolean,
+            keyterms: T::Array[String],
             keywords_boosting: T::Hash[Symbol, Float],
             language: Telnyx::Calls::DeepgramNova3Config::Language::OrSymbol,
+            smart_format: T::Boolean,
             utterance_end_ms: Integer
           ).returns(T.attached_class)
         end
@@ -81,12 +102,21 @@ module Telnyx
           # Whether to send also interim results. If set to false, only final results will
           # be sent.
           interim_results: nil,
+          # Nova-3 keyterm prompting. Up to 100 domain-specific terms or brand names to bias
+          # recognition toward. Nova-3-only; use `hints` on Nova-2.
+          keyterms: nil,
           # Keywords and their respective intensifiers (boosting values) to improve
           # transcription accuracy for specific words or phrases. The intensifier should be
           # a numeric value. Example: `{"snuffleupagus": 5, "systrom": 2, "krieger": 1}`.
           keywords_boosting: nil,
           # Language to use for speech recognition with nova-3 model
           language: nil,
+          # Enable Deepgram's smart formatting (capitalization, punctuation, and digit
+          # normalization). Note: Telnyx defaults this to `true`, overriding Deepgram's
+          # underlying default of `false` — omit the field to get a smart-formatted
+          # transcript, or set it to `false` to receive the raw lowercase transcript without
+          # punctuation.
+          smart_format: nil,
           # Number of milliseconds of silence to consider an utterance ended. Ranges from 0
           # to 5000 ms.
           utterance_end_ms: nil
@@ -101,8 +131,10 @@ module Telnyx
               transcription_model:
                 Telnyx::Calls::DeepgramNova3Config::TranscriptionModel::OrSymbol,
               interim_results: T::Boolean,
+              keyterms: T::Array[String],
               keywords_boosting: T::Hash[Symbol, Float],
               language: Telnyx::Calls::DeepgramNova3Config::Language::OrSymbol,
+              smart_format: T::Boolean,
               utterance_end_ms: Integer
             }
           )

data/rbi/telnyx/models/calls/transcription_start_request.rbi

@@ -58,6 +58,7 @@ module Telnyx
                 Telnyx::Calls::TranscriptionEngineAssemblyaiConfig,
                 Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig,
                 Telnyx::Calls::TranscriptionEngineSonioxConfig,
+                Telnyx::Calls::TranscriptionEngineParakeetConfig,
                 Telnyx::Calls::TranscriptionEngineAConfig,
                 Telnyx::Calls::TranscriptionEngineBConfig,
                 Telnyx::Calls::DeepgramNova2Config,
@@ -79,6 +80,7 @@ module Telnyx
                 Telnyx::Calls::TranscriptionEngineAssemblyaiConfig::OrHash,
                 Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::OrHash,
                 Telnyx::Calls::TranscriptionEngineSonioxConfig::OrHash,
+                Telnyx::Calls::TranscriptionEngineParakeetConfig::OrHash,
                 Telnyx::Calls::TranscriptionEngineAConfig::OrHash,
                 Telnyx::Calls::TranscriptionEngineBConfig::OrHash,
                 Telnyx::Calls::DeepgramNova2Config::OrHash,
@@ -112,6 +114,7 @@ module Telnyx
                 Telnyx::Calls::TranscriptionEngineAssemblyaiConfig::OrHash,
                 Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::OrHash,
                 Telnyx::Calls::TranscriptionEngineSonioxConfig::OrHash,
+                Telnyx::Calls::TranscriptionEngineParakeetConfig::OrHash,
                 Telnyx::Calls::TranscriptionEngineAConfig::OrHash,
                 Telnyx::Calls::TranscriptionEngineBConfig::OrHash,
                 Telnyx::Calls::DeepgramNova2Config::OrHash,
@@ -154,6 +157,7 @@ module Telnyx
                   Telnyx::Calls::TranscriptionEngineAssemblyaiConfig,
                   Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig,
                   Telnyx::Calls::TranscriptionEngineSonioxConfig,
+                  Telnyx::Calls::TranscriptionEngineParakeetConfig,
                   Telnyx::Calls::TranscriptionEngineAConfig,
                   Telnyx::Calls::TranscriptionEngineBConfig,
                   Telnyx::Calls::DeepgramNova2Config,
@@ -260,6 +264,7 @@ module Telnyx
                 Telnyx::Calls::TranscriptionEngineAssemblyaiConfig,
                 Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig,
                 Telnyx::Calls::TranscriptionEngineSonioxConfig,
+                Telnyx::Calls::TranscriptionEngineParakeetConfig,
                 Telnyx::Calls::TranscriptionEngineAConfig,
                 Telnyx::Calls::TranscriptionEngineBConfig,
                 Telnyx::Calls::DeepgramNova2Config,

data/rbi/telnyx/models/public_internet_gateway.rbi

@@ -8,11 +8,53 @@ module Telnyx
           T.any(Telnyx::PublicInternetGateway, Telnyx::Internal::AnyHash)
         end
 
-      sig { returns(T.attached_class) }
-      def self.new
+      # A user specified name for the interface.
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # The id of the network associated with the interface.
+      sig { returns(T.nilable(String)) }
+      attr_reader :network_id
+
+      sig { params(network_id: String).void }
+      attr_writer :network_id
+
+      # The region interface is deployed to.
+      sig { returns(T.nilable(String)) }
+      attr_reader :region_code
+
+      sig { params(region_code: String).void }
+      attr_writer :region_code
+
+      sig do
+        params(name: String, network_id: String, region_code: String).returns(
+          T.attached_class
+        )
+      end
+      def self.new(
+        # A user specified name for the interface.
+        name: nil,
+        # The id of the network associated with the interface.
+        network_id: nil,
+        # The region interface is deployed to.
+        region_code: nil
+      )
       end
 
-      sig { override.returns({}) }
+      sig do
+        override.returns(
+          {
+            name: String,
+            network_id: String,
+            status: Telnyx::InterfaceStatus::OrSymbol,
+            public_ip: String,
+            region_code: String
+          }
+        )
+      end
       def to_hash
       end
     end