telnyx 5.163.0 → 5.164.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd14ec881b84e3ce8b0d2ba88bc49cc87dd03da84dcaa0fd551a48a7a954d715
-  data.tar.gz: 75fef0397f90e5f5fb35702edad17b1956ee62024056661b670047bb68df30b8
+  metadata.gz: 4274858db2139e7fb6f3cb67db626fa3aafce7935eb9034b0159758f8b02b07f
+  data.tar.gz: 7d24d10dd76f0bd6db624031d45522d65cbd8323f1421488cbaedfb20be29a99
 SHA512:
-  metadata.gz: 9f6682ab4347e4de132f6b73aa3bf0ab3927ab3b5da54a9d9a5cf10591777fe914cbf62e9599a3a06f034fb6cdf982f4cbb9868616ecb320433803feed6e6995
-  data.tar.gz: fc259dfb669208234bf0bc21ac8c92779781545ba8645f4c26c6b7312c36dee69936ea4ea544eb8c83ba24cd8f8f04ac43cf030d72f2aafcee943c8541d2d700
+  metadata.gz: c91c57dee7c3523696baecef7b32add3fad9ad4a8dc934340a435eb788148af0f14504821c0648824208cf2711f0bad18f19fc5d756a3a68a8ef909aad4d8adb
+  data.tar.gz: 70537fea219cc85e7fe50d5dd2ff711b2a54ace8b6d0caa1900ada6f81e0fbece5016a7e57a35b4840da4beacc41399eff74fe6f0f17285c66aa874ad9285a17

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [5.164.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.163.0...v5.164.0) (2026-08-31)
+
+
+### Features
+
+* promote from staging 88d5491 ([d62cbe6](https://github.com/team-telnyx/telnyx-ruby/commit/d62cbe641c502f1f69a2fcca8089f3f6ff72ae91))
+
 ## [5.163.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.162.0...v5.163.0) (2026-08-21)
 
 

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.163.0"
+gem "telnyx", "~> 5.164.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/telnyx/models/ai/anthropic/v1_messages_params.rb

@@ -24,8 +24,9 @@ module Telnyx
                    Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]]
 
           # @!attribute model
-          #   The model to use for generating the response, for example `zai-org/GLM-5.2` or
-          #   another model available from the Telnyx models endpoint.
+          #   The model to use for generating the response, for example
+          #   `zai-org/GLM-5.3-Flash` or another model available from the Telnyx models
+          #   endpoint.
           #
           #   @return [String]
           required :model, String
@@ -150,7 +151,7 @@ module Telnyx
           #
           #   @param messages [Array<Hash{Symbol=>Object}>] The messages to send to the model, following the [Anthropic Messages API](https:
           #
-          #   @param model [String] The model to use for generating the response, for example `zai-org/GLM-5.2` or a
+          #   @param model [String] The model to use for generating the response, for example `zai-org/GLM-5.3-Flash
           #
           #   @param api_key_ref [String] If you are using an external inference provider, this field allows you to pass a
           #

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

@@ -280,6 +280,23 @@ module Telnyx
             #   @return [Integer, nil]
             optional :warm_message_delay_ms, Integer, nil?: true
 
+            # @!attribute warm_transfer_acceptance
+            #   Requires the transfer destination to accept the call before the caller is
+            #   bridged. When enabled, the assistant speaks privately with the destination after
+            #   they answer — delivering the warm transfer message and asking whether they take
+            #   the call — while the caller keeps hearing ringback. The assistant then finalizes
+            #   the transfer with the built-in `complete_transfer` tool: an accept bridges the
+            #   calls, a decline hangs up the destination and returns the assistant to the
+            #   caller with the reason the destination gave. Requires either
+            #   `warm_transfer_instructions` or a `message` on every target, otherwise the
+            #   assistant fails to save. Only available for calls started with
+            #   `ai_assistant_start`; single-caller conversations only (a conference or
+            #   additional invited participants fall back to a regular warm transfer).
+            #
+            #   @return [Telnyx::Models::AI::AssistantTool::Transfer::Transfer::WarmTransferAcceptance, nil]
+            optional :warm_transfer_acceptance,
+                     -> { Telnyx::AI::AssistantTool::Transfer::Transfer::WarmTransferAcceptance }
+
             # @!attribute warm_transfer_instructions
             #   Natural language instructions for your agent for how to provide context for the
             #   transfer recipient.
@@ -287,7 +304,7 @@ module Telnyx
             #   @return [String, nil]
             optional :warm_transfer_instructions, String
 
-            # @!method initialize(from:, targets:, custom_headers: nil, description: nil, voicemail_detection: nil, warm_message_delay_ms: nil, warm_transfer_instructions: nil)
+            # @!method initialize(from:, targets:, custom_headers: nil, description: nil, voicemail_detection: nil, warm_message_delay_ms: nil, warm_transfer_acceptance: nil, warm_transfer_instructions: nil)
             #   Some parameter documentations has been truncated, see
             #   {Telnyx::Models::AI::AssistantTool::Transfer::Transfer} for more details.
             #
@@ -303,6 +320,8 @@ module Telnyx
             #
             #   @param warm_message_delay_ms [Integer, nil] Optional delay in milliseconds before playing the warm message audio when the tr
             #
+            #   @param warm_transfer_acceptance [Telnyx::Models::AI::AssistantTool::Transfer::Transfer::WarmTransferAcceptance] Requires the transfer destination to accept the call before the caller is bridge
+            #
             #   @param warm_transfer_instructions [String] Natural language instructions for your agent for how to provide context for the
 
             # The different possible targets of the transfer. The assistant will be able to
@@ -326,15 +345,29 @@ module Telnyx
                 #   @return [String]
                 required :to, String
 
+                # @!attribute message
+                #   The warm transfer message to deliver to this specific target. When set, it takes
+                #   precedence over the message the assistant composes from
+                #   `warm_transfer_instructions`.
+                #
+                #   @return [String, nil]
+                optional :message, String
+
                 # @!attribute name
                 #   The name of the target.
                 #
                 #   @return [String, nil]
                 optional :name, String
 
-                # @!method initialize(to:, name: nil)
+                # @!method initialize(to:, message: nil, name: nil)
+                #   Some parameter documentations has been truncated, see
+                #   {Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Targets::TargetsList}
+                #   for more details.
+                #
                 #   @param to [String] The destination number or SIP URI of the call.
                 #
+                #   @param message [String] The warm transfer message to deliver to this specific target. When set, it takes
+                #
                 #   @param name [String] The name of the target.
               end
 
@@ -615,6 +648,64 @@ module Telnyx
                 end
               end
             end
+
+            # @see Telnyx::Models::AI::AssistantTool::Transfer::Transfer#warm_transfer_acceptance
+            class WarmTransferAcceptance < Telnyx::Internal::Type::BaseModel
+              # @!attribute enabled
+              #   Whether the destination must accept the transfer before the calls are bridged.
+              #
+              #   @return [Boolean, nil]
+              optional :enabled, Telnyx::Internal::Type::Boolean
+
+              # @!attribute end_user_target_context_mode
+              #   Controls whether the private exchange between the assistant and the transfer
+              #   destination is kept out of the conversation. With `private` (default) the
+              #   exchange never reaches the conversation history, AI conversations, webhooks or
+              #   insights, and the transfer tool result is rewritten with the outcome only. With
+              #   `shared` the exchange stays in the conversation like any other messages.
+              #
+              #   @return [Symbol, Telnyx::Models::AI::AssistantTool::Transfer::Transfer::WarmTransferAcceptance::EndUserTargetContextMode, nil]
+              optional :end_user_target_context_mode,
+                       enum: -> { Telnyx::AI::AssistantTool::Transfer::Transfer::WarmTransferAcceptance::EndUserTargetContextMode }
+
+              # @!method initialize(enabled: nil, end_user_target_context_mode: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {Telnyx::Models::AI::AssistantTool::Transfer::Transfer::WarmTransferAcceptance}
+              #   for more details.
+              #
+              #   Requires the transfer destination to accept the call before the caller is
+              #   bridged. When enabled, the assistant speaks privately with the destination after
+              #   they answer — delivering the warm transfer message and asking whether they take
+              #   the call — while the caller keeps hearing ringback. The assistant then finalizes
+              #   the transfer with the built-in `complete_transfer` tool: an accept bridges the
+              #   calls, a decline hangs up the destination and returns the assistant to the
+              #   caller with the reason the destination gave. Requires either
+              #   `warm_transfer_instructions` or a `message` on every target, otherwise the
+              #   assistant fails to save. Only available for calls started with
+              #   `ai_assistant_start`; single-caller conversations only (a conference or
+              #   additional invited participants fall back to a regular warm transfer).
+              #
+              #   @param enabled [Boolean] Whether the destination must accept the transfer before the calls are bridged.
+              #
+              #   @param end_user_target_context_mode [Symbol, Telnyx::Models::AI::AssistantTool::Transfer::Transfer::WarmTransferAcceptance::EndUserTargetContextMode] Controls whether the private exchange between the assistant and the transfer des
+
+              # Controls whether the private exchange between the assistant and the transfer
+              # destination is kept out of the conversation. With `private` (default) the
+              # exchange never reaches the conversation history, AI conversations, webhooks or
+              # insights, and the transfer tool result is rewritten with the outcome only. With
+              # `shared` the exchange stays in the conversation like any other messages.
+              #
+              # @see Telnyx::Models::AI::AssistantTool::Transfer::Transfer::WarmTransferAcceptance#end_user_target_context_mode
+              module EndUserTargetContextMode
+                extend Telnyx::Internal::Type::Enum
+
+                PRIVATE = :private
+                SHARED = :shared
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
           end
         end
 

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

@@ -113,6 +113,16 @@ module Telnyx
         #   @return [Float, nil]
         optional :presence_penalty, Float
 
+        # @!attribute reasoning_effort
+        #   Controls the reasoning effort for models that support it. When set, the model
+        #   spends more or less compute on internal reasoning before generating its
+        #   response. Supported values: none, minimal, low, medium, high, xhigh, max. Not
+        #   all models support all values; unsupported values are rejected with a 400 error.
+        #   When omitted, reasoning models use their default effort level.
+        #
+        #   @return [Symbol, Telnyx::Models::AI::ChatCompletionRequest::ReasoningEffort, nil]
+        optional :reasoning_effort, enum: -> { Telnyx::AI::ChatCompletionRequest::ReasoningEffort }
+
         # @!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`.
@@ -195,7 +205,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, model: nil, n: nil, presence_penalty: 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, 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, reasoning_effort: 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.
         #
@@ -231,6 +241,8 @@ module Telnyx
         #
         #   @param presence_penalty [Float] Higher values will penalize the model from repeating the same output tokens.
         #
+        #   @param reasoning_effort [Symbol, Telnyx::Models::AI::ChatCompletionRequest::ReasoningEffort] Controls the reasoning effort for models that support it. When set, the model sp
+        #
         #   @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 seed [Integer] If specified, the system will make a best effort to sample deterministically, su
@@ -333,6 +345,28 @@ module Telnyx
           end
         end
 
+        # Controls the reasoning effort for models that support it. When set, the model
+        # spends more or less compute on internal reasoning before generating its
+        # response. Supported values: none, minimal, low, medium, high, xhigh, max. Not
+        # all models support all values; unsupported values are rejected with a 400 error.
+        # When omitted, reasoning models use their default effort level.
+        #
+        # @see Telnyx::Models::AI::ChatCompletionRequest#reasoning_effort
+        module ReasoningEffort
+          extend Telnyx::Internal::Type::Enum
+
+          NONE = :none
+          MINIMAL = :minimal
+          LOW = :low
+          MEDIUM = :medium
+          HIGH = :high
+          XHIGH = :xhigh
+          MAX = :max
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
         # @see Telnyx::Models::AI::ChatCompletionRequest#response_format
         class ResponseFormat < Telnyx::Internal::Type::BaseModel
           # @!attribute type

data/lib/telnyx/models/ai/collections/retrieval_settings.rb

@@ -8,6 +8,9 @@ module Telnyx
           # @!attribute retrieval_type
           #   Retrieval strategy. `vector` runs semantic similarity search; `hybrid` combines
           #   vector similarity with keyword matching; `keyword` runs lexical (BM25) matching.
+          #   `keyword` is not accepted yet: setting it returns 422
+          #   `unsupported_retrieval_type`. A collection set to `hybrid` is accepted here but
+          #   cannot be searched until hybrid execution ships.
           #
           #   @return [Symbol, Telnyx::Models::AI::Collections::RetrievalSettings::RetrievalType, nil]
           optional :retrieval_type, enum: -> { Telnyx::AI::Collections::RetrievalSettings::RetrievalType }
@@ -30,6 +33,9 @@ module Telnyx
 
           # Retrieval strategy. `vector` runs semantic similarity search; `hybrid` combines
           # vector similarity with keyword matching; `keyword` runs lexical (BM25) matching.
+          # `keyword` is not accepted yet: setting it returns 422
+          # `unsupported_retrieval_type`. A collection set to `hybrid` is accepted here but
+          # cannot be searched until hybrid execution ships.
           #
           # @see Telnyx::Models::AI::Collections::RetrievalSettings#retrieval_type
           module RetrievalType
@@ -37,7 +43,6 @@ module Telnyx
 
             VECTOR = :vector
             HYBRID = :hybrid
-            KEYWORD = :keyword
 
             # @!method self.values
             #   @return [Array<Symbol>]

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

@@ -111,6 +111,31 @@ module Telnyx
           #   @return [Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::Webhook::PathParameters, nil]
           optional :path_parameters, -> { Telnyx::AI::InferenceEmbeddingWebhookToolParams::Webhook::PathParameters }
 
+          # @!attribute preset_body_fields
+          #   Body fields supplied by the assistant configuration rather than by the model.
+          #   They are never advertised in the tool definition, so the LLM can neither see nor
+          #   set them, and they take precedence over a `body_parameters` value of the same
+          #   name. Values support mustache templating, so they can hold dynamic variables
+          #   (`{{customer_id}}`) and integration secrets
+          #   (`{{#integration_secret}}my-secret{{/integration_secret}}`). Not sent on `GET`
+          #   requests, which carry no body.
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :preset_body_fields, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+          # @!attribute preset_query_params
+          #   Query string parameters supplied by the assistant configuration rather than by
+          #   the model. They are never advertised in the tool definition, so the LLM can
+          #   neither see nor set them, and they take precedence over a `query_parameters`
+          #   value of the same name. Values support mustache templating, so they can hold
+          #   dynamic variables (`{{telnyx_end_user_target}}`) and integration secrets
+          #   (`{{#integration_secret}}my-secret{{/integration_secret}}`). Unlike values
+          #   templated directly into the `url`, these are percent-encoded, so a value such as
+          #   `+15551234567` survives the round trip.
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :preset_query_params, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
           # @!attribute query_parameters
           #   The query parameters the webhook tool accepts, described as a JSON Schema
           #   object. These parameters will be passed to the webhook as the query of the
@@ -138,7 +163,7 @@ module Telnyx
           #   @return [Integer, nil]
           optional :timeout_ms, Integer
 
-          # @!method initialize(description:, name:, url:, async: nil, async_timeout_ms: nil, body_parameters: nil, headers: nil, messages: nil, http_method: nil, path_parameters: nil, query_parameters: nil, store_fields_as_variables: nil, timeout_ms: nil)
+          # @!method initialize(description:, name:, url:, async: nil, async_timeout_ms: nil, body_parameters: nil, headers: nil, messages: nil, http_method: nil, path_parameters: nil, preset_body_fields: nil, preset_query_params: nil, query_parameters: nil, store_fields_as_variables: nil, timeout_ms: nil)
           #   Some parameter documentations has been truncated, see
           #   {Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::Webhook} for more
           #   details.
@@ -163,6 +188,10 @@ module Telnyx
           #
           #   @param path_parameters [Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::Webhook::PathParameters] The path parameters the webhook tool accepts, described as a JSON Schema object.
           #
+          #   @param preset_body_fields [Hash{Symbol=>Object}] Body fields supplied by the assistant configuration rather than by the model. Th
+          #
+          #   @param preset_query_params [Hash{Symbol=>Object}] Query string parameters supplied by the assistant configuration rather than by t
+          #
           #   @param query_parameters [Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::Webhook::QueryParameters] The query parameters the webhook tool accepts, described as a JSON Schema object
           #
           #   @param store_fields_as_variables [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::Webhook::StoreFieldsAsVariable>] A list of mappings that extract values from the webhook response and store them

data/lib/telnyx/models/ai/knowledge/collection_retrieve_documents_params.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Knowledge
+        # @see Telnyx::Resources::AI::Knowledge::Collections#retrieve_documents
+        class CollectionRetrieveDocumentsParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!attribute slug
+          #
+          #   @return [String]
+          required :slug, String
+
+          # @!attribute filter
+          #   Field filters applied before ranking, using `filter[field][operator]=value`.
+          #   Supported operators: `eq` (default), `in`, `gte`, `gt`, `lte`, `lt`, `contains`.
+          #   Known fields: `record_type`, `record_id`, `user_id`, `record_created_at`,
+          #   `ingested_at`; any other name resolves to a `metadata.<field>` filter. Example:
+          #   `filter[record_id][eq]=rec_123`.
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :filter, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+          # @!attribute page_number
+          #   Page number to return (1-based). Defaults to 1.
+          #
+          #   @return [Integer, nil]
+          optional :page_number, Integer
+
+          # @!attribute page_size
+          #   Number of results per page. Defaults to 20.
+          #
+          #   @return [Integer, nil]
+          optional :page_size, Integer
+
+          # @!attribute query
+          #   Natural-language search query. When provided, the text is matched against the
+          #   collection's document chunks using the collection's `retrieval_type` (vector or
+          #   hybrid). When omitted, documents are returned as a plain catalog listing.
+          #
+          #   @return [String, nil]
+          optional :query, String
+
+          # @!attribute retrieval_type
+          #   Reserved; not yet functional. A value supplied here is accepted but ignored — it
+          #   does not override the collection's configured strategy, and it is not echoed
+          #   back. Searches run `vector` retrieval, and `meta.retrieval_type` reports the
+          #   mode that actually ran. To change retrieval strategy, set it on the collection's
+          #   settings subresource.
+          #
+          #   @return [Symbol, Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsParams::RetrievalType, nil]
+          optional :retrieval_type,
+                   enum: -> { Telnyx::AI::Knowledge::CollectionRetrieveDocumentsParams::RetrievalType }
+
+          # @!attribute sources
+          #   Comma-separated list of source types to restrict the search to. When omitted,
+          #   all of the collection's sources are searched.
+          #
+          #   @return [String, nil]
+          optional :sources, String
+
+          # @!attribute top_k
+          #   Maximum number of ranked results to consider. When omitted, the collection's
+          #   configured `top_k` setting is used.
+          #
+          #   @return [Integer, nil]
+          optional :top_k, Integer
+
+          # @!method initialize(slug:, filter: nil, page_number: nil, page_size: nil, query: nil, retrieval_type: nil, sources: nil, top_k: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsParams} for more
+          #   details.
+          #
+          #   @param slug [String]
+          #
+          #   @param filter [Hash{Symbol=>Object}] Field filters applied before ranking, using `filter[field][operator]=value`. Sup
+          #
+          #   @param page_number [Integer] Page number to return (1-based). Defaults to 1.
+          #
+          #   @param page_size [Integer] Number of results per page. Defaults to 20.
+          #
+          #   @param query [String] Natural-language search query. When provided, the text is matched against the co
+          #
+          #   @param retrieval_type [Symbol, Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsParams::RetrievalType] Reserved; not yet functional. A value supplied here is accepted but ignored — it
+          #
+          #   @param sources [String] Comma-separated list of source types to restrict the search to. When omitted, al
+          #
+          #   @param top_k [Integer] Maximum number of ranked results to consider. When omitted, the collection's con
+          #
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+          # Reserved; not yet functional. A value supplied here is accepted but ignored — it
+          # does not override the collection's configured strategy, and it is not echoed
+          # back. Searches run `vector` retrieval, and `meta.retrieval_type` reports the
+          # mode that actually ran. To change retrieval strategy, set it on the collection's
+          # settings subresource.
+          module RetrievalType
+            extend Telnyx::Internal::Type::Enum
+
+            VECTOR = :vector
+            HYBRID = :hybrid
+            KEYWORD = :keyword
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/knowledge/collection_retrieve_documents_response.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Knowledge
+        # @see Telnyx::Resources::AI::Knowledge::Collections#retrieve_documents
+        class CollectionRetrieveDocumentsResponse < Telnyx::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [Array<Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Data>, nil]
+          optional :data,
+                   -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Data] }
+
+          # @!attribute meta
+          #
+          #   @return [Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Meta, nil]
+          optional :meta, -> { Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Meta }
+
+          # @!method initialize(data: nil, meta: nil)
+          #   @param data [Array<Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Data>]
+          #   @param meta [Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Meta]
+
+          class Data < Telnyx::Internal::Type::BaseModel
+            # @!attribute id
+            #
+            #   @return [String, nil]
+            optional :id, String
+
+            # @!attribute chunk_index
+            #
+            #   @return [Integer, nil]
+            optional :chunk_index, Integer
+
+            # @!attribute chunk_total
+            #
+            #   @return [Integer, nil]
+            optional :chunk_total, Integer
+
+            # @!attribute ingested_at
+            #
+            #   @return [Time, nil]
+            optional :ingested_at, Time
+
+            # @!attribute metadata
+            #
+            #   @return [Hash{Symbol=>Object}, nil]
+            optional :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+            # @!attribute organization_id
+            #
+            #   @return [String, nil]
+            optional :organization_id, String
+
+            # @!attribute record_created_at
+            #
+            #   @return [Time, nil]
+            optional :record_created_at, Time
+
+            # @!attribute record_id
+            #
+            #   @return [String, nil]
+            optional :record_id, String
+
+            # @!attribute record_type
+            #   The source record kind this chunk came from (e.g. `voice`, `meeting_bot`,
+            #   `message`).
+            #
+            #   @return [String, nil]
+            optional :record_type, String
+
+            # @!attribute region
+            #
+            #   @return [String, nil]
+            optional :region, String
+
+            # @!attribute score
+            #   Relevance score (higher = more relevant) for ranked search. `0.0` for plain
+            #   catalog listings (when `query` is omitted).
+            #
+            #   @return [Float, nil]
+            optional :score, Float
+
+            # @!attribute text
+            #
+            #   @return [String, nil]
+            optional :text, String
+
+            # @!attribute user_id
+            #
+            #   @return [String, nil]
+            optional :user_id, String
+
+            # @!method initialize(id: nil, chunk_index: nil, chunk_total: nil, ingested_at: nil, metadata: nil, organization_id: nil, record_created_at: nil, record_id: nil, record_type: nil, region: nil, score: nil, text: nil, user_id: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Data} for
+            #   more details.
+            #
+            #   @param id [String]
+            #
+            #   @param chunk_index [Integer]
+            #
+            #   @param chunk_total [Integer]
+            #
+            #   @param ingested_at [Time]
+            #
+            #   @param metadata [Hash{Symbol=>Object}]
+            #
+            #   @param organization_id [String]
+            #
+            #   @param record_created_at [Time]
+            #
+            #   @param record_id [String]
+            #
+            #   @param record_type [String] The source record kind this chunk came from (e.g. `voice`, `meeting_bot`, `messa
+            #
+            #   @param region [String]
+            #
+            #   @param score [Float] Relevance score (higher = more relevant) for ranked search. `0.0` for plain cata
+            #
+            #   @param text [String]
+            #
+            #   @param user_id [String]
+          end
+
+          # @see Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse#meta
+          class Meta < Telnyx::Internal::Type::BaseModel
+            # @!attribute collection_slug
+            #
+            #   @return [String, nil]
+            optional :collection_slug, String
+
+            # @!attribute page_number
+            #
+            #   @return [Integer, nil]
+            optional :page_number, Integer
+
+            # @!attribute page_size
+            #
+            #   @return [Integer, nil]
+            optional :page_size, Integer
+
+            # @!attribute retrieval_type
+            #
+            #   @return [String, nil]
+            optional :retrieval_type, String
+
+            # @!attribute searched_sources
+            #
+            #   @return [Array<String>, nil]
+            optional :searched_sources, Telnyx::Internal::Type::ArrayOf[String]
+
+            # @!attribute top_k
+            #
+            #   @return [Integer, nil]
+            optional :top_k, Integer
+
+            # @!attribute total_pages
+            #
+            #   @return [Integer, nil]
+            optional :total_pages, Integer
+
+            # @!attribute total_results
+            #
+            #   @return [Integer, nil]
+            optional :total_results, Integer
+
+            # @!method initialize(collection_slug: nil, page_number: nil, page_size: nil, retrieval_type: nil, searched_sources: nil, top_k: nil, total_pages: nil, total_results: nil)
+            #   @param collection_slug [String]
+            #   @param page_number [Integer]
+            #   @param page_size [Integer]
+            #   @param retrieval_type [String]
+            #   @param searched_sources [Array<String>]
+            #   @param top_k [Integer]
+            #   @param total_pages [Integer]
+            #   @param total_results [Integer]
+          end
+        end
+      end
+    end
+  end
+end