telnyx 5.17.0 → 5.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e08a58904d144a2f079927643323f2fe4e2ee5abc8f4836f48d6976e0fbe3df
-  data.tar.gz: 2f3135e265df7138173574ccff077286dc1404a653a694639ade129ab7738777
+  metadata.gz: 6f64a193fae0f68851a1b545044ea384297a3e6852731a084bf503c8897b48d8
+  data.tar.gz: 7026c1707b3da887862b4856f4e051277d93baa7744f4ed876d83a01de1e9667
 SHA512:
-  metadata.gz: 1f6d3600b39400e54c7f532e66ec2e927db860d71bf67b22f675696f98616173df3f946cf94717af4790414c6d1dac5d3d8b5829ce425874eedf9dc4b4b0789b
-  data.tar.gz: e720904a65cf920859810d24da6e3512a84fdf9b2b6dc631415c60c81e2b8b07d5710bd61b5f5dfd1347e517b753af86c0e89046adb8e2559734a0d2f1374af3
+  metadata.gz: bffe7cb7ede65f87722e7df8fb1b9981db665d9134fec32b2790d4163072c499c02340abb3541707d54b8c151776302b1c677ac072d2356bf0705a49779f678a
+  data.tar.gz: 70a983984587aa67731ea5a505703f16332d06c1b25c9814c5fe18b821d5836584d6b19d32238efab8e22e12286d1bd86707b658f88e9ff5634f33dabca0319f

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 5.18.0 (2026-02-11)
+
+Full Changelog: [v5.17.0...v5.18.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.17.0...v5.18.0)
+
+### Features
+
+* Add OpenAI-compatible embeddings API spec ([e7aea5f](https://github.com/team-telnyx/telnyx-ruby/commit/e7aea5feb3c2277889875352e58e1e59ee9be532))
+
 ## 5.17.0 (2026-02-11)
 
 Full Changelog: [v5.16.0...v5.17.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.16.0...v5.17.0)

data/README.md

@@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "telnyx", "~> 5.17.0"
+gem "telnyx", "~> 5.18.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/telnyx/models/ai/openai/embedding_create_params.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module OpenAI
+        # @see Telnyx::Resources::AI::OpenAI::Embeddings#create
+        class EmbeddingCreateParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!attribute input
+          #   Input text to embed. Can be a string or array of strings.
+          #
+          #   @return [String, Array<String>]
+          required :input, union: -> { Telnyx::AI::OpenAI::EmbeddingCreateParams::Input }
+
+          # @!attribute model
+          #   ID of the model to use. Use the List embedding models endpoint to see available
+          #   models.
+          #
+          #   @return [String]
+          required :model, String
+
+          # @!attribute dimensions
+          #   The number of dimensions the resulting output embeddings should have. Only
+          #   supported in some models.
+          #
+          #   @return [Integer, nil]
+          optional :dimensions, Integer
+
+          # @!attribute encoding_format
+          #   The format to return the embeddings in.
+          #
+          #   @return [Symbol, Telnyx::Models::AI::OpenAI::EmbeddingCreateParams::EncodingFormat, nil]
+          optional :encoding_format, enum: -> { Telnyx::AI::OpenAI::EmbeddingCreateParams::EncodingFormat }
+
+          # @!attribute user
+          #   A unique identifier representing your end-user for monitoring and abuse
+          #   detection.
+          #
+          #   @return [String, nil]
+          optional :user, String
+
+          # @!method initialize(input:, model:, dimensions: nil, encoding_format: nil, user: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::AI::OpenAI::EmbeddingCreateParams} for more details.
+          #
+          #   @param input [String, Array<String>] Input text to embed. Can be a string or array of strings.
+          #
+          #   @param model [String] ID of the model to use. Use the List embedding models endpoint to see available
+          #
+          #   @param dimensions [Integer] The number of dimensions the resulting output embeddings should have. Only suppo
+          #
+          #   @param encoding_format [Symbol, Telnyx::Models::AI::OpenAI::EmbeddingCreateParams::EncodingFormat] The format to return the embeddings in.
+          #
+          #   @param user [String] A unique identifier representing your end-user for monitoring and abuse detectio
+          #
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+          # Input text to embed. Can be a string or array of strings.
+          module Input
+            extend Telnyx::Internal::Type::Union
+
+            # A single text string to embed
+            variant String
+
+            # An array of text strings to embed
+            variant -> { Telnyx::Models::AI::OpenAI::EmbeddingCreateParams::Input::StringArray }
+
+            # @!method self.variants
+            #   @return [Array(String, Array<String>)]
+
+            # @type [Telnyx::Internal::Type::Converter]
+            StringArray = Telnyx::Internal::Type::ArrayOf[String]
+          end
+
+          # The format to return the embeddings in.
+          module EncodingFormat
+            extend Telnyx::Internal::Type::Enum
+
+            FLOAT = :float
+            BASE64 = :base64
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/openai/embedding_create_response.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module OpenAI
+        # @see Telnyx::Resources::AI::OpenAI::Embeddings#create
+        class EmbeddingCreateResponse < Telnyx::Internal::Type::BaseModel
+          # @!attribute data
+          #   List of embedding objects
+          #
+          #   @return [Array<Telnyx::Models::AI::OpenAI::EmbeddingCreateResponse::Data>]
+          required :data,
+                   -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::AI::OpenAI::EmbeddingCreateResponse::Data] }
+
+          # @!attribute model
+          #   The model used for embedding
+          #
+          #   @return [String]
+          required :model, String
+
+          # @!attribute object
+          #   The object type, always 'list'
+          #
+          #   @return [String]
+          required :object, String
+
+          # @!attribute usage
+          #
+          #   @return [Telnyx::Models::AI::OpenAI::EmbeddingCreateResponse::Usage]
+          required :usage, -> { Telnyx::Models::AI::OpenAI::EmbeddingCreateResponse::Usage }
+
+          # @!method initialize(data:, model:, object:, usage:)
+          #   @param data [Array<Telnyx::Models::AI::OpenAI::EmbeddingCreateResponse::Data>] List of embedding objects
+          #
+          #   @param model [String] The model used for embedding
+          #
+          #   @param object [String] The object type, always 'list'
+          #
+          #   @param usage [Telnyx::Models::AI::OpenAI::EmbeddingCreateResponse::Usage]
+
+          class Data < Telnyx::Internal::Type::BaseModel
+            # @!attribute embedding
+            #   The embedding vector
+            #
+            #   @return [Array<Float>]
+            required :embedding, Telnyx::Internal::Type::ArrayOf[Float]
+
+            # @!attribute index
+            #   The index of the embedding in the list of embeddings
+            #
+            #   @return [Integer]
+            required :index, Integer
+
+            # @!attribute object
+            #   The object type, always 'embedding'
+            #
+            #   @return [String]
+            required :object, String
+
+            # @!method initialize(embedding:, index:, object:)
+            #   @param embedding [Array<Float>] The embedding vector
+            #
+            #   @param index [Integer] The index of the embedding in the list of embeddings
+            #
+            #   @param object [String] The object type, always 'embedding'
+          end
+
+          # @see Telnyx::Models::AI::OpenAI::EmbeddingCreateResponse#usage
+          class Usage < Telnyx::Internal::Type::BaseModel
+            # @!attribute prompt_tokens
+            #   Number of tokens in the input
+            #
+            #   @return [Integer]
+            required :prompt_tokens, Integer
+
+            # @!attribute total_tokens
+            #   Total number of tokens used
+            #
+            #   @return [Integer]
+            required :total_tokens, Integer
+
+            # @!method initialize(prompt_tokens:, total_tokens:)
+            #   @param prompt_tokens [Integer] Number of tokens in the input
+            #
+            #   @param total_tokens [Integer] Total number of tokens used
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/openai/embedding_list_models_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module OpenAI
+        # @see Telnyx::Resources::AI::OpenAI::Embeddings#list_models
+        class EmbeddingListModelsParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!method initialize(request_options: {})
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/openai/embedding_list_models_response.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module OpenAI
+        # @see Telnyx::Resources::AI::OpenAI::Embeddings#list_models
+        class EmbeddingListModelsResponse < Telnyx::Internal::Type::BaseModel
+          # @!attribute data
+          #   List of available embedding models
+          #
+          #   @return [Array<Telnyx::Models::AI::OpenAI::EmbeddingListModelsResponse::Data>]
+          required :data,
+                   -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::AI::OpenAI::EmbeddingListModelsResponse::Data] }
+
+          # @!attribute object
+          #   The object type, always 'list'
+          #
+          #   @return [String]
+          required :object, String
+
+          # @!method initialize(data:, object:)
+          #   @param data [Array<Telnyx::Models::AI::OpenAI::EmbeddingListModelsResponse::Data>] List of available embedding models
+          #
+          #   @param object [String] The object type, always 'list'
+
+          class Data < Telnyx::Internal::Type::BaseModel
+            # @!attribute id
+            #   The model identifier
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute created
+            #   Unix timestamp of when the model was created
+            #
+            #   @return [Integer]
+            required :created, Integer
+
+            # @!attribute object
+            #   The object type, always 'model'
+            #
+            #   @return [String]
+            required :object, String
+
+            # @!attribute owned_by
+            #   The organization that owns the model
+            #
+            #   @return [String]
+            required :owned_by, String
+
+            # @!method initialize(id:, created:, object:, owned_by:)
+            #   @param id [String] The model identifier
+            #
+            #   @param created [Integer] Unix timestamp of when the model was created
+            #
+            #   @param object [String] The object type, always 'model'
+            #
+            #   @param owned_by [String] The organization that owns the model
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class AI
+      class OpenAI
+        class Embeddings
+          # Some parameter documentations has been truncated, see
+          # {Telnyx::Models::AI::OpenAI::EmbeddingCreateParams} for more details.
+          #
+          # Creates an embedding vector representing the input text. This endpoint is
+          # compatible with the
+          # [OpenAI Embeddings API](https://platform.openai.com/docs/api-reference/embeddings)
+          # 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(input:, model:, dimensions: nil, encoding_format: nil, user: nil, request_options: {})
+          #
+          # @param input [String, Array<String>] Input text to embed. Can be a string or array of strings.
+          #
+          # @param model [String] ID of the model to use. Use the List embedding models endpoint to see available
+          #
+          # @param dimensions [Integer] The number of dimensions the resulting output embeddings should have. Only suppo
+          #
+          # @param encoding_format [Symbol, Telnyx::Models::AI::OpenAI::EmbeddingCreateParams::EncodingFormat] The format to return the embeddings in.
+          #
+          # @param user [String] A unique identifier representing your end-user for monitoring and abuse detectio
+          #
+          # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Telnyx::Models::AI::OpenAI::EmbeddingCreateResponse]
+          #
+          # @see Telnyx::Models::AI::OpenAI::EmbeddingCreateParams
+          def create(params)
+            parsed, options = Telnyx::AI::OpenAI::EmbeddingCreateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "ai/openai/embeddings",
+              body: parsed,
+              model: Telnyx::Models::AI::OpenAI::EmbeddingCreateResponse,
+              options: options
+            )
+          end
+
+          # Returns a list of available embedding models. This endpoint is compatible with
+          # the OpenAI Models API format.
+          #
+          # @overload list_models(request_options: {})
+          #
+          # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Telnyx::Models::AI::OpenAI::EmbeddingListModelsResponse]
+          #
+          # @see Telnyx::Models::AI::OpenAI::EmbeddingListModelsParams
+          def list_models(params = {})
+            @client.request(
+              method: :get,
+              path: "ai/openai/embeddings/models",
+              model: Telnyx::Models::AI::OpenAI::EmbeddingListModelsResponse,
+              options: params[:request_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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class AI
+      class OpenAI
+        # @return [Telnyx::Resources::AI::OpenAI::Embeddings]
+        attr_reader :embeddings
+
+        # @api private
+        #
+        # @param client [Telnyx::Client]
+        def initialize(client:)
+          @client = client
+          @embeddings = Telnyx::Resources::AI::OpenAI::Embeddings.new(client: client)
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/ai.rb

@@ -30,6 +30,9 @@ module Telnyx
       # @return [Telnyx::Resources::AI::McpServers]
       attr_reader :mcp_servers
 
+      # @return [Telnyx::Resources::AI::OpenAI]
+      attr_reader :openai
+
       # 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
@@ -102,6 +105,7 @@ module Telnyx
         @fine_tuning = Telnyx::Resources::AI::FineTuning.new(client: client)
         @integrations = Telnyx::Resources::AI::Integrations.new(client: client)
         @mcp_servers = Telnyx::Resources::AI::McpServers.new(client: client)
+        @openai = Telnyx::Resources::AI::OpenAI.new(client: client)
       end
     end
   end

data/lib/telnyx/version.rb

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

data/lib/telnyx.rb

@@ -274,6 +274,10 @@ require_relative "telnyx/models/ai/mcp_server_retrieve_response"
 require_relative "telnyx/models/ai/mcp_server_update_params"
 require_relative "telnyx/models/ai/mcp_server_update_response"
 require_relative "telnyx/models/ai/messaging_settings"
+require_relative "telnyx/models/ai/openai/embedding_create_params"
+require_relative "telnyx/models/ai/openai/embedding_create_response"
+require_relative "telnyx/models/ai/openai/embedding_list_models_params"
+require_relative "telnyx/models/ai/openai/embedding_list_models_response"
 require_relative "telnyx/models/ai/privacy_settings"
 require_relative "telnyx/models/ai/recursive_cluster"
 require_relative "telnyx/models/ai/retrieval_tool"
@@ -2059,6 +2063,8 @@ require_relative "telnyx/resources/ai/fine_tuning/jobs"
 require_relative "telnyx/resources/ai/integrations"
 require_relative "telnyx/resources/ai/integrations/connections"
 require_relative "telnyx/resources/ai/mcp_servers"
+require_relative "telnyx/resources/ai/openai"
+require_relative "telnyx/resources/ai/openai/embeddings"
 require_relative "telnyx/resources/audit_events"
 require_relative "telnyx/resources/authentication_providers"
 require_relative "telnyx/resources/available_phone_number_blocks"

data/rbi/telnyx/models/ai/openai/embedding_create_params.rbi

@@ -0,0 +1,171 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module OpenAI
+        class EmbeddingCreateParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::AI::OpenAI::EmbeddingCreateParams,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Input text to embed. Can be a string or array of strings.
+          sig do
+            returns(Telnyx::AI::OpenAI::EmbeddingCreateParams::Input::Variants)
+          end
+          attr_accessor :input
+
+          # ID of the model to use. Use the List embedding models endpoint to see available
+          # models.
+          sig { returns(String) }
+          attr_accessor :model
+
+          # The number of dimensions the resulting output embeddings should have. Only
+          # supported in some models.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :dimensions
+
+          sig { params(dimensions: Integer).void }
+          attr_writer :dimensions
+
+          # The format to return the embeddings in.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::AI::OpenAI::EmbeddingCreateParams::EncodingFormat::OrSymbol
+              )
+            )
+          end
+          attr_reader :encoding_format
+
+          sig do
+            params(
+              encoding_format:
+                Telnyx::AI::OpenAI::EmbeddingCreateParams::EncodingFormat::OrSymbol
+            ).void
+          end
+          attr_writer :encoding_format
+
+          # A unique identifier representing your end-user for monitoring and abuse
+          # detection.
+          sig { returns(T.nilable(String)) }
+          attr_reader :user
+
+          sig { params(user: String).void }
+          attr_writer :user
+
+          sig do
+            params(
+              input: Telnyx::AI::OpenAI::EmbeddingCreateParams::Input::Variants,
+              model: String,
+              dimensions: Integer,
+              encoding_format:
+                Telnyx::AI::OpenAI::EmbeddingCreateParams::EncodingFormat::OrSymbol,
+              user: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Input text to embed. Can be a string or array of strings.
+            input:,
+            # ID of the model to use. Use the List embedding models endpoint to see available
+            # models.
+            model:,
+            # The number of dimensions the resulting output embeddings should have. Only
+            # supported in some models.
+            dimensions: nil,
+            # The format to return the embeddings in.
+            encoding_format: nil,
+            # A unique identifier representing your end-user for monitoring and abuse
+            # detection.
+            user: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                input:
+                  Telnyx::AI::OpenAI::EmbeddingCreateParams::Input::Variants,
+                model: String,
+                dimensions: Integer,
+                encoding_format:
+                  Telnyx::AI::OpenAI::EmbeddingCreateParams::EncodingFormat::OrSymbol,
+                user: String,
+                request_options: Telnyx::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Input text to embed. Can be a string or array of strings.
+          module Input
+            extend Telnyx::Internal::Type::Union
+
+            Variants = T.type_alias { T.any(String, T::Array[String]) }
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::AI::OpenAI::EmbeddingCreateParams::Input::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+
+            StringArray =
+              T.let(
+                Telnyx::Internal::Type::ArrayOf[String],
+                Telnyx::Internal::Type::Converter
+              )
+          end
+
+          # The format to return the embeddings in.
+          module EncodingFormat
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::AI::OpenAI::EmbeddingCreateParams::EncodingFormat
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            FLOAT =
+              T.let(
+                :float,
+                Telnyx::AI::OpenAI::EmbeddingCreateParams::EncodingFormat::TaggedSymbol
+              )
+            BASE64 =
+              T.let(
+                :base64,
+                Telnyx::AI::OpenAI::EmbeddingCreateParams::EncodingFormat::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::AI::OpenAI::EmbeddingCreateParams::EncodingFormat::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end