telnyx 5.127.0 → 5.128.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1ea8e5f0025fa1bed93aff26966ede1f904b29d60f7129ab45c5da31e940a30
-  data.tar.gz: 2e55973cf269d3cbf3a0fd0bb759ebc37afb9e0b6fceba582127da8604ae51ea
+  metadata.gz: de5c23fe7fe804e74d3c3162bfa71160c7e9d926da8b49946f583fe0714d32ed
+  data.tar.gz: 8ed2365501197fcca7af44f61273475cf952b0294e3fa5e40bdb285bd13be001
 SHA512:
-  metadata.gz: 82c4d6fd7a0d79f3c98205932067d2ca0a4b498634daed7f7a1b4ba1de4c974f43a9be2b2010edc6cf3bef8ccf6d7cf6da07f6f7db0740c4e33ec0f6d953713b
-  data.tar.gz: 7ba21797f695d19c2126b50d00ea1b25493c8f01687053bbd8b197220187bcfae35af511c3140a61ad11822a95e7710e9afe40bd6c6834b9ca86ba5aaa6e201a
+  metadata.gz: 786a447fda785006672c675d62b67b1a5e55aa6946d4f825a8c3f4927517448619065c05b0be3bbee56df543f54849a1c58451cf6f69b63a0a661e3ad7dbff93
+  data.tar.gz: dd3351dac15a6ba5f81d399685e087a77c5b165fa70cde6aab6d6d984b0fc7c37a0c65fd18f4d5f3bce4b3dfed98d241a69d8b2916a9cd9ae7e67df61e8c0089

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 5.128.0 (2026-06-15)
+
+Full Changelog: [v5.127.0...v5.128.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.127.0...v5.128.0)
+
+### Features
+
+* Document POST /ai/assistants/{assistant_id}/instructions/enhance ([f07ac06](https://github.com/team-telnyx/telnyx-ruby/commit/f07ac069ef9d4690e5d5ac74e7ce4a61fa238957))
+
 ## 5.127.0 (2026-06-11)
 
 Full Changelog: [v5.126.0...v5.127.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.126.0...v5.127.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.127.0"
+gem "telnyx", "~> 5.128.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/telnyx/models/ai/assistants/instruction_enhance_params.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Assistants
+        # @see Telnyx::Resources::AI::Assistants::Instructions#enhance
+        class InstructionEnhanceParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!attribute assistant_id
+          #
+          #   @return [String]
+          required :assistant_id, String
+
+          # @!attribute enhancement_prompt
+          #   Optional guidance describing how the instructions should be enhanced. When
+          #   provided, the LLM applies these requested changes in addition to fixing any
+          #   identified issues.
+          #
+          #   @return [String, nil]
+          optional :enhancement_prompt, String, nil?: true
+
+          # @!attribute instructions
+          #   The instructions to enhance. When omitted, the assistant's existing instructions
+          #   are used.
+          #
+          #   @return [String, nil]
+          optional :instructions, String, nil?: true
+
+          # @!method initialize(assistant_id:, enhancement_prompt: nil, instructions: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::AI::Assistants::InstructionEnhanceParams} for more details.
+          #
+          #   @param assistant_id [String]
+          #
+          #   @param enhancement_prompt [String, nil] Optional guidance describing how the instructions should be enhanced. When provi
+          #
+          #   @param instructions [String, nil] The instructions to enhance. When omitted, the assistant's existing instructions
+          #
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/assistants/instruction_enhance_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Assistants
+        InstructionEnhanceResponse = String
+      end
+    end
+  end
+end

data/lib/telnyx/resources/ai/assistants/instructions.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class AI
+      class Assistants
+        # Configure AI assistant specifications
+        class Instructions
+          # Some parameter documentations has been truncated, see
+          # {Telnyx::Models::AI::Assistants::InstructionEnhanceParams} for more details.
+          #
+          # Enhance an assistant's instructions using an LLM. The endpoint reads the
+          # assistant's current instructions and tools, then streams back improved
+          # instructions as they are generated.
+          #
+          # Optionally provide an `enhancement_prompt` to steer the changes (for example,
+          # "make the instructions more concise" or "add error handling guidance"). When
+          # omitted, the assistant's existing instructions are used as the basis for the
+          # enhancement.
+          #
+          # The enhancement focuses on tool-calling reliability, clarity and precision,
+          # completeness and error handling, tool schema alignment, and conversation flow
+          # structure.
+          #
+          # The response is streamed as `text/plain` using chunked transfer encoding;
+          # consume the body incrementally to render the enhanced instructions as they
+          # arrive.
+          #
+          # @overload enhance(assistant_id, enhancement_prompt: nil, instructions: nil, request_options: {})
+          #
+          # @param assistant_id [String] Unique identifier of the assistant.
+          #
+          # @param enhancement_prompt [String, nil] Optional guidance describing how the instructions should be enhanced. When provi
+          #
+          # @param instructions [String, nil] The instructions to enhance. When omitted, the assistant's existing instructions
+          #
+          # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [String]
+          #
+          # @see Telnyx::Models::AI::Assistants::InstructionEnhanceParams
+          def enhance(assistant_id, params = {})
+            parsed, options = Telnyx::AI::Assistants::InstructionEnhanceParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: ["ai/assistants/%1$s/instructions/enhance", assistant_id],
+              headers: {"accept" => "text/plain"},
+              body: parsed,
+              model: String,
+              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/assistants.rb

@@ -29,6 +29,10 @@ module Telnyx
         # @return [Telnyx::Resources::AI::Assistants::Tags]
         attr_reader :tags
 
+        # Configure AI assistant specifications
+        # @return [Telnyx::Resources::AI::Assistants::Instructions]
+        attr_reader :instructions
+
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::AI::AssistantCreateParams} for more details.
         #
@@ -421,6 +425,7 @@ module Telnyx
           @tools = Telnyx::Resources::AI::Assistants::Tools.new(client: client)
           @versions = Telnyx::Resources::AI::Assistants::Versions.new(client: client)
           @tags = Telnyx::Resources::AI::Assistants::Tags.new(client: client)
+          @instructions = Telnyx::Resources::AI::Assistants::Instructions.new(client: client)
         end
       end
     end

data/lib/telnyx/version.rb

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

data/lib/telnyx.rb

@@ -146,6 +146,8 @@ require_relative "telnyx/models/ai/assistants/canary_deploy_retrieve_params"
 require_relative "telnyx/models/ai/assistants/canary_deploy_update_params"
 require_relative "telnyx/models/ai/assistants/conversation_channel_type"
 require_relative "telnyx/models/ai/assistants/event_status"
+require_relative "telnyx/models/ai/assistants/instruction_enhance_params"
+require_relative "telnyx/models/ai/assistants/instruction_enhance_response"
 require_relative "telnyx/models/ai/assistants/scheduled_event_create_params"
 require_relative "telnyx/models/ai/assistants/scheduled_event_delete_params"
 require_relative "telnyx/models/ai/assistants/scheduled_event_list_params"
@@ -2501,6 +2503,7 @@ require_relative "telnyx/resources/advanced_orders"
 require_relative "telnyx/resources/ai"
 require_relative "telnyx/resources/ai/assistants"
 require_relative "telnyx/resources/ai/assistants/canary_deploys"
+require_relative "telnyx/resources/ai/assistants/instructions"
 require_relative "telnyx/resources/ai/assistants/scheduled_events"
 require_relative "telnyx/resources/ai/assistants/tags"
 require_relative "telnyx/resources/ai/assistants/tests"

data/rbi/telnyx/models/ai/assistants/instruction_enhance_params.rbi

@@ -0,0 +1,70 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Assistants
+        class InstructionEnhanceParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::AI::Assistants::InstructionEnhanceParams,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :assistant_id
+
+          # Optional guidance describing how the instructions should be enhanced. When
+          # provided, the LLM applies these requested changes in addition to fixing any
+          # identified issues.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :enhancement_prompt
+
+          # The instructions to enhance. When omitted, the assistant's existing instructions
+          # are used.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :instructions
+
+          sig do
+            params(
+              assistant_id: String,
+              enhancement_prompt: T.nilable(String),
+              instructions: T.nilable(String),
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            assistant_id:,
+            # Optional guidance describing how the instructions should be enhanced. When
+            # provided, the LLM applies these requested changes in addition to fixing any
+            # identified issues.
+            enhancement_prompt: nil,
+            # The instructions to enhance. When omitted, the assistant's existing instructions
+            # are used.
+            instructions: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                assistant_id: String,
+                enhancement_prompt: T.nilable(String),
+                instructions: T.nilable(String),
+                request_options: Telnyx::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/assistants/instruction_enhance_response.rbi

@@ -0,0 +1,11 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Assistants
+        InstructionEnhanceResponse = String
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/ai/assistants/instructions.rbi

@@ -0,0 +1,55 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class AI
+      class Assistants
+        # Configure AI assistant specifications
+        class Instructions
+          # Enhance an assistant's instructions using an LLM. The endpoint reads the
+          # assistant's current instructions and tools, then streams back improved
+          # instructions as they are generated.
+          #
+          # Optionally provide an `enhancement_prompt` to steer the changes (for example,
+          # "make the instructions more concise" or "add error handling guidance"). When
+          # omitted, the assistant's existing instructions are used as the basis for the
+          # enhancement.
+          #
+          # The enhancement focuses on tool-calling reliability, clarity and precision,
+          # completeness and error handling, tool schema alignment, and conversation flow
+          # structure.
+          #
+          # The response is streamed as `text/plain` using chunked transfer encoding;
+          # consume the body incrementally to render the enhanced instructions as they
+          # arrive.
+          sig do
+            params(
+              assistant_id: String,
+              enhancement_prompt: T.nilable(String),
+              instructions: T.nilable(String),
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(String)
+          end
+          def enhance(
+            # Unique identifier of the assistant.
+            assistant_id,
+            # Optional guidance describing how the instructions should be enhanced. When
+            # provided, the LLM applies these requested changes in addition to fixing any
+            # identified issues.
+            enhancement_prompt: nil,
+            # The instructions to enhance. When omitted, the assistant's existing instructions
+            # are used.
+            instructions: nil,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: Telnyx::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/ai/assistants.rbi

@@ -29,6 +29,10 @@ module Telnyx
         sig { returns(Telnyx::Resources::AI::Assistants::Tags) }
         attr_reader :tags
 
+        # Configure AI assistant specifications
+        sig { returns(Telnyx::Resources::AI::Assistants::Instructions) }
+        attr_reader :instructions
+
         # Create a new AI Assistant.
         sig do
           params(

data/sig/telnyx/models/ai/assistants/instruction_enhance_params.rbs

@@ -0,0 +1,40 @@
+module Telnyx
+  module Models
+    module AI
+      module Assistants
+        type instruction_enhance_params =
+          {
+            assistant_id: String,
+            enhancement_prompt: String?,
+            instructions: String?
+          }
+          & Telnyx::Internal::Type::request_parameters
+
+        class InstructionEnhanceParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          attr_accessor assistant_id: String
+
+          attr_accessor enhancement_prompt: String?
+
+          attr_accessor instructions: String?
+
+          def initialize: (
+            assistant_id: String,
+            ?enhancement_prompt: String?,
+            ?instructions: String?,
+            ?request_options: Telnyx::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            assistant_id: String,
+            enhancement_prompt: String?,
+            instructions: String?,
+            request_options: Telnyx::RequestOptions
+          }
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/ai/assistants/instruction_enhance_response.rbs

@@ -0,0 +1,9 @@
+module Telnyx
+  module Models
+    module AI
+      module Assistants
+        class InstructionEnhanceResponse = String
+      end
+    end
+  end
+end

data/sig/telnyx/resources/ai/assistants/instructions.rbs

@@ -0,0 +1,18 @@
+module Telnyx
+  module Resources
+    class AI
+      class Assistants
+        class Instructions
+          def enhance: (
+            String assistant_id,
+            ?enhancement_prompt: String?,
+            ?instructions: String?,
+            ?request_options: Telnyx::request_opts
+          ) -> String
+
+          def initialize: (client: Telnyx::Client) -> void
+        end
+      end
+    end
+  end
+end

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

@@ -14,6 +14,8 @@ module Telnyx
 
         attr_reader tags: Telnyx::Resources::AI::Assistants::Tags
 
+        attr_reader instructions: Telnyx::Resources::AI::Assistants::Instructions
+
         def create: (
           instructions: String,
           name: String,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telnyx
 version: !ruby/object:Gem::Version
-  version: 5.127.0
+  version: 5.128.0
 platform: ruby
 authors:
 - Telnyx
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-11 00:00:00.000000000 Z
+date: 2026-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi
@@ -166,6 +166,8 @@ files:
 - lib/telnyx/models/ai/assistants/canary_deploy_update_params.rb
 - lib/telnyx/models/ai/assistants/conversation_channel_type.rb
 - lib/telnyx/models/ai/assistants/event_status.rb
+- lib/telnyx/models/ai/assistants/instruction_enhance_params.rb
+- lib/telnyx/models/ai/assistants/instruction_enhance_response.rb
 - lib/telnyx/models/ai/assistants/scheduled_event_create_params.rb
 - lib/telnyx/models/ai/assistants/scheduled_event_delete_params.rb
 - lib/telnyx/models/ai/assistants/scheduled_event_list_params.rb
@@ -2547,6 +2549,7 @@ files:
 - lib/telnyx/resources/ai.rb
 - lib/telnyx/resources/ai/assistants.rb
 - lib/telnyx/resources/ai/assistants/canary_deploys.rb
+- lib/telnyx/resources/ai/assistants/instructions.rb
 - lib/telnyx/resources/ai/assistants/scheduled_events.rb
 - lib/telnyx/resources/ai/assistants/tags.rb
 - lib/telnyx/resources/ai/assistants/tests.rb
@@ -2974,6 +2977,8 @@ files:
 - rbi/telnyx/models/ai/assistants/canary_deploy_update_params.rbi
 - rbi/telnyx/models/ai/assistants/conversation_channel_type.rbi
 - rbi/telnyx/models/ai/assistants/event_status.rbi
+- rbi/telnyx/models/ai/assistants/instruction_enhance_params.rbi
+- rbi/telnyx/models/ai/assistants/instruction_enhance_response.rbi
 - rbi/telnyx/models/ai/assistants/scheduled_event_create_params.rbi
 - rbi/telnyx/models/ai/assistants/scheduled_event_delete_params.rbi
 - rbi/telnyx/models/ai/assistants/scheduled_event_list_params.rbi
@@ -5355,6 +5360,7 @@ files:
 - rbi/telnyx/resources/ai.rbi
 - rbi/telnyx/resources/ai/assistants.rbi
 - rbi/telnyx/resources/ai/assistants/canary_deploys.rbi
+- rbi/telnyx/resources/ai/assistants/instructions.rbi
 - rbi/telnyx/resources/ai/assistants/scheduled_events.rbi
 - rbi/telnyx/resources/ai/assistants/tags.rbi
 - rbi/telnyx/resources/ai/assistants/tests.rbi
@@ -5773,6 +5779,8 @@ files:
 - sig/telnyx/models/ai/assistants/canary_deploy_update_params.rbs
 - sig/telnyx/models/ai/assistants/conversation_channel_type.rbs
 - sig/telnyx/models/ai/assistants/event_status.rbs
+- sig/telnyx/models/ai/assistants/instruction_enhance_params.rbs
+- sig/telnyx/models/ai/assistants/instruction_enhance_response.rbs
 - sig/telnyx/models/ai/assistants/scheduled_event_create_params.rbs
 - sig/telnyx/models/ai/assistants/scheduled_event_delete_params.rbs
 - sig/telnyx/models/ai/assistants/scheduled_event_list_params.rbs
@@ -8154,6 +8162,7 @@ files:
 - sig/telnyx/resources/ai.rbs
 - sig/telnyx/resources/ai/assistants.rbs
 - sig/telnyx/resources/ai/assistants/canary_deploys.rbs
+- sig/telnyx/resources/ai/assistants/instructions.rbs
 - sig/telnyx/resources/ai/assistants/scheduled_events.rbs
 - sig/telnyx/resources/ai/assistants/tags.rbs
 - sig/telnyx/resources/ai/assistants/tests.rbs