telnyx 5.167.0 → 5.169.0

data/lib/telnyx/models/ai/audio_transcribe_params.rb

@@ -11,8 +11,12 @@ module Telnyx
         # @!attribute model
         #   ID of the model to use. `distil-whisper/distil-large-v2` is lower latency but
         #   English-only. `openai/whisper-large-v3-turbo` is multi-lingual but slightly
-        #   higher latency. `deepgram/nova-3` supports English variants (en, en-US, en-GB,
-        #   en-AU, en-NZ, en-IN) and only accepts mp3/wav files.
+        #   higher latency. The `deepgram/*` models only accept mp3/wav files:
+        #   `deepgram/nova-3` covers ~49 languages plus `multi` and `deepgram/nova-2` covers
+        #   ~33, while the `-medical` variants are tuned for clinical vocabulary and accept
+        #   English only (`en` and its regional variants, e.g. `en-US`, `en-GB`).
+        #   `nvidia/parakeet-v3` is multilingual with automatic language detection;
+        #   `omi-health/omi-med-stt-v1` is a medical model, English only.
         #
         #   @return [Symbol, Telnyx::Models::AI::AudioTranscribeParams::Model]
         required :model, enum: -> { Telnyx::AI::AudioTranscribeParams::Model }
@@ -20,8 +24,8 @@ module Telnyx
         # @!attribute file
         #   The audio file object to transcribe, in one of these formats: flac, mp3, mp4,
         #   mpeg, mpga, m4a, ogg, wav, or webm. File uploads are limited to 100 MB. Cannot
-        #   be used together with `file_url`. Note: `deepgram/nova-3` only supports mp3 and
-        #   wav formats.
+        #   be used together with `file_url`. Note: the `deepgram/*` models only support mp3
+        #   and wav formats.
         #
         #   @return [Pathname, StringIO, IO, String, Telnyx::FilePart, nil]
         optional :file, Telnyx::Internal::Type::FileInput
@@ -29,23 +33,30 @@ module Telnyx
         # @!attribute file_url
         #   Link to audio file in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a,
         #   ogg, wav, or webm. Support for hosted files is limited to 100MB. Cannot be used
-        #   together with `file`. Note: `deepgram/nova-3` only supports mp3 and wav formats.
+        #   together with `file`. Note: the `deepgram/*` models only support mp3 and wav
+        #   formats.
         #
         #   @return [String, nil]
         optional :file_url, String
 
         # @!attribute language
-        #   The language of the audio to be transcribed. For `deepgram/nova-3`, only English
-        #   variants are supported: `en`, `en-US`, `en-GB`, `en-AU`, `en-NZ`, `en-IN`. For
+        #   The language of the audio to be transcribed. `deepgram/nova-3` supports ~49
+        #   languages plus `multi`, and `deepgram/nova-2` supports ~33 plus `multi`; the
+        #   `-medical` variants are English only (`en` and its regional variants, e.g.
+        #   `en-US`, `en-GB`). Deepgram models validate on the base language and forward the
+        #   full tag, so regional variants such as `de-CH` and `pt-BR` are accepted where
+        #   the base language is supported; an unsupported language returns a 400. For
         #   `openai/whisper-large-v3-turbo`, supports multiple languages.
         #   `distil-whisper/distil-large-v2` does not support language parameter.
+        #   `nvidia/parakeet-v3` detects the language automatically;
+        #   `omi-health/omi-med-stt-v1` is English only.
         #
         #   @return [String, nil]
         optional :language, String
 
         # @!attribute model_config
-        #   Additional model-specific configuration parameters. Only allowed with
-        #   `deepgram/nova-3` model. Can include Deepgram-specific options such as
+        #   Additional model-specific configuration parameters. Only allowed with the
+        #   `deepgram/*` models. Can include Deepgram-specific options such as
         #   `smart_format`, `punctuate`, `diarize`, `utterance`, `numerals`, and `language`.
         #   If `language` is provided both as a top-level parameter and in `model_config`,
         #   the top-level parameter takes precedence.
@@ -80,9 +91,9 @@ module Telnyx
         #
         #   @param file_url [String] Link to audio file in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg
         #
-        #   @param language [String] The language of the audio to be transcribed. For `deepgram/nova-3`, only English
+        #   @param language [String] The language of the audio to be transcribed. `deepgram/nova-3` supports ~49 lang
         #
-        #   @param model_config [Hash{Symbol=>Object}] Additional model-specific configuration parameters. Only allowed with `deepgram/
+        #   @param model_config [Hash{Symbol=>Object}] Additional model-specific configuration parameters. Only allowed with the `deepg
         #
         #   @param response_format [Symbol, Telnyx::Models::AI::AudioTranscribeParams::ResponseFormat] The format of the transcript output. Use `verbose_json` to take advantage of tim
         #
@@ -92,14 +103,23 @@ module Telnyx
 
         # ID of the model to use. `distil-whisper/distil-large-v2` is lower latency but
         # English-only. `openai/whisper-large-v3-turbo` is multi-lingual but slightly
-        # higher latency. `deepgram/nova-3` supports English variants (en, en-US, en-GB,
-        # en-AU, en-NZ, en-IN) and only accepts mp3/wav files.
+        # higher latency. The `deepgram/*` models only accept mp3/wav files:
+        # `deepgram/nova-3` covers ~49 languages plus `multi` and `deepgram/nova-2` covers
+        # ~33, while the `-medical` variants are tuned for clinical vocabulary and accept
+        # English only (`en` and its regional variants, e.g. `en-US`, `en-GB`).
+        # `nvidia/parakeet-v3` is multilingual with automatic language detection;
+        # `omi-health/omi-med-stt-v1` is a medical model, English only.
         module Model
           extend Telnyx::Internal::Type::Enum
 
           DISTIL_WHISPER_DISTIL_LARGE_V2 = :"distil-whisper/distil-large-v2"
           OPENAI_WHISPER_LARGE_V3_TURBO = :"openai/whisper-large-v3-turbo"
+          DEEPGRAM_NOVA_2 = :"deepgram/nova-2"
+          DEEPGRAM_NOVA_2_MEDICAL = :"deepgram/nova-2-medical"
           DEEPGRAM_NOVA_3 = :"deepgram/nova-3"
+          DEEPGRAM_NOVA_3_MEDICAL = :"deepgram/nova-3-medical"
+          NVIDIA_PARAKEET_V3 = :"nvidia/parakeet-v3"
+          OMI_HEALTH_OMI_MED_STT_V1 = :"omi-health/omi-med-stt-v1"
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/telnyx/models/ai/audio_transcribe_response.rb

@@ -13,27 +13,29 @@ module Telnyx
 
         # @!attribute duration
         #   The duration of the audio file in seconds. Returned by
-        #   `distil-whisper/distil-large-v2` and `deepgram/nova-3` when `response_format` is
-        #   `verbose_json`. Not returned by `openai/whisper-large-v3-turbo`.
+        #   `distil-whisper/distil-large-v2` and the `deepgram/*` models when
+        #   `response_format` is `verbose_json`. Not returned by
+        #   `openai/whisper-large-v3-turbo`.
         #
         #   @return [Float, nil]
         optional :duration, Float
 
         # @!attribute segments
         #   Segments of the transcribed text and their corresponding details. Returned by
-        #   `distil-whisper/distil-large-v2` when `response_format` is `verbose_json`. Not
-        #   returned by `openai/whisper-large-v3-turbo`.
+        #   `distil-whisper/distil-large-v2` and the `deepgram/*` models when
+        #   `response_format` is `verbose_json`; Deepgram segments also carry nested `words`
+        #   and `speakers`. Not returned by `openai/whisper-large-v3-turbo`.
         #
         #   @return [Array<Telnyx::Models::AI::AudioTranscribeResponse::Segment>, nil]
         optional :segments,
                  -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::AI::AudioTranscribeResponse::Segment] }
 
         # @!attribute words
-        #   Word-level timestamps and optional speaker labels. Only returned by
-        #   `deepgram/nova-3` when word-level output is enabled via `model_config`.
+        #   Word-level timestamps and optional speaker labels. Only returned by the
+        #   `deepgram/*` models when word-level output is enabled via `model_config`.
         #
-        #   @return [Array<Telnyx::Models::AI::AudioTranscribeResponse::Word>, nil]
-        optional :words, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::AI::AudioTranscribeResponse::Word] }
+        #   @return [Array<Telnyx::Models::AI::AudioTranscriptionResponseWord>, nil]
+        optional :words, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AudioTranscriptionResponseWord] }
 
         # @!method initialize(text:, duration: nil, segments: nil, words: nil)
         #   Some parameter documentations has been truncated, see
@@ -41,9 +43,10 @@ module Telnyx
         #
         #   Response fields vary by model. `distil-whisper/distil-large-v2` returns `text`,
         #   `duration`, and `segments` in `verbose_json` mode.
-        #   `openai/whisper-large-v3-turbo` returns `text` only. `deepgram/nova-3` returns
-        #   `text` and, depending on `model_config`, may include `words` with per-word
-        #   timestamps and speaker labels.
+        #   `openai/whisper-large-v3-turbo` returns `text` only. The `deepgram/*` models
+        #   return `text` and, depending on `model_config`, may include `words` with
+        #   per-word timestamps and speaker labels. The Parakeet models
+        #   (`nvidia/parakeet-v3`, `omi-health/omi-med-stt-v1`) return `text` only.
         #
         #   @param text [String] The transcribed text for the audio file.
         #
@@ -51,7 +54,7 @@ module Telnyx
         #
         #   @param segments [Array<Telnyx::Models::AI::AudioTranscribeResponse::Segment>] Segments of the transcribed text and their corresponding details. Returned by `d
         #
-        #   @param words [Array<Telnyx::Models::AI::AudioTranscribeResponse::Word>] Word-level timestamps and optional speaker labels. Only returned by `deepgram/no
+        #   @param words [Array<Telnyx::Models::AI::AudioTranscriptionResponseWord>] Word-level timestamps and optional speaker labels. Only returned by the `deepgra
 
         class Segment < Telnyx::Internal::Type::BaseModel
           # @!attribute id
@@ -78,60 +81,35 @@ module Telnyx
           #   @return [String]
           required :text, String
 
-          # @!method initialize(id:, end_:, start:, text:)
-          #   @param id [Float] Unique identifier of the segment.
-          #
-          #   @param end_ [Float] End time of the segment in seconds.
+          # @!attribute speakers
+          #   Speaker indices heard in this segment. Returned by the `deepgram/*` models when
+          #   `diarize` is enabled via `model_config`.
           #
-          #   @param start [Float] Start time of the segment in seconds.
-          #
-          #   @param text [String] Text content of the segment.
-        end
+          #   @return [Array<Integer>, nil]
+          optional :speakers, Telnyx::Internal::Type::ArrayOf[Integer]
 
-        class Word < Telnyx::Internal::Type::BaseModel
-          # @!attribute end_
-          #   End time of the word in seconds.
+          # @!attribute words
+          #   Word-level timing detail for this segment. Returned by the `deepgram/*` models
+          #   when word-level output is enabled via `model_config`.
           #
-          #   @return [Float]
-          required :end_, Float, api_name: :end
+          #   @return [Array<Telnyx::Models::AI::AudioTranscriptionResponseWord>, nil]
+          optional :words, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AudioTranscriptionResponseWord] }
 
-          # @!attribute start
-          #   Start time of the word in seconds.
+          # @!method initialize(id:, end_:, start:, text:, speakers: nil, words: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::AI::AudioTranscribeResponse::Segment} for more details.
           #
-          #   @return [Float]
-          required :start, Float
-
-          # @!attribute word
-          #   The transcribed word.
-          #
-          #   @return [String]
-          required :word, String
-
-          # @!attribute confidence
-          #   Confidence score for the word (0.0 to 1.0).
-          #
-          #   @return [Float, nil]
-          optional :confidence, Float
-
-          # @!attribute speaker
-          #   Speaker index. Only present when diarization is enabled via `model_config`.
-          #
-          #   @return [Integer, nil]
-          optional :speaker, Integer
-
-          # @!method initialize(end_:, start:, word:, confidence: nil, speaker: nil)
-          #   Word-level timing detail. Only present when using `deepgram/nova-3` with
-          #   `model_config` options that enable word timestamps.
+          #   @param id [Float] Unique identifier of the segment.
           #
-          #   @param end_ [Float] End time of the word in seconds.
+          #   @param end_ [Float] End time of the segment in seconds.
           #
-          #   @param start [Float] Start time of the word in seconds.
+          #   @param start [Float] Start time of the segment in seconds.
           #
-          #   @param word [String] The transcribed word.
+          #   @param text [String] Text content of the segment.
           #
-          #   @param confidence [Float] Confidence score for the word (0.0 to 1.0).
+          #   @param speakers [Array<Integer>] Speaker indices heard in this segment. Returned by the `deepgram/*` models when
           #
-          #   @param speaker [Integer] Speaker index. Only present when diarization is enabled via `model_config`.
+          #   @param words [Array<Telnyx::Models::AI::AudioTranscriptionResponseWord>] Word-level timing detail for this segment. Returned by the `deepgram/*` models w
         end
       end
     end

data/lib/telnyx/models/ai/audio_transcription_response_word.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      class AudioTranscriptionResponseWord < Telnyx::Internal::Type::BaseModel
+        # @!attribute end_
+        #   End time of the word in seconds.
+        #
+        #   @return [Float]
+        required :end_, Float, api_name: :end
+
+        # @!attribute start
+        #   Start time of the word in seconds.
+        #
+        #   @return [Float]
+        required :start, Float
+
+        # @!attribute word
+        #   The transcribed word.
+        #
+        #   @return [String]
+        required :word, String
+
+        # @!attribute confidence
+        #   Confidence score for the word (0.0 to 1.0).
+        #
+        #   @return [Float, nil]
+        optional :confidence, Float
+
+        # @!attribute punctuated_word
+        #   The transcribed word with punctuation and capitalisation applied. Only present
+        #   when `punctuate` or `smart_format` is enabled via `model_config`.
+        #
+        #   @return [String, nil]
+        optional :punctuated_word, String
+
+        # @!attribute speaker
+        #   Speaker index. Only present when diarization is enabled via `model_config`.
+        #
+        #   @return [Integer, nil]
+        optional :speaker, Integer
+
+        # @!attribute speaker_confidence
+        #   Confidence score for the speaker assignment (0.0 to 1.0). Only present when
+        #   diarization is enabled via `model_config`.
+        #
+        #   @return [Float, nil]
+        optional :speaker_confidence, Float
+
+        # @!method initialize(end_:, start:, word:, confidence: nil, punctuated_word: nil, speaker: nil, speaker_confidence: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AI::AudioTranscriptionResponseWord} for more details.
+        #
+        #   Word-level timing detail. Only present when using a `deepgram/*` model with
+        #   `model_config` options that enable word timestamps.
+        #
+        #   @param end_ [Float] End time of the word in seconds.
+        #
+        #   @param start [Float] Start time of the word in seconds.
+        #
+        #   @param word [String] The transcribed word.
+        #
+        #   @param confidence [Float] Confidence score for the word (0.0 to 1.0).
+        #
+        #   @param punctuated_word [String] The transcribed word with punctuation and capitalisation applied. Only present w
+        #
+        #   @param speaker [Integer] Speaker index. Only present when diarization is enabled via `model_config`.
+        #
+        #   @param speaker_confidence [Float] Confidence score for the speaker assignment (0.0 to 1.0). Only present when diar
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/chat_completion_request.rb

@@ -48,25 +48,6 @@ module Telnyx
         #   @return [Float, nil]
         optional :frequency_penalty, Float
 
-        # @!attribute guided_choice
-        #   If specified, the output will be exactly one of the choices.
-        #
-        #   @return [Array<String>, nil]
-        optional :guided_choice, Telnyx::Internal::Type::ArrayOf[String]
-
-        # @!attribute guided_json
-        #   Must be a valid JSON schema. If specified, the output will follow the JSON
-        #   schema.
-        #
-        #   @return [Hash{Symbol=>Object}, nil]
-        optional :guided_json, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
-
-        # @!attribute guided_regex
-        #   If specified, the output will follow the regex pattern.
-        #
-        #   @return [String, nil]
-        optional :guided_regex, String
-
         # @!attribute length_penalty
         #   This is used with `use_beam_search` to prefer shorter or longer completions.
         #
@@ -144,11 +125,13 @@ module Telnyx
         optional :region, enum: -> { Telnyx::AI::ChatCompletionRequest::Region }
 
         # @!attribute response_format
-        #   Use this is you want to guarantee a JSON output without defining a schema. For
-        #   control over the schema, use `guided_json`.
+        #   Controls the format of the model output. `json_object` guarantees valid JSON
+        #   output without defining a schema; `json_schema` constrains the output to the
+        #   JSON schema you supply via the `json_schema` property and is the supported way
+        #   to get guaranteed structured output on Telnyx-hosted models.
         #
-        #   @return [Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat, nil]
-        optional :response_format, -> { Telnyx::AI::ChatCompletionRequest::ResponseFormat }
+        #   @return [Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat::ResponseFormatText, Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat::ResponseFormatJsonObject, Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat::ResponseFormatJsonSchemaParam, nil]
+        optional :response_format, union: -> { Telnyx::AI::ChatCompletionRequest::ResponseFormat }
 
         # @!attribute seed
         #   If specified, the system will make a best effort to sample deterministically,
@@ -225,7 +208,7 @@ module Telnyx
         #   @return [Boolean, nil]
         optional :use_beam_search, Telnyx::Internal::Type::Boolean
 
-        # @!method initialize(messages:, api_key_ref: nil, best_of: nil, early_stopping: nil, enable_thinking: nil, frequency_penalty: nil, guided_choice: nil, guided_json: nil, guided_regex: nil, length_penalty: nil, logprobs: nil, max_tokens: nil, min_p: nil, mode: nil, model: nil, n: nil, presence_penalty: nil, reasoning_effort: nil, region: nil, response_format: nil, seed: nil, service_tier: nil, stop: nil, stream: nil, temperature: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, use_beam_search: nil)
+        # @!method initialize(messages:, api_key_ref: nil, best_of: nil, early_stopping: nil, enable_thinking: nil, frequency_penalty: nil, length_penalty: nil, logprobs: nil, max_tokens: nil, min_p: nil, mode: nil, model: nil, n: nil, presence_penalty: nil, reasoning_effort: nil, region: nil, response_format: nil, seed: nil, service_tier: nil, stop: nil, stream: nil, temperature: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, use_beam_search: nil)
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::AI::ChatCompletionRequest} for more details.
         #
@@ -241,12 +224,6 @@ module Telnyx
         #
         #   @param frequency_penalty [Float] Higher values will penalize the model from repeating the same output tokens.
         #
-        #   @param guided_choice [Array<String>] If specified, the output will be exactly one of the choices.
-        #
-        #   @param guided_json [Hash{Symbol=>Object}] Must be a valid JSON schema. If specified, the output will follow the JSON schem
-        #
-        #   @param guided_regex [String] If specified, the output will follow the regex pattern.
-        #
         #   @param length_penalty [Float] This is used with `use_beam_search` to prefer shorter or longer completions.
         #
         #   @param logprobs [Boolean] Whether to return log probabilities of the output tokens or not. If true, return
@@ -267,7 +244,7 @@ module Telnyx
         #
         #   @param region [Symbol, Telnyx::Models::AI::ChatCompletionRequest::Region] Optional data-residency region the request should be served from, using the same
         #
-        #   @param response_format [Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat] Use this is you want to guarantee a JSON output without defining a schema. For c
+        #   @param response_format [Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat::ResponseFormatText, Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat::ResponseFormatJsonObject, Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat::ResponseFormatJsonSchemaParam] Controls the format of the model output. `json_object` guarantees valid JSON out
         #
         #   @param seed [Integer] If specified, the system will make a best effort to sample deterministically, su
         #
@@ -427,29 +404,129 @@ module Telnyx
           #   @return [Array<Symbol>]
         end
 
+        # Controls the format of the model output. `json_object` guarantees valid JSON
+        # output without defining a schema; `json_schema` constrains the output to the
+        # JSON schema you supply via the `json_schema` property and is the supported way
+        # to get guaranteed structured output on Telnyx-hosted models.
+        #
         # @see Telnyx::Models::AI::ChatCompletionRequest#response_format
-        class ResponseFormat < Telnyx::Internal::Type::BaseModel
-          # @!attribute type
-          #
-          #   @return [Symbol, Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat::Type]
-          required :type, enum: -> { Telnyx::AI::ChatCompletionRequest::ResponseFormat::Type }
+        module ResponseFormat
+          extend Telnyx::Internal::Type::Union
 
-          # @!method initialize(type:)
-          #   Use this is you want to guarantee a JSON output without defining a schema. For
-          #   control over the schema, use `guided_json`.
-          #
-          #   @param type [Symbol, Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat::Type]
+          # Plain text output.
+          variant -> { Telnyx::AI::ChatCompletionRequest::ResponseFormat::ResponseFormatText }
 
-          # @see Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat#type
-          module Type
-            extend Telnyx::Internal::Type::Enum
+          # JSON mode: the model output is valid JSON, without a schema.
+          variant -> { Telnyx::AI::ChatCompletionRequest::ResponseFormat::ResponseFormatJsonObject }
 
-            TEXT = :text
-            JSON_OBJECT = :json_object
+          # Structured output: the model output is constrained to the JSON schema supplied in `json_schema`.
+          variant -> { Telnyx::AI::ChatCompletionRequest::ResponseFormat::ResponseFormatJsonSchemaParam }
 
-            # @!method self.values
-            #   @return [Array<Symbol>]
+          class ResponseFormatText < Telnyx::Internal::Type::BaseModel
+            # @!attribute type
+            #
+            #   @return [Symbol, :text]
+            required :type, const: :text
+
+            # @!method initialize(type: :text)
+            #   Plain text output.
+            #
+            #   @param type [Symbol, :text]
+          end
+
+          class ResponseFormatJsonObject < Telnyx::Internal::Type::BaseModel
+            # @!attribute type
+            #
+            #   @return [Symbol, :json_object]
+            required :type, const: :json_object
+
+            # @!method initialize(type: :json_object)
+            #   JSON mode: the model output is valid JSON, without a schema.
+            #
+            #   @param type [Symbol, :json_object]
+          end
+
+          class ResponseFormatJsonSchemaParam < Telnyx::Internal::Type::BaseModel
+            # @!attribute json_schema
+            #   The JSON schema configuration, required when `type` is `json_schema`. Matches
+            #   the
+            #   [OpenAI structured outputs](https://platform.openai.com/docs/guides/structured-outputs)
+            #   `json_schema` response format.
+            #
+            #   @return [Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat::ResponseFormatJsonSchemaParam::JsonSchema]
+            required :json_schema,
+                     -> { Telnyx::AI::ChatCompletionRequest::ResponseFormat::ResponseFormatJsonSchemaParam::JsonSchema }
+
+            # @!attribute type
+            #
+            #   @return [Symbol, :json_schema]
+            required :type, const: :json_schema
+
+            # @!method initialize(json_schema:, type: :json_schema)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat::ResponseFormatJsonSchemaParam}
+            #   for more details.
+            #
+            #   Structured output: the model output is constrained to the JSON schema supplied
+            #   in `json_schema`.
+            #
+            #   @param json_schema [Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat::ResponseFormatJsonSchemaParam::JsonSchema] The JSON schema configuration, required when `type` is `json_schema`. Matches th
+            #
+            #   @param type [Symbol, :json_schema]
+
+            # @see Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat::ResponseFormatJsonSchemaParam#json_schema
+            class JsonSchema < Telnyx::Internal::Type::BaseModel
+              # @!attribute name
+              #   The name of the response format. Used for clarity only.
+              #
+              #   @return [String]
+              required :name, String
+
+              # @!attribute description
+              #   A description of what the response format is for, typically used to guide the
+              #   model.
+              #
+              #   @return [String, nil]
+              optional :description, String
+
+              # @!attribute schema
+              #   The JSON schema the model output must conform to. A valid
+              #   [JSON Schema](https://json-schema.org) object, e.g. a Pydantic
+              #   `model_json_schema()` export.
+              #
+              #   @return [Hash{Symbol=>Object}, nil]
+              optional :schema, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+              # @!attribute strict
+              #   Enables strict schema adherence when supported by the model. If the generated
+              #   output does not match the provided schema, the request fails instead of
+              #   returning non-conformant output.
+              #
+              #   @return [Boolean, nil]
+              optional :strict, Telnyx::Internal::Type::Boolean
+
+              # @!method initialize(name:, description: nil, schema: nil, strict: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat::ResponseFormatJsonSchemaParam::JsonSchema}
+              #   for more details.
+              #
+              #   The JSON schema configuration, required when `type` is `json_schema`. Matches
+              #   the
+              #   [OpenAI structured outputs](https://platform.openai.com/docs/guides/structured-outputs)
+              #   `json_schema` response format.
+              #
+              #   @param name [String] The name of the response format. Used for clarity only.
+              #
+              #   @param description [String] A description of what the response format is for, typically used to guide the mo
+              #
+              #   @param schema [Hash{Symbol=>Object}] The JSON schema the model output must conform to. A valid [JSON Schema](https://
+              #
+              #   @param strict [Boolean] Enables strict schema adherence when supported by the model. If the generated ou
+            end
           end
+
+          # @!method self.variants
+          #   @return [Array(Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat::ResponseFormatText, Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat::ResponseFormatJsonObject, Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat::ResponseFormatJsonSchemaParam)]
         end
 
         # Up to 4 sequences where the API will stop generating further tokens. The
@@ -494,8 +571,8 @@ module Telnyx
           class Function < Telnyx::Internal::Type::BaseModel
             # @!attribute function
             #
-            #   @return [Telnyx::Models::AI::ChatCompletionRequest::Tool::Function::Function]
-            required :function, -> { Telnyx::AI::ChatCompletionRequest::Tool::Function::Function }
+            #   @return [Telnyx::Models::AI::OpenAI::FunctionDefinition]
+            required :function, -> { Telnyx::AI::OpenAI::FunctionDefinition }
 
             # @!attribute type
             #
@@ -503,31 +580,8 @@ module Telnyx
             required :type, const: :function
 
             # @!method initialize(function:, type: :function)
-            #   @param function [Telnyx::Models::AI::ChatCompletionRequest::Tool::Function::Function]
+            #   @param function [Telnyx::Models::AI::OpenAI::FunctionDefinition]
             #   @param type [Symbol, :function]
-
-            # @see Telnyx::Models::AI::ChatCompletionRequest::Tool::Function#function
-            class Function < Telnyx::Internal::Type::BaseModel
-              # @!attribute name
-              #
-              #   @return [String]
-              required :name, String
-
-              # @!attribute description
-              #
-              #   @return [String, nil]
-              optional :description, String
-
-              # @!attribute parameters
-              #
-              #   @return [Hash{Symbol=>Object}, nil]
-              optional :parameters, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
-
-              # @!method initialize(name:, description: nil, parameters: nil)
-              #   @param name [String]
-              #   @param description [String]
-              #   @param parameters [Hash{Symbol=>Object}]
-            end
           end
 
           class Retrieval < Telnyx::Internal::Type::BaseModel

data/lib/telnyx/models/ai/flow_node.rb

@@ -78,7 +78,7 @@ module Telnyx
         #   follow-up fetch per shared tool. Ignored on input — set `shared_tool_ids` to
         #   configure a node's tools.
         #
-        #   @return [Array<Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>>, nil]
+        #   @return [Array<Array<Telnyx::Models::AI::AssistantTool::Function, Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::AssistantTool::Hangup, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>>, nil]
         optional :tools,
                  -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool]] }
 
@@ -132,7 +132,7 @@ module Telnyx
         #
         #   @param shared_tool_ids [Array<String>] IDs of shared (org-level) tools available at this node. Knowledge bases are atta
         #
-        #   @param tools [Array<Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>>] Full tool definitions for this node, resolved from `shared_tool_ids` server-side
+        #   @param tools [Array<Array<Telnyx::Models::AI::AssistantTool::Function, Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::AssistantTool::Hangup, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>>] Full tool definitions for this node, resolved from `shared_tool_ids` server-side
         #
         #   @param tools_mode [Symbol, Telnyx::Models::AI::FlowNode::ToolsMode] How `shared_tool_ids` combine with the assistant-level tool set. `replace` (defa
         #