telnyx 5.169.0 → 5.171.0

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

data/lib/telnyx/models/ai/memory/namespaces/profiles/memory_list_params.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          module Profiles
+            # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles::Memories#list
+            class MemoryListParams < 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 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
+
+              # @!attribute session_id
+              #   An ingested session, by the `session_id` it was ingested with. Narrows the
+              #   request to the source that session was stored as.
+              #
+              #   @return [String, nil]
+              optional :session_id, String, nil?: true
+
+              # @!attribute source_id
+              #   Narrows the listing to the memories extracted from one source, a remembered fact
+              #   as well as a session. Pass this or `session_id`, not both.
+              #
+              #   @return [String, nil]
+              optional :source_id, String, nil?: true
+
+              # @!method initialize(namespace:, profile_id:, page_number: nil, page_size: nil, session_id: nil, source_id: nil, request_options: {})
+              #   Some parameter documentations has been truncated, see
+              #   {Telnyx::Models::AI::Memory::Namespaces::Profiles::MemoryListParams} for more
+              #   details.
+              #
+              #   @param namespace [String]
+              #
+              #   @param profile_id [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 session_id [String, nil] An ingested session, by the `session_id` it was ingested with. Narrows the reque
+              #
+              #   @param source_id [String, nil] Narrows the listing to the memories extracted from one source, a remembered fact
+              #
+              #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profiles/memory_list_response.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          module Profiles
+            # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles::Memories#list
+            class MemoryListResponse < Telnyx::Internal::Type::BaseModel
+              # @!attribute id
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute source_id
+              #   The source this memory was extracted from. Set for a fact, which comes from
+              #   exactly one source; null for a memory derived from other memories. Read it with
+              #   `GET .../sources/{source_id}`. A source deleted a moment ago can still be named
+              #   here, and then answers 404.
+              #
+              #   @return [String, nil]
+              required :source_id, String, nil?: true
+
+              # @!attribute text
+              #
+              #   @return [String]
+              required :text, String
+
+              # @!attribute recorded_at
+              #
+              #   @return [String, nil]
+              optional :recorded_at, String, nil?: true
+
+              # @!method initialize(id:, source_id:, text:, recorded_at: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {Telnyx::Models::AI::Memory::Namespaces::Profiles::MemoryListResponse} for more
+              #   details.
+              #
+              #   @param id [String]
+              #
+              #   @param source_id [String, nil] The source this memory was extracted from. Set for a fact, which comes from exac
+              #
+              #   @param text [String]
+              #
+              #   @param recorded_at [String, nil]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_params.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          module Profiles
+            # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles::Memories#retrieve
+            class MemoryRetrieveParams < 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
+              #   The profile: your identifier for the user, caller or agent this memory is about.
+              #
+              #   @return [String]
+              required :profile_id, String
+
+              # @!attribute memory_id
+              #   A memory's id, as `recall` and the listing return it.
+              #
+              #   @return [String]
+              required :memory_id, String
+
+              # @!method initialize(namespace:, profile_id:, memory_id:, request_options: {})
+              #   Some parameter documentations has been truncated, see
+              #   {Telnyx::Models::AI::Memory::Namespaces::Profiles::MemoryRetrieveParams} for
+              #   more details.
+              #
+              #   @param namespace [String] The namespace. `default` exists for every organization.
+              #
+              #   @param profile_id [String] The profile: your identifier for the user, caller or agent this memory is about.
+              #
+              #   @param memory_id [String] A memory's id, as `recall` and the listing return it.
+              #
+              #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_response.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          module Profiles
+            # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles::Memories#retrieve
+            class MemoryRetrieveResponse < Telnyx::Internal::Type::BaseModel
+              # @!attribute data
+              #
+              #   @return [Telnyx::Models::AI::Memory::Namespaces::Profiles::MemoryRetrieveResponse::Data]
+              required :data, -> { Telnyx::Models::AI::Memory::Namespaces::Profiles::MemoryRetrieveResponse::Data }
+
+              # @!method initialize(data:)
+              #   @param data [Telnyx::Models::AI::Memory::Namespaces::Profiles::MemoryRetrieveResponse::Data]
+
+              # @see Telnyx::Models::AI::Memory::Namespaces::Profiles::MemoryRetrieveResponse#data
+              class Data < Telnyx::Internal::Type::BaseModel
+                # @!attribute id
+                #
+                #   @return [String]
+                required :id, String
+
+                # @!attribute derived_from
+                #   The ids of the memories this one was derived from. Read each with
+                #   `GET .../memories/{memory_id}` to reach its `source_id`. Set for a derived
+                #   memory; null for a fact.
+                #
+                #   @return [Array<String>, nil]
+                required :derived_from, Telnyx::Internal::Type::ArrayOf[String], nil?: true
+
+                # @!attribute source_id
+                #   The source this memory was extracted from. Set for a fact, which comes from
+                #   exactly one source; null for a memory derived from other memories. Read it with
+                #   `GET .../sources/{source_id}`. A source deleted a moment ago can still be named
+                #   here, and then answers 404.
+                #
+                #   @return [String, nil]
+                required :source_id, String, nil?: true
+
+                # @!attribute text
+                #
+                #   @return [String]
+                required :text, String
+
+                # @!attribute recorded_at
+                #
+                #   @return [String, nil]
+                optional :recorded_at, String, nil?: true
+
+                # @!method initialize(id:, derived_from:, source_id:, text:, recorded_at: nil)
+                #   Some parameter documentations has been truncated, see
+                #   {Telnyx::Models::AI::Memory::Namespaces::Profiles::MemoryRetrieveResponse::Data}
+                #   for more details.
+                #
+                #   @param id [String]
+                #
+                #   @param derived_from [Array<String>, nil] The ids of the memories this one was derived from. Read each with `GET .../memor
+                #
+                #   @param source_id [String, nil] The source this memory was extracted from. Set for a fact, which comes from exac
+                #
+                #   @param text [String]
+                #
+                #   @param recorded_at [String, nil]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profiles/source_delete_params.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          module Profiles
+            # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles::Sources#delete
+            class SourceDeleteParams < 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
+              #   The profile: your identifier for the user, caller or agent this memory is about.
+              #
+              #   @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(namespace:, profile_id:, source_id:, request_options: {})
+              #   Some parameter documentations has been truncated, see
+              #   {Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceDeleteParams} for more
+              #   details.
+              #
+              #   @param namespace [String] The namespace. `default` exists for every organization.
+              #
+              #   @param profile_id [String] The profile: your identifier for the user, caller or agent this memory is about.
+              #
+              #   @param source_id [String] Identifies one source within its profile: an ingested session, or one remembered
+              #
+              #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profiles/source_delete_response.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          module Profiles
+            # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles::Sources#delete
+            class SourceDeleteResponse < Telnyx::Internal::Type::BaseModel
+              # @!attribute data
+              #
+              #   @return [Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceDeleteResponse::Data]
+              required :data, -> { Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceDeleteResponse::Data }
+
+              # @!method initialize(data:)
+              #   @param data [Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceDeleteResponse::Data]
+
+              # @see Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceDeleteResponse#data
+              class Data < Telnyx::Internal::Type::BaseModel
+                # @!attribute memories_deleted
+                #   Memories the profile held and no longer does, counted before and after across
+                #   the whole profile: it includes memories derived from this source together with
+                #   others, and anything else the profile lost in between. A report rather than an
+                #   audit. The status carries the outcome.
+                #
+                #   @return [Integer]
+                required :memories_deleted, Integer
+
+                # @!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(memories_deleted:, profile_id:, source_id:)
+                #   Some parameter documentations has been truncated, see
+                #   {Telnyx::Models::AI::Memory::Namespaces::Profiles::SourceDeleteResponse::Data}
+                #   for more details.
+                #
+                #   @param memories_deleted [Integer] Memories the profile held and no longer does, counted before and after across th
+                #
+                #   @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
+end