telnyx 5.109.0 → 5.110.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0635664beaf5954a5a6aee1fc3c90c1531aea5009a3165877d85f3012cbd68d4
-  data.tar.gz: 1814d374ea0f75de957b6e0b57717439184007bfc94c5281fbb424f3239b7d1a
+  metadata.gz: cd41e8d04d8ad1117446ad9873c0d1b5d31f2e21a3b0ea372fa8613e27279071
+  data.tar.gz: 7d5c22cc65293f1dc3e9d3475010077a35ffe06665bed71712ed6e1175b67035
 SHA512:
-  metadata.gz: 4a0adea08fee9b62f04de0b1bb2e193b1a82af840af6774f689008983972a477ba421f440213d843f0c166e5ad46ddfa1bdd38995d6d39322a2f0b63a90ed6e0
-  data.tar.gz: c0c7f970f7e64a7384891a14b91fd2ff8e9a8044b424e20354e2211a63cdb74e6bb7723bd3846227d9d2d65c50899d4485c0943688de7c75f44b6869804ecc52
+  metadata.gz: cf38dc0775b7725483a70461e39a35592497109ca2d5bdc963993d706a2cefea674f651dd4d7e7149670435a93f34ee9506b694164b589cebefff5df5851a320
+  data.tar.gz: 496d527a14db94b9cea4ccb0134a82909e88d9770abfb54f0bb3570da7c17b05c264b045ed4020085c41ca3da21882065c18dba91465dca4443411d87345ba6f

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 5.110.0 (2026-05-11)
+
+Full Changelog: [v5.109.0...v5.110.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.109.0...v5.110.0)
+
+### Features
+
+* Document OpenAI responses conversation flow ([6f06f24](https://github.com/team-telnyx/telnyx-ruby/commit/6f06f243b406719fcf17b1b3339b6f74b54854fb))
+
 ## 5.109.0 (2026-05-11)
 
 Full Changelog: [v5.108.0...v5.109.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.108.0...v5.109.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.109.0"
+gem "telnyx", "~> 5.110.0"
 ```
 
 <!-- x-release-please-end -->

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

@@ -8,13 +8,57 @@ module Telnyx
         extend Telnyx::Internal::Type::RequestParameters::Converter
         include Telnyx::Internal::Type::RequestParameters
 
-        # @!attribute body
+        # @!attribute conversation
+        #   Optional Telnyx Conversation ID from `POST /ai/conversations`. When provided,
+        #   Telnyx stores this turn on that conversation and uses the conversation's prior
+        #   messages as context. Reuse the same ID for subsequent turns and tool-result
+        #   followups. Omit it for a non-persisted, stateless response.
         #
-        #   @return [Hash{Symbol=>Object}]
-        required :body, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+        #   @return [String, nil]
+        optional :conversation, String
 
-        # @!method initialize(body:, request_options: {})
-        #   @param body [Hash{Symbol=>Object}]
+        # @!attribute input
+        #   The input items for this turn, using the OpenAI Responses API input format.
+        #
+        #   @return [Object, nil]
+        optional :input, Telnyx::Internal::Type::Unknown
+
+        # @!attribute instructions
+        #   Optional system/developer instructions for the model. When used with a persisted
+        #   `conversation`, send these on the first request that creates the thread;
+        #   subsequent turns can rely on the stored history.
+        #
+        #   @return [String, nil]
+        optional :instructions, String
+
+        # @!attribute model
+        #   Model identifier to use for the response, for example `zai-org/GLM-5.1-FP8` or
+        #   another model available from the Telnyx OpenAI-compatible models endpoint.
+        #
+        #   @return [String, nil]
+        optional :model, String
+
+        # @!attribute stream
+        #   Set to `true` to stream Server-Sent Events, matching OpenAI's Responses
+        #   streaming format.
+        #
+        #   @return [Boolean, nil]
+        optional :stream, Telnyx::Internal::Type::Boolean
+
+        # @!method initialize(conversation: nil, input: nil, instructions: nil, model: nil, stream: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AI::OpenAICreateResponseParams} for more details.
+        #
+        #   @param conversation [String] Optional Telnyx Conversation ID from `POST /ai/conversations`. When provided, Te
+        #
+        #   @param input [Object] The input items for this turn, using the OpenAI Responses API input format.
+        #
+        #   @param instructions [String] Optional system/developer instructions for the model. When used with a persisted
+        #
+        #   @param model [String] Model identifier to use for the response, for example `zai-org/GLM-5.1-FP8` or a
+        #
+        #   @param stream [Boolean] Set to `true` to stream Server-Sent Events, matching OpenAI's Responses streamin
+        #
         #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
       end
     end

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

@@ -12,26 +12,60 @@ module Telnyx
         # @return [Telnyx::Resources::AI::OpenAI::Chat]
         attr_reader :chat
 
-        # Chat with a language model. This endpoint is consistent with the
-        # [OpenAI Responses API](https://platform.openai.com/docs/api-reference/responses)
-        # and may be used with the OpenAI JS or Python SDK. Response id parameter is not
-        # supported at the moment. Use 'conversation' parameter to leverage persistent
-        # conversations feature.
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::AI::OpenAICreateResponseParams} for more details.
         #
-        # @overload create_response(body:, request_options: {})
+        # Create a response using Telnyx's OpenAI-compatible Responses API. This endpoint
+        # is compatible with the
+        # [OpenAI Responses API](https://developers.openai.com/api/reference/responses/overview)
+        # and may be used with the OpenAI JS or Python SDK by setting the base URL to
+        # `https://api.telnyx.com/v2/ai/openai`.
+        #
+        # The `conversation` parameter refers to a Telnyx Conversation rather than an
+        # OpenAI-hosted conversation object. To persist a thread across turns, first
+        # [create a conversation](https://developers.telnyx.com/api-reference/conversations/create-a-conversation)
+        # with `POST /ai/conversations`, then pass that conversation's `id` in the
+        # Responses request as `conversation`. The endpoint appends the new input,
+        # assistant output, reasoning, and tool-call messages to that conversation. Reuse
+        # the same `conversation` id on subsequent Responses requests, including
+        # tool-result followups, so the model receives the prior context.
+        #
+        # If `conversation` is omitted, the request is processed without persisting
+        # messages to a Telnyx conversation. Use the Conversations API to manage history:
+        # [list conversations](https://developers.telnyx.com/api-reference/conversations/list-conversations)
+        # (optionally filtered by metadata),
+        # [fetch messages](https://developers.telnyx.com/api-reference/conversations/get-conversation-messages)
+        # for a conversation, and optionally
+        # [add messages](https://developers.telnyx.com/api-reference/conversations/create-message)
+        # outside the Responses flow.
+        #
+        # You can attach arbitrary metadata when creating a conversation (for example to
+        # tag the conversation's source, channel, or user) and later filter by it when
+        # listing conversations.
+        #
+        # @overload create_response(conversation: nil, input: nil, instructions: nil, model: nil, stream: nil, request_options: {})
+        #
+        # @param conversation [String] Optional Telnyx Conversation ID from `POST /ai/conversations`. When provided, Te
+        #
+        # @param input [Object] The input items for this turn, using the OpenAI Responses API input format.
+        #
+        # @param instructions [String] Optional system/developer instructions for the model. When used with a persisted
+        #
+        # @param model [String] Model identifier to use for the response, for example `zai-org/GLM-5.1-FP8` or a
+        #
+        # @param stream [Boolean] Set to `true` to stream Server-Sent Events, matching OpenAI's Responses streamin
         #
-        # @param body [Hash{Symbol=>Object}]
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Hash{Symbol=>Object}]
         #
         # @see Telnyx::Models::AI::OpenAICreateResponseParams
-        def create_response(params)
+        def create_response(params = {})
           parsed, options = Telnyx::AI::OpenAICreateResponseParams.dump_request(params)
           @client.request(
             method: :post,
             path: "ai/openai/responses",
-            body: parsed[:body],
+            body: parsed,
             model: Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown],
             options: options
           )

data/lib/telnyx/resources/ai.rb

@@ -48,12 +48,12 @@ module Telnyx
 
       # @deprecated
       #
-      # **Deprecated**: Use `POST /v2/ai/openai/responses` instead. Chat with a language
-      # model. This endpoint is consistent with the
-      # [OpenAI Responses API](https://platform.openai.com/docs/api-reference/responses)
+      # **Deprecated**: Use `POST /v2/ai/openai/responses` instead. This endpoint is
+      # compatible with the
+      # [OpenAI Responses API](https://developers.openai.com/api/reference/responses/overview)
       # and may be used with the OpenAI JS or Python SDK. Response id parameter is not
-      # supported at the moment. Use 'conversation' parameter to leverage persistent
-      # conversations feature.
+      # supported at the moment. Use the `conversation` parameter with a Telnyx
+      # Conversation ID to leverage persistent conversations.
       #
       # @overload create_response(body:, request_options: {})
       #

data/lib/telnyx/version.rb

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

data/rbi/telnyx/models/ai/openai_create_response_params.rbi

@@ -15,22 +15,88 @@ module Telnyx
             )
           end
 
-        sig { returns(T::Hash[Symbol, T.anything]) }
-        attr_accessor :body
+        # Optional Telnyx Conversation ID from `POST /ai/conversations`. When provided,
+        # Telnyx stores this turn on that conversation and uses the conversation's prior
+        # messages as context. Reuse the same ID for subsequent turns and tool-result
+        # followups. Omit it for a non-persisted, stateless response.
+        sig { returns(T.nilable(String)) }
+        attr_reader :conversation
+
+        sig { params(conversation: String).void }
+        attr_writer :conversation
+
+        # The input items for this turn, using the OpenAI Responses API input format.
+        sig { returns(T.nilable(T.anything)) }
+        attr_reader :input
+
+        sig { params(input: T.anything).void }
+        attr_writer :input
+
+        # Optional system/developer instructions for the model. When used with a persisted
+        # `conversation`, send these on the first request that creates the thread;
+        # subsequent turns can rely on the stored history.
+        sig { returns(T.nilable(String)) }
+        attr_reader :instructions
+
+        sig { params(instructions: String).void }
+        attr_writer :instructions
+
+        # Model identifier to use for the response, for example `zai-org/GLM-5.1-FP8` or
+        # another model available from the Telnyx OpenAI-compatible models endpoint.
+        sig { returns(T.nilable(String)) }
+        attr_reader :model
+
+        sig { params(model: String).void }
+        attr_writer :model
+
+        # Set to `true` to stream Server-Sent Events, matching OpenAI's Responses
+        # streaming format.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :stream
+
+        sig { params(stream: T::Boolean).void }
+        attr_writer :stream
 
         sig do
           params(
-            body: T::Hash[Symbol, T.anything],
+            conversation: String,
+            input: T.anything,
+            instructions: String,
+            model: String,
+            stream: T::Boolean,
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(body:, request_options: {})
+        def self.new(
+          # Optional Telnyx Conversation ID from `POST /ai/conversations`. When provided,
+          # Telnyx stores this turn on that conversation and uses the conversation's prior
+          # messages as context. Reuse the same ID for subsequent turns and tool-result
+          # followups. Omit it for a non-persisted, stateless response.
+          conversation: nil,
+          # The input items for this turn, using the OpenAI Responses API input format.
+          input: nil,
+          # Optional system/developer instructions for the model. When used with a persisted
+          # `conversation`, send these on the first request that creates the thread;
+          # subsequent turns can rely on the stored history.
+          instructions: nil,
+          # Model identifier to use for the response, for example `zai-org/GLM-5.1-FP8` or
+          # another model available from the Telnyx OpenAI-compatible models endpoint.
+          model: nil,
+          # Set to `true` to stream Server-Sent Events, matching OpenAI's Responses
+          # streaming format.
+          stream: nil,
+          request_options: {}
+        )
         end
 
         sig do
           override.returns(
             {
-              body: T::Hash[Symbol, T.anything],
+              conversation: String,
+              input: T.anything,
+              instructions: String,
+              model: String,
+              stream: T::Boolean,
               request_options: Telnyx::RequestOptions
             }
           )

data/rbi/telnyx/resources/ai/openai.rbi

@@ -12,18 +12,63 @@ module Telnyx
         sig { returns(Telnyx::Resources::AI::OpenAI::Chat) }
         attr_reader :chat
 
-        # Chat with a language model. This endpoint is consistent with the
-        # [OpenAI Responses API](https://platform.openai.com/docs/api-reference/responses)
-        # and may be used with the OpenAI JS or Python SDK. Response id parameter is not
-        # supported at the moment. Use 'conversation' parameter to leverage persistent
-        # conversations feature.
+        # Create a response using Telnyx's OpenAI-compatible Responses API. This endpoint
+        # is compatible with the
+        # [OpenAI Responses API](https://developers.openai.com/api/reference/responses/overview)
+        # and may be used with the OpenAI JS or Python SDK by setting the base URL to
+        # `https://api.telnyx.com/v2/ai/openai`.
+        #
+        # The `conversation` parameter refers to a Telnyx Conversation rather than an
+        # OpenAI-hosted conversation object. To persist a thread across turns, first
+        # [create a conversation](https://developers.telnyx.com/api-reference/conversations/create-a-conversation)
+        # with `POST /ai/conversations`, then pass that conversation's `id` in the
+        # Responses request as `conversation`. The endpoint appends the new input,
+        # assistant output, reasoning, and tool-call messages to that conversation. Reuse
+        # the same `conversation` id on subsequent Responses requests, including
+        # tool-result followups, so the model receives the prior context.
+        #
+        # If `conversation` is omitted, the request is processed without persisting
+        # messages to a Telnyx conversation. Use the Conversations API to manage history:
+        # [list conversations](https://developers.telnyx.com/api-reference/conversations/list-conversations)
+        # (optionally filtered by metadata),
+        # [fetch messages](https://developers.telnyx.com/api-reference/conversations/get-conversation-messages)
+        # for a conversation, and optionally
+        # [add messages](https://developers.telnyx.com/api-reference/conversations/create-message)
+        # outside the Responses flow.
+        #
+        # You can attach arbitrary metadata when creating a conversation (for example to
+        # tag the conversation's source, channel, or user) and later filter by it when
+        # listing conversations.
         sig do
           params(
-            body: T::Hash[Symbol, T.anything],
+            conversation: String,
+            input: T.anything,
+            instructions: String,
+            model: String,
+            stream: T::Boolean,
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(T::Hash[Symbol, T.anything])
         end
-        def create_response(body:, request_options: {})
+        def create_response(
+          # Optional Telnyx Conversation ID from `POST /ai/conversations`. When provided,
+          # Telnyx stores this turn on that conversation and uses the conversation's prior
+          # messages as context. Reuse the same ID for subsequent turns and tool-result
+          # followups. Omit it for a non-persisted, stateless response.
+          conversation: nil,
+          # The input items for this turn, using the OpenAI Responses API input format.
+          input: nil,
+          # Optional system/developer instructions for the model. When used with a persisted
+          # `conversation`, send these on the first request that creates the thread;
+          # subsequent turns can rely on the stored history.
+          instructions: nil,
+          # Model identifier to use for the response, for example `zai-org/GLM-5.1-FP8` or
+          # another model available from the Telnyx OpenAI-compatible models endpoint.
+          model: nil,
+          # Set to `true` to stream Server-Sent Events, matching OpenAI's Responses
+          # streaming format.
+          stream: nil,
+          request_options: {}
+        )
         end
 
         # Lists every model currently available to your account on Telnyx Inference,

data/rbi/telnyx/resources/ai.rbi

@@ -46,12 +46,12 @@ module Telnyx
       sig { returns(Telnyx::Resources::AI::Tools) }
       attr_reader :tools
 
-      # **Deprecated**: Use `POST /v2/ai/openai/responses` instead. Chat with a language
-      # model. This endpoint is consistent with the
-      # [OpenAI Responses API](https://platform.openai.com/docs/api-reference/responses)
+      # **Deprecated**: Use `POST /v2/ai/openai/responses` instead. This endpoint is
+      # compatible with the
+      # [OpenAI Responses API](https://developers.openai.com/api/reference/responses/overview)
       # and may be used with the OpenAI JS or Python SDK. Response id parameter is not
-      # supported at the moment. Use 'conversation' parameter to leverage persistent
-      # conversations feature.
+      # supported at the moment. Use the `conversation` parameter with a Telnyx
+      # Conversation ID to leverage persistent conversations.
       sig do
         params(
           body: T::Hash[Symbol, T.anything],

data/sig/telnyx/models/ai/openai_create_response_params.rbs

@@ -2,22 +2,54 @@ module Telnyx
   module Models
     module AI
       type openai_create_response_params =
-        { body: ::Hash[Symbol, top] }
+        {
+          conversation: String,
+          input: top,
+          instructions: String,
+          model: String,
+          stream: bool
+        }
         & Telnyx::Internal::Type::request_parameters
 
       class OpenAICreateResponseParams < Telnyx::Internal::Type::BaseModel
         extend Telnyx::Internal::Type::RequestParameters::Converter
         include Telnyx::Internal::Type::RequestParameters
 
-        attr_accessor body: ::Hash[Symbol, top]
+        attr_reader conversation: String?
+
+        def conversation=: (String) -> String
+
+        attr_reader input: top?
+
+        def input=: (top) -> top
+
+        attr_reader instructions: String?
+
+        def instructions=: (String) -> String
+
+        attr_reader model: String?
+
+        def model=: (String) -> String
+
+        attr_reader stream: bool?
+
+        def stream=: (bool) -> bool
 
         def initialize: (
-          body: ::Hash[Symbol, top],
+          ?conversation: String,
+          ?input: top,
+          ?instructions: String,
+          ?model: String,
+          ?stream: bool,
           ?request_options: Telnyx::request_opts
         ) -> void
 
         def to_hash: -> {
-          body: ::Hash[Symbol, top],
+          conversation: String,
+          input: top,
+          instructions: String,
+          model: String,
+          stream: bool,
           request_options: Telnyx::RequestOptions
         }
       end

data/sig/telnyx/resources/ai/openai.rbs

@@ -7,7 +7,11 @@ module Telnyx
         attr_reader chat: Telnyx::Resources::AI::OpenAI::Chat
 
         def create_response: (
-          body: ::Hash[Symbol, top],
+          ?conversation: String,
+          ?input: top,
+          ?instructions: String,
+          ?model: String,
+          ?stream: bool,
           ?request_options: Telnyx::request_opts
         ) -> Telnyx::Models::AI::openai_create_response_response
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: telnyx
 version: !ruby/object:Gem::Version
-  version: 5.109.0
+  version: 5.110.0
 platform: ruby
 authors:
 - Telnyx