telnyx 5.100.0 → 5.102.0

data/lib/telnyx/resources/ai/chat.rb

@@ -5,14 +5,17 @@ module Telnyx
     class AI
       # Generate text with LLMs
       class Chat
+        # @deprecated
+        #
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::AI::ChatCreateCompletionParams} for more details.
         #
-        # Chat with a language model. This endpoint is consistent with the
+        # **Deprecated**: Use `POST /v2/ai/openai/chat/completions` instead. Chat with a
+        # language model. This endpoint is consistent with the
         # [OpenAI Chat Completions API](https://platform.openai.com/docs/api-reference/chat)
         # and may be used with the OpenAI JS or Python SDK.
         #
-        # @overload create_completion(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, model: nil, n: nil, presence_penalty: nil, response_format: nil, stream: nil, temperature: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, use_beam_search: nil, request_options: {})
+        # @overload create_completion(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, model: nil, n: nil, presence_penalty: nil, response_format: nil, seed: nil, stop: nil, stream: nil, temperature: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, use_beam_search: nil, request_options: {})
         #
         # @param messages [Array<Telnyx::Models::AI::ChatCreateCompletionParams::Message>] A list of the previous chat messages for context.
         #
@@ -48,6 +51,10 @@ module Telnyx
         #
         # @param response_format [Telnyx::Models::AI::ChatCreateCompletionParams::ResponseFormat] Use this is you want to guarantee a JSON output without defining a schema. For c
         #
+        # @param seed [Integer] If specified, the system will make a best effort to sample deterministically, su
+        #
+        # @param stop [String, Array<String>] Up to 4 sequences where the API will stop generating further tokens. The returne
+        #
         # @param stream [Boolean] Whether or not to stream data-only server-sent events as they become available.
         #
         # @param temperature [Float] Adjusts the "creativity" of the model. Lower values make the model more determin

data/lib/telnyx/resources/ai/openai/chat.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class AI
+      class OpenAI
+        class Chat
+          # Some parameter documentations has been truncated, see
+          # {Telnyx::Models::AI::OpenAI::ChatCreateCompletionParams} for more details.
+          #
+          # Chat with a language model. This endpoint is consistent with the
+          # [OpenAI Chat Completions API](https://platform.openai.com/docs/api-reference/chat)
+          # and may be used with the OpenAI JS or Python SDK by setting the base URL to
+          # `https://api.telnyx.com/v2/ai/openai`.
+          #
+          # @overload create_completion(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, model: nil, n: nil, presence_penalty: nil, response_format: nil, seed: nil, stop: nil, stream: nil, temperature: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, use_beam_search: nil, request_options: {})
+          #
+          # @param messages [Array<Telnyx::Models::AI::OpenAI::ChatCreateCompletionParams::Message>] A list of the previous chat messages for context.
+          #
+          # @param api_key_ref [String] If you are using an external inference provider like xAI or OpenAI, this field a
+          #
+          # @param best_of [Integer] This is used with `use_beam_search` to determine how many candidate beams to exp
+          #
+          # @param early_stopping [Boolean] This is used with `use_beam_search`. If `true`, generation stops as soon as ther
+          #
+          # @param enable_thinking [Boolean] Whether to enable the thinking/reasoning phase for models that support it (e.g.,
+          #
+          # @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
+          #
+          # @param max_tokens [Integer] Maximum number of completion tokens the model should generate.
+          #
+          # @param min_p [Float] This is an alternative to `top_p` that [many prefer](https://github.com/huggingf
+          #
+          # @param model [String] The language model to chat with.
+          #
+          # @param n [Float] This will return multiple choices for you instead of a single chat completion.
+          #
+          # @param presence_penalty [Float] Higher values will penalize the model from repeating the same output tokens.
+          #
+          # @param response_format [Telnyx::Models::AI::OpenAI::ChatCreateCompletionParams::ResponseFormat] Use this is you want to guarantee a JSON output without defining a schema. For c
+          #
+          # @param seed [Integer] If specified, the system will make a best effort to sample deterministically, su
+          #
+          # @param stop [String, Array<String>] Up to 4 sequences where the API will stop generating further tokens. The returne
+          #
+          # @param stream [Boolean] Whether or not to stream data-only server-sent events as they become available.
+          #
+          # @param temperature [Float] Adjusts the "creativity" of the model. Lower values make the model more determin
+          #
+          # @param tool_choice [Symbol, Telnyx::Models::AI::OpenAI::ChatCreateCompletionParams::ToolChoice]
+          #
+          # @param tools [Array<Telnyx::Models::AI::OpenAI::ChatCreateCompletionParams::Tool::Function, Telnyx::Models::AI::OpenAI::ChatCreateCompletionParams::Tool::Retrieval>] The `function` tool type follows the same schema as the [OpenAI Chat Completions
+          #
+          # @param top_logprobs [Integer] This is used with `logprobs`. An integer between 0 and 20 specifying the number
+          #
+          # @param top_p [Float] An alternative or complement to `temperature`. This adjusts how many of the top
+          #
+          # @param use_beam_search [Boolean] Setting this to `true` will allow the model to [explore more completion options]
+          #
+          # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Hash{Symbol=>Object}]
+          #
+          # @see Telnyx::Models::AI::OpenAI::ChatCreateCompletionParams
+          def create_completion(params)
+            parsed, options = Telnyx::AI::OpenAI::ChatCreateCompletionParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "ai/openai/chat/completions",
+              body: parsed,
+              model: Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown],
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Telnyx::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/ai/openai.rb

@@ -9,12 +9,38 @@ module Telnyx
         # @return [Telnyx::Resources::AI::OpenAI::Embeddings]
         attr_reader :embeddings
 
+        # @return [Telnyx::Resources::AI::OpenAI::Chat]
+        attr_reader :chat
+
+        # This endpoint returns a list of Open Source and OpenAI models that are available
+        # for use. <br /><br /> **Note**: Model `id`'s will be in the form
+        # `{source}/{model_name}`. For example `openai/gpt-4` or
+        # `mistralai/Mistral-7B-Instruct-v0.1` consistent with HuggingFace naming
+        # conventions.
+        #
+        # @overload list_models(request_options: {})
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::AI::OpenAIListModelsResponse]
+        #
+        # @see Telnyx::Models::AI::OpenAIListModelsParams
+        def list_models(params = {})
+          @client.request(
+            method: :get,
+            path: "ai/openai/models",
+            model: Telnyx::Models::AI::OpenAIListModelsResponse,
+            options: params[:request_options]
+          )
+        end
+
         # @api private
         #
         # @param client [Telnyx::Client]
         def initialize(client:)
           @client = client
           @embeddings = Telnyx::Resources::AI::OpenAI::Embeddings.new(client: client)
+          @chat = Telnyx::Resources::AI::OpenAI::Chat.new(client: client)
         end
       end
     end

data/lib/telnyx/resources/ai.rb

@@ -46,11 +46,13 @@ module Telnyx
       # @return [Telnyx::Resources::AI::Tools]
       attr_reader :tools
 
-      # This endpoint returns a list of Open Source and OpenAI models that are available
-      # for use. <br /><br /> **Note**: Model `id`'s will be in the form
-      # `{source}/{model_name}`. For example `openai/gpt-4` or
-      # `mistralai/Mistral-7B-Instruct-v0.1` consistent with HuggingFace naming
-      # conventions.
+      # @deprecated
+      #
+      # **Deprecated**: Use `GET /v2/ai/openai/models` instead. This endpoint returns a
+      # list of Open Source and OpenAI models that are available for use. <br /><br />
+      # **Note**: Model `id`'s will be in the form `{source}/{model_name}`. For example
+      # `openai/gpt-4` or `mistralai/Mistral-7B-Instruct-v0.1` consistent with
+      # HuggingFace naming conventions.
       #
       # @overload retrieve_models(request_options: {})
       #

data/lib/telnyx/resources/messaging_10dlc/brand/external_vetting.rb

@@ -60,7 +60,11 @@ module Telnyx
             )
           end
 
-          # Order new external vetting for a brand
+          # Order new external vetting for a brand.
+          #
+          # Duplicate orders for the same `evpId` and `vettingClass` return `400` with code
+          # `10012` if a successful vetting exists within the last 180 days, or one is
+          # currently being processed. Failed vettings can be retried immediately.
           #
           # @overload order(brand_id, evp_id:, vetting_class:, request_options: {})
           #

data/lib/telnyx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Telnyx
-  VERSION = "5.100.0"
+  VERSION = "5.102.0"
 end

data/lib/telnyx.rb

@@ -370,10 +370,14 @@ require_relative "telnyx/models/ai/mission_update_mission_params"
 require_relative "telnyx/models/ai/mission_update_mission_response"
 require_relative "telnyx/models/ai/observability"
 require_relative "telnyx/models/ai/observability_req"
+require_relative "telnyx/models/ai/openai/chat_create_completion_params"
+require_relative "telnyx/models/ai/openai/chat_create_completion_response"
 require_relative "telnyx/models/ai/openai/embedding_create_embeddings_params"
 require_relative "telnyx/models/ai/openai/embedding_create_embeddings_response"
 require_relative "telnyx/models/ai/openai/embedding_list_embedding_models_params"
 require_relative "telnyx/models/ai/openai/embedding_list_embedding_models_response"
+require_relative "telnyx/models/ai/openai_list_models_params"
+require_relative "telnyx/models/ai/openai_list_models_response"
 require_relative "telnyx/models/ai/post_conversation_settings"
 require_relative "telnyx/models/ai/post_conversation_settings_req"
 require_relative "telnyx/models/ai/privacy_settings"
@@ -2449,6 +2453,7 @@ require_relative "telnyx/resources/ai/missions/runs/plan"
 require_relative "telnyx/resources/ai/missions/runs/telnyx_agents"
 require_relative "telnyx/resources/ai/missions/tools"
 require_relative "telnyx/resources/ai/openai"
+require_relative "telnyx/resources/ai/openai/chat"
 require_relative "telnyx/resources/ai/openai/embeddings"
 require_relative "telnyx/resources/ai/tools"
 require_relative "telnyx/resources/alphanumeric_sender_ids"

data/rbi/telnyx/models/ai/chat_create_completion_params.rbi

@@ -156,6 +156,31 @@ module Telnyx
         end
         attr_writer :response_format
 
+        # If specified, the system will make a best effort to sample deterministically,
+        # such that repeated requests with the same `seed` and parameters should return
+        # the same result.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :seed
+
+        sig { params(seed: Integer).void }
+        attr_writer :seed
+
+        # Up to 4 sequences where the API will stop generating further tokens. The
+        # returned text will not contain the stop sequence.
+        sig do
+          returns(
+            T.nilable(Telnyx::AI::ChatCreateCompletionParams::Stop::Variants)
+          )
+        end
+        attr_reader :stop
+
+        sig do
+          params(
+            stop: Telnyx::AI::ChatCreateCompletionParams::Stop::Variants
+          ).void
+        end
+        attr_writer :stop
+
         # Whether or not to stream data-only server-sent events as they become available.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :stream
@@ -268,6 +293,8 @@ module Telnyx
             presence_penalty: Float,
             response_format:
               Telnyx::AI::ChatCreateCompletionParams::ResponseFormat::OrHash,
+            seed: Integer,
+            stop: Telnyx::AI::ChatCreateCompletionParams::Stop::Variants,
             stream: T::Boolean,
             temperature: Float,
             tool_choice:
@@ -334,6 +361,13 @@ module Telnyx
           # Use this is you want to guarantee a JSON output without defining a schema. For
           # control over the schema, use `guided_json`.
           response_format: nil,
+          # If specified, the system will make a best effort to sample deterministically,
+          # such that repeated requests with the same `seed` and parameters should return
+          # the same result.
+          seed: nil,
+          # Up to 4 sequences where the API will stop generating further tokens. The
+          # returned text will not contain the stop sequence.
+          stop: nil,
           # Whether or not to stream data-only server-sent events as they become available.
           stream: nil,
           # Adjusts the "creativity" of the model. Lower values make the model more
@@ -384,6 +418,8 @@ module Telnyx
               presence_penalty: Float,
               response_format:
                 Telnyx::AI::ChatCreateCompletionParams::ResponseFormat,
+              seed: Integer,
+              stop: Telnyx::AI::ChatCreateCompletionParams::Stop::Variants,
               stream: T::Boolean,
               temperature: Float,
               tool_choice:
@@ -689,6 +725,28 @@ module Telnyx
           end
         end
 
+        # Up to 4 sequences where the API will stop generating further tokens. The
+        # returned text will not contain the stop sequence.
+        module Stop
+          extend Telnyx::Internal::Type::Union
+
+          Variants = T.type_alias { T.any(String, T::Array[String]) }
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::AI::ChatCreateCompletionParams::Stop::Variants]
+            )
+          end
+          def self.variants
+          end
+
+          StringArray =
+            T.let(
+              Telnyx::Internal::Type::ArrayOf[String],
+              Telnyx::Internal::Type::Converter
+            )
+        end
+
         module ToolChoice
           extend Telnyx::Internal::Type::Enum