telnyx 5.168.0 → 5.170.0

data/lib/telnyx/models/ai/memory/namespaces/page_meta.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          class PageMeta < Telnyx::Internal::Type::BaseModel
+            # @!attribute page_number
+            #   The page returned, counting from 1.
+            #
+            #   @return [Integer]
+            required :page_number, Integer
+
+            # @!attribute page_size
+            #   How many results a page holds.
+            #
+            #   @return [Integer]
+            required :page_size, Integer
+
+            # @!attribute total_pages
+            #   Pages that can be requested; 0 when nothing matched. Page until `page_number`
+            #   reaches it rather than until a page comes back short: a page can hold fewer than
+            #   `page_size` results without being the last. Capped at the deepest page served,
+            #   so on a very large listing it covers fewer results than `total_results`.
+            #
+            #   @return [Integer]
+            required :total_pages, Integer
+
+            # @!attribute total_results
+            #   Results the request matched, including any past the deepest page.
+            #
+            #   @return [Integer]
+            required :total_results, Integer
+
+            # @!method initialize(page_number:, page_size:, total_pages:, total_results:)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::Memory::Namespaces::PageMeta} for more details.
+            #
+            #   Where a listing's page sits in the whole.
+            #
+            #   A page is a snapshot: the counts it reports and the order it is drawn in both
+            #   move as writes land, so paging through a busy namespace can repeat or miss an
+            #   entry at a page boundary.
+            #
+            #   @param page_number [Integer] The page returned, counting from 1.
+            #
+            #   @param page_size [Integer] How many results a page holds.
+            #
+            #   @param total_pages [Integer] Pages that can be requested; 0 when nothing matched. Page until `page_number` re
+            #
+            #   @param total_results [Integer] Results the request matched, including any past the deepest page.
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profile_delete_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles#delete
+          class ProfileDeleteParams < Telnyx::Internal::Type::BaseModel
+            extend Telnyx::Internal::Type::RequestParameters::Converter
+            include Telnyx::Internal::Type::RequestParameters
+
+            # @!attribute namespace
+            #   The namespace. `default` exists for every organization.
+            #
+            #   @return [String]
+            required :namespace, String
+
+            # @!attribute profile_id
+            #
+            #   @return [String]
+            required :profile_id, String
+
+            # @!method initialize(namespace:, profile_id:, request_options: {})
+            #   @param namespace [String] The namespace. `default` exists for every organization.
+            #
+            #   @param profile_id [String]
+            #
+            #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profile_delete_response.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles#delete
+          class ProfileDeleteResponse < Telnyx::Internal::Type::BaseModel
+            # @!attribute data
+            #
+            #   @return [Telnyx::Models::AI::Memory::Namespaces::ProfileDeleteResponse::Data]
+            required :data, -> { Telnyx::Models::AI::Memory::Namespaces::ProfileDeleteResponse::Data }
+
+            # @!method initialize(data:)
+            #   @param data [Telnyx::Models::AI::Memory::Namespaces::ProfileDeleteResponse::Data]
+
+            # @see Telnyx::Models::AI::Memory::Namespaces::ProfileDeleteResponse#data
+            class Data < Telnyx::Internal::Type::BaseModel
+              # @!attribute memories_deleted
+              #   Memories the profile held and no longer does, counted before and after. A report
+              #   rather than an audit: memory moves in the background between the two counts. The
+              #   status carries the outcome.
+              #
+              #   @return [Integer]
+              required :memories_deleted, Integer
+
+              # @!attribute profile_id
+              #
+              #   @return [String]
+              required :profile_id, String
+
+              # @!method initialize(memories_deleted:, profile_id:)
+              #   Some parameter documentations has been truncated, see
+              #   {Telnyx::Models::AI::Memory::Namespaces::ProfileDeleteResponse::Data} for more
+              #   details.
+              #
+              #   @param memories_deleted [Integer] Memories the profile held and no longer does, counted before and after. A report
+              #
+              #   @param profile_id [String]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profile_ingest_params.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles#ingest
+          class ProfileIngestParams < Telnyx::Internal::Type::BaseModel
+            extend Telnyx::Internal::Type::RequestParameters::Converter
+            include Telnyx::Internal::Type::RequestParameters
+
+            # @!attribute namespace
+            #
+            #   @return [String]
+            required :namespace, String
+
+            # @!attribute profile_id
+            #
+            #   @return [String]
+            required :profile_id, String
+
+            # @!attribute body
+            #   The session's messages, in whatever shape your framework produces. Any JSON
+            #   value but null is accepted and stored whole, as long as it holds something to
+            #   remember: a body with no content anywhere in it -- `{}`, `[]`, `""`,
+            #   `{"messages": []}` -- is a 422.
+            #
+            #   @return [Hash{Symbol=>Object}, Array<Object>, String, Float, Boolean]
+            required :body, union: -> { Telnyx::AI::Memory::Namespaces::ProfileIngestParams::Body }
+
+            # @!attribute session_id
+            #   Names the session. Re-ingesting the same session replaces what it held and keeps
+            #   its `source_id`. Omit it to have one derived from the content and returned. No
+            #   whitespace, control characters, or any of / \ # ? %.
+            #
+            #   @return [String, nil]
+            optional :session_id, String, nil?: true
+
+            # @!method initialize(namespace:, profile_id:, body:, session_id: nil, request_options: {})
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::Memory::Namespaces::ProfileIngestParams} for more details.
+            #
+            #   @param namespace [String]
+            #
+            #   @param profile_id [String]
+            #
+            #   @param body [Hash{Symbol=>Object}, Array<Object>, String, Float, Boolean] The session's messages, in whatever shape your framework produces. Any JSON valu
+            #
+            #   @param session_id [String, nil] Names the session. Re-ingesting the same session replaces what it held and keeps
+            #
+            #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+            # The session's messages, in whatever shape your framework produces. Any JSON
+            # value but null is accepted and stored whole, as long as it holds something to
+            # remember: a body with no content anywhere in it -- `{}`, `[]`, `""`,
+            # `{"messages": []}` -- is a 422.
+            module Body
+              extend Telnyx::Internal::Type::Union
+
+              variant -> { Telnyx::Models::AI::Memory::Namespaces::ProfileIngestParams::Body::UnionMember0Map }
+
+              variant union: -> { Telnyx::AI::Memory::Namespaces::ProfileIngestParams::Body::UnionMember1 }
+
+              module UnionMember1
+                extend Telnyx::Internal::Type::Union
+
+                variant -> { Telnyx::Models::AI::Memory::Namespaces::ProfileIngestParams::Body::UnionMember1::UnionMember0Array }
+
+                variant String
+
+                variant Float
+
+                variant Telnyx::Internal::Type::Boolean
+
+                # @!method self.variants
+                #   @return [Array(Array<Object>, String, Float, Boolean)]
+
+                # @type [Telnyx::Internal::Type::Converter]
+                UnionMember0Array = Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::Unknown]
+              end
+
+              # @!method self.variants
+              #   @return [Array(Hash{Symbol=>Object}, Array<Object>, String, Float, Boolean)]
+
+              # @type [Telnyx::Internal::Type::Converter]
+              UnionMember0Map = Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profile_ingest_response.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles#ingest
+          class ProfileIngestResponse < Telnyx::Internal::Type::BaseModel
+            # @!attribute data
+            #
+            #   @return [Telnyx::Models::AI::Memory::Namespaces::ProfileIngestResponse::Data]
+            required :data, -> { Telnyx::Models::AI::Memory::Namespaces::ProfileIngestResponse::Data }
+
+            # @!method initialize(data:)
+            #   @param data [Telnyx::Models::AI::Memory::Namespaces::ProfileIngestResponse::Data]
+
+            # @see Telnyx::Models::AI::Memory::Namespaces::ProfileIngestResponse#data
+            class Data < Telnyx::Internal::Type::BaseModel
+              # @!attribute operation_id
+              #
+              #   @return [String]
+              required :operation_id, String
+
+              # @!attribute profile_id
+              #
+              #   @return [String]
+              required :profile_id, String
+
+              # @!attribute session_id
+              #
+              #   @return [String]
+              required :session_id, String
+
+              # @!attribute source_id
+              #   Identifies one source within its profile: an ingested session, or one remembered
+              #   fact. Returned by `ingest` and `remember` when the write is accepted.
+              #   Re-ingesting a session keeps its source id.
+              #
+              #   @return [String]
+              required :source_id, String
+
+              # @!method initialize(operation_id:, profile_id:, session_id:, source_id:)
+              #   Some parameter documentations has been truncated, see
+              #   {Telnyx::Models::AI::Memory::Namespaces::ProfileIngestResponse::Data} for more
+              #   details.
+              #
+              #   @param operation_id [String]
+              #
+              #   @param profile_id [String]
+              #
+              #   @param session_id [String]
+              #
+              #   @param source_id [String] Identifies one source within its profile: an ingested session, or one remembered
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profile_list_params.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles#list
+          class ProfileListParams < Telnyx::Internal::Type::BaseModel
+            extend Telnyx::Internal::Type::RequestParameters::Converter
+            include Telnyx::Internal::Type::RequestParameters
+
+            # @!attribute namespace
+            #
+            #   @return [String]
+            required :namespace, String
+
+            # @!attribute page_number
+            #   The page to return, counting from 1. Bounded in depth: (page[number] - 1) \*
+            #   page[size] may be at most 10000.
+            #
+            #   @return [Integer, nil]
+            optional :page_number, Integer
+
+            # @!attribute page_size
+            #   How many results a page holds.
+            #
+            #   @return [Integer, nil]
+            optional :page_size, Integer
+
+            # @!method initialize(namespace:, page_number: nil, page_size: nil, request_options: {})
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::Memory::Namespaces::ProfileListParams} for more details.
+            #
+            #   @param namespace [String]
+            #
+            #   @param page_number [Integer] The page to return, counting from 1. Bounded in depth: (page[number] - 1) \*
+            #   page
+            #
+            #   @param page_size [Integer] How many results a page holds.
+            #
+            #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profile_list_response.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles#list
+          class ProfileListResponse < Telnyx::Internal::Type::BaseModel
+            # @!attribute memory_count
+            #   Memories stored under this profile, including the consolidated ones that
+            #   paraphrase others. Listings are ordered by it.
+            #
+            #   @return [Integer]
+            required :memory_count, Integer
+
+            # @!attribute profile_id
+            #
+            #   @return [String]
+            required :profile_id, String
+
+            # @!method initialize(memory_count:, profile_id:)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::Memory::Namespaces::ProfileListResponse} for more details.
+            #
+            #   @param memory_count [Integer] Memories stored under this profile, including the consolidated ones that paraphr
+            #
+            #   @param profile_id [String]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profile_recall_params.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles#recall
+          class ProfileRecallParams < Telnyx::Internal::Type::BaseModel
+            extend Telnyx::Internal::Type::RequestParameters::Converter
+            include Telnyx::Internal::Type::RequestParameters
+
+            # @!attribute namespace
+            #
+            #   @return [String]
+            required :namespace, String
+
+            # @!attribute profile_id
+            #
+            #   @return [String]
+            required :profile_id, String
+
+            # @!attribute query
+            #
+            #   @return [String]
+            required :query, String
+
+            # @!attribute top_k
+            #
+            #   @return [Integer, nil]
+            optional :top_k, Integer, nil?: true
+
+            # @!method initialize(namespace:, profile_id:, query:, top_k: nil, request_options: {})
+            #   @param namespace [String]
+            #   @param profile_id [String]
+            #   @param query [String]
+            #   @param top_k [Integer, nil]
+            #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profile_recall_response.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles#recall
+          class ProfileRecallResponse < Telnyx::Internal::Type::BaseModel
+            # @!attribute data
+            #
+            #   @return [Array<Telnyx::Models::AI::Memory::Namespaces::ProfileRecallResponse::Data>]
+            required :data,
+                     -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::AI::Memory::Namespaces::ProfileRecallResponse::Data] }
+
+            # @!method initialize(data:)
+            #   @param data [Array<Telnyx::Models::AI::Memory::Namespaces::ProfileRecallResponse::Data>]
+
+            class Data < Telnyx::Internal::Type::BaseModel
+              # @!attribute id
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute text
+              #
+              #   @return [String]
+              required :text, String
+
+              # @!attribute recorded_at
+              #
+              #   @return [String, nil]
+              optional :recorded_at, String, nil?: true
+
+              # @!attribute score
+              #   Relevance, 0-1. Null where the deployment's reranker is a passthrough; results
+              #   are in rank order either way.
+              #
+              #   @return [Float, nil]
+              optional :score, Float, nil?: true
+
+              # @!method initialize(id:, text:, recorded_at: nil, score: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {Telnyx::Models::AI::Memory::Namespaces::ProfileRecallResponse::Data} for more
+              #   details.
+              #
+              #   @param id [String]
+              #
+              #   @param text [String]
+              #
+              #   @param recorded_at [String, nil]
+              #
+              #   @param score [Float, nil] Relevance, 0-1. Null where the deployment's reranker is a passthrough; results a
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profile_remember_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles#remember
+          class ProfileRememberParams < Telnyx::Internal::Type::BaseModel
+            extend Telnyx::Internal::Type::RequestParameters::Converter
+            include Telnyx::Internal::Type::RequestParameters
+
+            # @!attribute namespace
+            #
+            #   @return [String]
+            required :namespace, String
+
+            # @!attribute profile_id
+            #
+            #   @return [String]
+            required :profile_id, String
+
+            # @!attribute text
+            #
+            #   @return [String]
+            required :text, String
+
+            # @!method initialize(namespace:, profile_id:, text:, request_options: {})
+            #   @param namespace [String]
+            #   @param profile_id [String]
+            #   @param text [String]
+            #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profile_remember_response.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles#remember
+          class ProfileRememberResponse < Telnyx::Internal::Type::BaseModel
+            # @!attribute data
+            #
+            #   @return [Telnyx::Models::AI::Memory::Namespaces::ProfileRememberResponse::Data]
+            required :data, -> { Telnyx::Models::AI::Memory::Namespaces::ProfileRememberResponse::Data }
+
+            # @!method initialize(data:)
+            #   @param data [Telnyx::Models::AI::Memory::Namespaces::ProfileRememberResponse::Data]
+
+            # @see Telnyx::Models::AI::Memory::Namespaces::ProfileRememberResponse#data
+            class Data < Telnyx::Internal::Type::BaseModel
+              # @!attribute operation_id
+              #
+              #   @return [String]
+              required :operation_id, String
+
+              # @!attribute profile_id
+              #
+              #   @return [String]
+              required :profile_id, String
+
+              # @!attribute source_id
+              #   Identifies one source within its profile: an ingested session, or one remembered
+              #   fact. Returned by `ingest` and `remember` when the write is accepted.
+              #   Re-ingesting a session keeps its source id.
+              #
+              #   @return [String]
+              required :source_id, String
+
+              # @!method initialize(operation_id:, profile_id:, source_id:)
+              #   Some parameter documentations has been truncated, see
+              #   {Telnyx::Models::AI::Memory::Namespaces::ProfileRememberResponse::Data} for more
+              #   details.
+              #
+              #   @param operation_id [String]
+              #
+              #   @param profile_id [String]
+              #
+              #   @param source_id [String] Identifies one source within its profile: an ingested session, or one remembered
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles#retrieve_summary
+          class ProfileRetrieveSummaryParams < Telnyx::Internal::Type::BaseModel
+            extend Telnyx::Internal::Type::RequestParameters::Converter
+            include Telnyx::Internal::Type::RequestParameters
+
+            # @!attribute namespace
+            #   The namespace. `default` exists for every organization.
+            #
+            #   @return [String]
+            required :namespace, String
+
+            # @!attribute profile_id
+            #
+            #   @return [String]
+            required :profile_id, String
+
+            # @!method initialize(namespace:, profile_id:, request_options: {})
+            #   @param namespace [String] The namespace. `default` exists for every organization.
+            #
+            #   @param profile_id [String]
+            #
+            #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_response.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles#retrieve_summary
+          class ProfileRetrieveSummaryResponse < Telnyx::Internal::Type::BaseModel
+            # @!attribute data
+            #
+            #   @return [Telnyx::Models::AI::Memory::Namespaces::ProfileRetrieveSummaryResponse::Data]
+            required :data, -> { Telnyx::Models::AI::Memory::Namespaces::ProfileRetrieveSummaryResponse::Data }
+
+            # @!method initialize(data:)
+            #   @param data [Telnyx::Models::AI::Memory::Namespaces::ProfileRetrieveSummaryResponse::Data]
+
+            # @see Telnyx::Models::AI::Memory::Namespaces::ProfileRetrieveSummaryResponse#data
+            class Data < Telnyx::Internal::Type::BaseModel
+              # @!attribute is_stale
+              #   Whether newer memories have arrived since the summary was generated. The summary
+              #   is regenerated in the background, so a true here is ordinary and the summary is
+              #   still usable.
+              #
+              #   @return [Boolean]
+              required :is_stale, Telnyx::Internal::Type::Boolean
+
+              # @!attribute profile_id
+              #
+              #   @return [String]
+              required :profile_id, String
+
+              # @!attribute generated_at
+              #   When the summary was last generated. Null while none is ready.
+              #
+              #   @return [String, nil]
+              optional :generated_at, String, nil?: true
+
+              # @!attribute text
+              #   The precomputed summary, ready to place in an assistant's context at the start
+              #   of a session.
+              #
+              #   @return [String, nil]
+              optional :text, String, nil?: true
+
+              # @!method initialize(is_stale:, profile_id:, generated_at: nil, text: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {Telnyx::Models::AI::Memory::Namespaces::ProfileRetrieveSummaryResponse::Data}
+              #   for more details.
+              #
+              #   @param is_stale [Boolean] Whether newer memories have arrived since the summary was generated. The summary
+              #
+              #   @param profile_id [String]
+              #
+              #   @param generated_at [String, nil] When the summary was last generated. Null while none is ready.
+              #
+              #   @param text [String, nil] The precomputed summary, ready to place in an assistant's context at the start o
+            end
+          end
+        end
+      end
+    end
+  end
+end