telnyx 5.169.0 → 5.170.0

data/rbi/telnyx/models/ai/memory/namespaces/profile_ingest_params.rbi

@@ -0,0 +1,149 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          class ProfileIngestParams < Telnyx::Internal::Type::BaseModel
+            extend Telnyx::Internal::Type::RequestParameters::Converter
+            include Telnyx::Internal::Type::RequestParameters
+
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::AI::Memory::Namespaces::ProfileIngestParams,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            sig { returns(String) }
+            attr_accessor :namespace
+
+            sig { returns(String) }
+            attr_accessor :profile_id
+
+            # 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.
+            sig do
+              returns(
+                Telnyx::AI::Memory::Namespaces::ProfileIngestParams::Body::Variants
+              )
+            end
+            attr_accessor :body
+
+            # 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 / \ # ? %.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :session_id
+
+            sig do
+              params(
+                namespace: String,
+                profile_id: String,
+                body:
+                  Telnyx::AI::Memory::Namespaces::ProfileIngestParams::Body::Variants,
+                session_id: T.nilable(String),
+                request_options: Telnyx::RequestOptions::OrHash
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              namespace:,
+              profile_id:,
+              # 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.
+              body:,
+              # 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 / \ # ? %.
+              session_id: nil,
+              request_options: {}
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  namespace: String,
+                  profile_id: String,
+                  body:
+                    Telnyx::AI::Memory::Namespaces::ProfileIngestParams::Body::Variants,
+                  session_id: T.nilable(String),
+                  request_options: Telnyx::RequestOptions
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # 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
+
+              Variants =
+                T.type_alias do
+                  T.any(
+                    T::Hash[Symbol, T.anything],
+                    Telnyx::AI::Memory::Namespaces::ProfileIngestParams::Body::UnionMember1::Variants
+                  )
+                end
+
+              module UnionMember1
+                extend Telnyx::Internal::Type::Union
+
+                Variants =
+                  T.type_alias do
+                    T.any(T::Array[T.anything], String, Float, T::Boolean)
+                  end
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      Telnyx::AI::Memory::Namespaces::ProfileIngestParams::Body::UnionMember1::Variants
+                    ]
+                  )
+                end
+                def self.variants
+                end
+
+                UnionMember0Array =
+                  T.let(
+                    Telnyx::Internal::Type::ArrayOf[
+                      Telnyx::Internal::Type::Unknown
+                    ],
+                    Telnyx::Internal::Type::Converter
+                  )
+              end
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Telnyx::AI::Memory::Namespaces::ProfileIngestParams::Body::Variants
+                  ]
+                )
+              end
+              def self.variants
+              end
+
+              UnionMember0Map =
+                T.let(
+                  Telnyx::Internal::Type::HashOf[
+                    Telnyx::Internal::Type::Unknown
+                  ],
+                  Telnyx::Internal::Type::Converter
+                )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/memory/namespaces/profile_ingest_response.rbi

@@ -0,0 +1,113 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          class ProfileIngestResponse < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::AI::Memory::Namespaces::ProfileIngestResponse,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            sig do
+              returns(
+                Telnyx::Models::AI::Memory::Namespaces::ProfileIngestResponse::Data
+              )
+            end
+            attr_reader :data
+
+            sig do
+              params(
+                data:
+                  Telnyx::Models::AI::Memory::Namespaces::ProfileIngestResponse::Data::OrHash
+              ).void
+            end
+            attr_writer :data
+
+            sig do
+              params(
+                data:
+                  Telnyx::Models::AI::Memory::Namespaces::ProfileIngestResponse::Data::OrHash
+              ).returns(T.attached_class)
+            end
+            def self.new(data:)
+            end
+
+            sig do
+              override.returns(
+                {
+                  data:
+                    Telnyx::Models::AI::Memory::Namespaces::ProfileIngestResponse::Data
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class Data < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::Models::AI::Memory::Namespaces::ProfileIngestResponse::Data,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(String) }
+              attr_accessor :operation_id
+
+              sig { returns(String) }
+              attr_accessor :profile_id
+
+              sig { returns(String) }
+              attr_accessor :session_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.
+              sig { returns(String) }
+              attr_accessor :source_id
+
+              sig do
+                params(
+                  operation_id: String,
+                  profile_id: String,
+                  session_id: String,
+                  source_id: String
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                operation_id:,
+                profile_id:,
+                session_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.
+                source_id:
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    operation_id: String,
+                    profile_id: String,
+                    session_id: String,
+                    source_id: String
+                  }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/memory/namespaces/profile_list_params.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          class ProfileListParams < Telnyx::Internal::Type::BaseModel
+            extend Telnyx::Internal::Type::RequestParameters::Converter
+            include Telnyx::Internal::Type::RequestParameters
+
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::AI::Memory::Namespaces::ProfileListParams,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            sig { returns(String) }
+            attr_accessor :namespace
+
+            # The page to return, counting from 1. Bounded in depth: (page[number] - 1) \*
+            # page[size] may be at most 10000.
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :page_number
+
+            sig { params(page_number: Integer).void }
+            attr_writer :page_number
+
+            # How many results a page holds.
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :page_size
+
+            sig { params(page_size: Integer).void }
+            attr_writer :page_size
+
+            sig do
+              params(
+                namespace: String,
+                page_number: Integer,
+                page_size: Integer,
+                request_options: Telnyx::RequestOptions::OrHash
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              namespace:,
+              # The page to return, counting from 1. Bounded in depth: (page[number] - 1) \*
+              # page[size] may be at most 10000.
+              page_number: nil,
+              # How many results a page holds.
+              page_size: nil,
+              request_options: {}
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  namespace: String,
+                  page_number: Integer,
+                  page_size: Integer,
+                  request_options: Telnyx::RequestOptions
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/memory/namespaces/profile_list_response.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          class ProfileListResponse < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::AI::Memory::Namespaces::ProfileListResponse,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # Memories stored under this profile, including the consolidated ones that
+            # paraphrase others. Listings are ordered by it.
+            sig { returns(Integer) }
+            attr_accessor :memory_count
+
+            sig { returns(String) }
+            attr_accessor :profile_id
+
+            sig do
+              params(memory_count: Integer, profile_id: String).returns(
+                T.attached_class
+              )
+            end
+            def self.new(
+              # Memories stored under this profile, including the consolidated ones that
+              # paraphrase others. Listings are ordered by it.
+              memory_count:,
+              profile_id:
+            )
+            end
+
+            sig do
+              override.returns({ memory_count: Integer, profile_id: String })
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/memory/namespaces/profile_recall_params.rbi

@@ -0,0 +1,68 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          class ProfileRecallParams < Telnyx::Internal::Type::BaseModel
+            extend Telnyx::Internal::Type::RequestParameters::Converter
+            include Telnyx::Internal::Type::RequestParameters
+
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::AI::Memory::Namespaces::ProfileRecallParams,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            sig { returns(String) }
+            attr_accessor :namespace
+
+            sig { returns(String) }
+            attr_accessor :profile_id
+
+            sig { returns(String) }
+            attr_accessor :query
+
+            sig { returns(T.nilable(Integer)) }
+            attr_accessor :top_k
+
+            sig do
+              params(
+                namespace: String,
+                profile_id: String,
+                query: String,
+                top_k: T.nilable(Integer),
+                request_options: Telnyx::RequestOptions::OrHash
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              namespace:,
+              profile_id:,
+              query:,
+              top_k: nil,
+              request_options: {}
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  namespace: String,
+                  profile_id: String,
+                  query: String,
+                  top_k: T.nilable(Integer),
+                  request_options: Telnyx::RequestOptions
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/memory/namespaces/profile_recall_response.rbi

@@ -0,0 +1,109 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          class ProfileRecallResponse < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::AI::Memory::Namespaces::ProfileRecallResponse,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            sig do
+              returns(
+                T::Array[
+                  Telnyx::Models::AI::Memory::Namespaces::ProfileRecallResponse::Data
+                ]
+              )
+            end
+            attr_accessor :data
+
+            sig do
+              params(
+                data:
+                  T::Array[
+                    Telnyx::Models::AI::Memory::Namespaces::ProfileRecallResponse::Data::OrHash
+                  ]
+              ).returns(T.attached_class)
+            end
+            def self.new(data:)
+            end
+
+            sig do
+              override.returns(
+                {
+                  data:
+                    T::Array[
+                      Telnyx::Models::AI::Memory::Namespaces::ProfileRecallResponse::Data
+                    ]
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class Data < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::Models::AI::Memory::Namespaces::ProfileRecallResponse::Data,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(String) }
+              attr_accessor :id
+
+              sig { returns(String) }
+              attr_accessor :text
+
+              sig { returns(T.nilable(String)) }
+              attr_accessor :recorded_at
+
+              # Relevance, 0-1. Null where the deployment's reranker is a passthrough; results
+              # are in rank order either way.
+              sig { returns(T.nilable(Float)) }
+              attr_accessor :score
+
+              sig do
+                params(
+                  id: String,
+                  text: String,
+                  recorded_at: T.nilable(String),
+                  score: T.nilable(Float)
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                id:,
+                text:,
+                recorded_at: nil,
+                # Relevance, 0-1. Null where the deployment's reranker is a passthrough; results
+                # are in rank order either way.
+                score: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    id: String,
+                    text: String,
+                    recorded_at: T.nilable(String),
+                    score: T.nilable(Float)
+                  }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/memory/namespaces/profile_remember_params.rbi

@@ -0,0 +1,57 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          class ProfileRememberParams < Telnyx::Internal::Type::BaseModel
+            extend Telnyx::Internal::Type::RequestParameters::Converter
+            include Telnyx::Internal::Type::RequestParameters
+
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::AI::Memory::Namespaces::ProfileRememberParams,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            sig { returns(String) }
+            attr_accessor :namespace
+
+            sig { returns(String) }
+            attr_accessor :profile_id
+
+            sig { returns(String) }
+            attr_accessor :text
+
+            sig do
+              params(
+                namespace: String,
+                profile_id: String,
+                text: String,
+                request_options: Telnyx::RequestOptions::OrHash
+              ).returns(T.attached_class)
+            end
+            def self.new(namespace:, profile_id:, text:, request_options: {})
+            end
+
+            sig do
+              override.returns(
+                {
+                  namespace: String,
+                  profile_id: String,
+                  text: String,
+                  request_options: Telnyx::RequestOptions
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end