telnyx 5.158.0 → 5.160.0

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      # @see Telnyx::Resources::AI::Collections#retrieve_by_id
+      class CollectionRetrieveByIDParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute uuid
+        #
+        #   @return [String]
+        required :uuid, String
+
+        # @!method initialize(uuid:, request_options: {})
+        #   @param uuid [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      # @see Telnyx::Resources::AI::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
+        #   Override the collection's configured retrieval strategy for this request. Echoed
+        #   back in `meta.retrieval_type`.
+        #
+        #   @return [Symbol, Telnyx::Models::AI::CollectionRetrieveDocumentsParams::RetrievalType, nil]
+        optional :retrieval_type, enum: -> { Telnyx::AI::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::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::CollectionRetrieveDocumentsParams::RetrievalType] Override the collection's configured retrieval strategy for this request. Echoed
+        #
+        #   @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}]
+
+        # Override the collection's configured retrieval strategy for this request. Echoed
+        # back in `meta.retrieval_type`.
+        module RetrievalType
+          extend Telnyx::Internal::Type::Enum
+
+          VECTOR = :vector
+          HYBRID = :hybrid
+          KEYWORD = :keyword
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      # @see Telnyx::Resources::AI::Collections#retrieve_documents
+      class CollectionRetrieveDocumentsResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Array<Telnyx::Models::AI::CollectionRetrieveDocumentsResponse::Data>, nil]
+        optional :data,
+                 -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::AI::CollectionRetrieveDocumentsResponse::Data] }
+
+        # @!attribute meta
+        #
+        #   @return [Telnyx::Models::AI::CollectionRetrieveDocumentsResponse::Meta, nil]
+        optional :meta, -> { Telnyx::Models::AI::CollectionRetrieveDocumentsResponse::Meta }
+
+        # @!method initialize(data: nil, meta: nil)
+        #   @param data [Array<Telnyx::Models::AI::CollectionRetrieveDocumentsResponse::Data>]
+        #   @param meta [Telnyx::Models::AI::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::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::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

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      # @see Telnyx::Resources::AI::Collections#retrieve
+      class CollectionRetrieveParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute slug
+        #
+        #   @return [String]
+        required :slug, String
+
+        # @!method initialize(slug:, request_options: {})
+        #   @param slug [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      # @see Telnyx::Resources::AI::Collections#update
+      class CollectionUpdateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute uuid
+        #
+        #   @return [String]
+        required :uuid, String
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!method initialize(uuid:, description: nil, name: nil, request_options: {})
+        #   @param uuid [String]
+        #   @param description [String]
+        #   @param name [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Collections
+        class RetrievalSettings < Telnyx::Internal::Type::BaseModel
+          # @!attribute retrieval_type
+          #   Retrieval strategy. `vector` runs semantic similarity search; `hybrid` combines
+          #   vector similarity with keyword matching; `keyword` runs lexical (BM25) matching.
+          #
+          #   @return [Symbol, Telnyx::Models::AI::Collections::RetrievalSettings::RetrievalType, nil]
+          optional :retrieval_type, enum: -> { Telnyx::AI::Collections::RetrievalSettings::RetrievalType }
+
+          # @!attribute top_k
+          #   Number of top results to retrieve (1–50).
+          #
+          #   @return [Integer, nil]
+          optional :top_k, Integer
+
+          # @!method initialize(retrieval_type: nil, top_k: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::AI::Collections::RetrievalSettings} for more details.
+          #
+          #   How documents are retrieved when searching the collection.
+          #
+          #   @param retrieval_type [Symbol, Telnyx::Models::AI::Collections::RetrievalSettings::RetrievalType] Retrieval strategy. `vector` runs semantic similarity search; `hybrid` combines
+          #
+          #   @param top_k [Integer] Number of top results to retrieve (1–50).
+
+          # Retrieval strategy. `vector` runs semantic similarity search; `hybrid` combines
+          # vector similarity with keyword matching; `keyword` runs lexical (BM25) matching.
+          #
+          # @see Telnyx::Models::AI::Collections::RetrievalSettings#retrieval_type
+          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/collections/retrieval_settings_wrapper.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Collections
+        class RetrievalSettingsWrapper < Telnyx::Internal::Type::BaseModel
+          # @!attribute retrieval
+          #   How documents are retrieved when searching the collection.
+          #
+          #   @return [Telnyx::Models::AI::Collections::RetrievalSettings, nil]
+          optional :retrieval, -> { Telnyx::AI::Collections::RetrievalSettings }
+
+          response_only do
+            # @!attribute record_type
+            #   Identifies the record type. Always `ai_collection_settings`.
+            #
+            #   @return [String, nil]
+            optional :record_type, String
+          end
+
+          # @!method initialize(record_type: nil, retrieval: nil)
+          #   @param record_type [String] Identifies the record type. Always `ai_collection_settings`.
+          #
+          #   @param retrieval [Telnyx::Models::AI::Collections::RetrievalSettings] How documents are retrieved when searching the collection.
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Collections
+        # @see Telnyx::Resources::AI::Collections::Settings#create
+        class SettingCreateParams < Telnyx::Models::AI::Collections::SettingsRequest
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!attribute uuid
+          #
+          #   @return [String]
+          required :uuid, String
+
+          # @!method initialize(uuid:, request_options: {})
+          #   @param uuid [String]
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Collections
+        # @see Telnyx::Resources::AI::Collections::Settings#list
+        class SettingListParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!attribute uuid
+          #
+          #   @return [String]
+          required :uuid, String
+
+          # @!method initialize(uuid:, request_options: {})
+          #   @param uuid [String]
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Collections
+        # @see Telnyx::Resources::AI::Collections::Settings#patch_all
+        class SettingPatchAllParams < Telnyx::Models::AI::Collections::SettingsRequest
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!attribute uuid
+          #
+          #   @return [String]
+          required :uuid, String
+
+          # @!method initialize(uuid:, request_options: {})
+          #   @param uuid [String]
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Collections
+        # @see Telnyx::Resources::AI::Collections::Settings#create
+        class SettingsEnvelope < Telnyx::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [Telnyx::Models::AI::Collections::RetrievalSettingsWrapper, nil]
+          optional :data, -> { Telnyx::AI::Collections::RetrievalSettingsWrapper }
+
+          # @!method initialize(data: nil)
+          #   @param data [Telnyx::Models::AI::Collections::RetrievalSettingsWrapper]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Collections
+        class SettingsRequest < Telnyx::Internal::Type::BaseModel
+          # @!attribute retrieval
+          #   How documents are retrieved when searching the collection.
+          #
+          #   @return [Telnyx::Models::AI::Collections::RetrievalSettings, nil]
+          optional :retrieval, -> { Telnyx::AI::Collections::RetrievalSettings }
+
+          # @!method initialize(retrieval: nil)
+          #   @param retrieval [Telnyx::Models::AI::Collections::RetrievalSettings] How documents are retrieved when searching the collection.
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Collections
+        class Source < Telnyx::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute bucket_id
+          #   The Telnyx Storage bucket name. Present only for `bucket` sources.
+          #
+          #   @return [String, nil]
+          optional :bucket_id, String
+
+          # @!attribute collection_id
+          #
+          #   @return [String, nil]
+          optional :collection_id, String
+
+          # @!attribute record_type
+          #   Identifies the record type. Always `ai_collection_source`.
+          #
+          #   @return [String, nil]
+          optional :record_type, String
+
+          # @!attribute source_type
+          #   The type of Telnyx data attached as a source. `bucket` requires an additional
+          #   `bucket_id`. Only `voice` is searchable today; `meeting_bot`, `message`, and
+          #   `bucket` attach but are not yet searchable (Coming soon).
+          #
+          #   @return [Symbol, Telnyx::Models::AI::Collections::SourceType, nil]
+          optional :source_type, enum: -> { Telnyx::AI::Collections::SourceType }
+
+          # @!attribute status
+          #
+          #   @return [String, nil]
+          optional :status, String
+
+          # @!method initialize(id: nil, bucket_id: nil, collection_id: nil, record_type: nil, source_type: nil, status: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::AI::Collections::Source} for more details.
+          #
+          #   @param id [String]
+          #
+          #   @param bucket_id [String] The Telnyx Storage bucket name. Present only for `bucket` sources.
+          #
+          #   @param collection_id [String]
+          #
+          #   @param record_type [String] Identifies the record type. Always `ai_collection_source`.
+          #
+          #   @param source_type [Symbol, Telnyx::Models::AI::Collections::SourceType] The type of Telnyx data attached as a source. `bucket` requires an additional `b
+          #
+          #   @param status [String]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Collections
+        # @see Telnyx::Resources::AI::Collections::Sources#create
+        class SourceCreateParams < Telnyx::Models::AI::Collections::SourceRequest
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!attribute uuid
+          #
+          #   @return [String]
+          required :uuid, String
+
+          # @!method initialize(uuid:, request_options: {})
+          #   @param uuid [String]
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Collections
+        # @see Telnyx::Resources::AI::Collections::Sources#create
+        class SourceCreateResponse < Telnyx::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [Telnyx::Models::AI::Collections::Source, nil]
+          optional :data, -> { Telnyx::AI::Collections::Source }
+
+          # @!method initialize(data: nil)
+          #   Envelope containing a single collection source.
+          #
+          #   @param data [Telnyx::Models::AI::Collections::Source]
+        end
+      end
+    end
+  end
+end