telnyx 5.169.0 → 5.171.0

data/rbi/telnyx/resources/ai/memory/namespaces/profiles.rbi

@@ -0,0 +1,231 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class AI
+      class Memory
+        class Namespaces
+          class Profiles
+            # What a namespace and a profile hold.
+            sig do
+              returns(
+                Telnyx::Resources::AI::Memory::Namespaces::Profiles::Memories
+              )
+            end
+            attr_reader :memories
+
+            # What a profile stored, and what its memories came from.
+            sig do
+              returns(
+                Telnyx::Resources::AI::Memory::Namespaces::Profiles::Sources
+              )
+            end
+            attr_reader :sources
+
+            # Profiles are never created, only written to, so this lists the ones that hold a
+            # memory. A profile whose first ingest is still running is not here yet. Ordered
+            # by memory count, largest first, so a profile written to while the listing is
+            # paged can move between pages and be repeated or missed.
+            sig do
+              params(
+                namespace: String,
+                page_number: Integer,
+                page_size: Integer,
+                request_options: Telnyx::RequestOptions::OrHash
+              ).returns(
+                Telnyx::Internal::DefaultFlatPagination[
+                  Telnyx::Models::AI::Memory::Namespaces::ProfileListResponse
+                ]
+              )
+            end
+            def list(
+              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
+
+            # Delete everything held about one profile. A 2xx means none of its memories are
+            # left, and its summary goes with them. There is no undo.
+            sig do
+              params(
+                profile_id: String,
+                namespace: String,
+                request_options: Telnyx::RequestOptions::OrHash
+              ).returns(
+                Telnyx::Models::AI::Memory::Namespaces::ProfileDeleteResponse
+              )
+            end
+            def delete(
+              # The profile: your identifier for the user, caller or agent this memory is about.
+              profile_id,
+              # The namespace. `default` exists for every organization.
+              namespace:,
+              request_options: {}
+            )
+            end
+
+            # Store a session. Facts are extracted from whatever you send — the body is taken
+            # as any JSON value and stored whole, so a framework's own transcript shape works
+            # unchanged. `messages` of `role`/`content` is the conventional shape, not a
+            # requirement. An empty object or a null body is refused. Carry a `session_id` to
+            # name the session: re-ingesting the same one replaces what it held. Omit it and a
+            # session is opened and returned. Extraction runs asynchronously — poll the
+            # returned operation.
+            sig do
+              params(
+                profile_id: String,
+                namespace: String,
+                body:
+                  Telnyx::AI::Memory::Namespaces::ProfileIngestParams::Body::Variants,
+                session_id: T.nilable(String),
+                request_options: Telnyx::RequestOptions::OrHash
+              ).returns(
+                Telnyx::Models::AI::Memory::Namespaces::ProfileIngestResponse
+              )
+            end
+            def ingest(
+              # Path param
+              profile_id,
+              # Path param
+              namespace:,
+              # Body param: 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:,
+              # Query param: 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
+
+            # Try a candidate note on one profile and see how that profile's summary would
+            # read under it, without saving the note and without touching the stored summary.
+            # Composes the same source query the apply path
+            # (`PATCH /ai/memory/namespaces/{namespace}/settings`) would use, so a preview
+            # cannot drift from what saving the note would produce. Reads the candidate alone
+            # -- the namespace's current instructions and the profile's stored summary are
+            # neither read nor replaced. Bounded at 120 seconds: the summary is generated on
+            # the spot rather than read from a stored one. Nothing about the request is
+            # stored.
+            sig do
+              params(
+                profile_id: String,
+                namespace: String,
+                instructions: T.nilable(String),
+                request_options: Telnyx::RequestOptions::OrHash
+              ).returns(
+                Telnyx::Models::AI::Memory::Namespaces::ProfilePreviewResponse
+              )
+            end
+            def preview(
+              # Path param: The profile: your identifier for the user, caller or agent this
+              # memory is about.
+              profile_id,
+              # Path param: The namespace. `default` exists for every organization.
+              namespace:,
+              # Body param: The candidate note to try. `null`, empty, or whitespace-only
+              # previews the neutral default -- the summary a profile returns to when
+              # instructions are cleared. Capped at 2000 characters, the same cap
+              # `PATCH /settings` applies on save; a longer note is refused with `422` before
+              # anything is generated.
+              instructions: nil,
+              request_options: {}
+            )
+            end
+
+            # Ranked memories for a question. Matching runs over the profile's memories and
+            # returns them in rank order with a relevance `score`; the score is null where the
+            # deployment's reranker is a passthrough, in which case order is the only signal.
+            # No model runs in this path — recall returns facts, it does not compose an
+            # answer.
+            sig do
+              params(
+                profile_id: String,
+                namespace: String,
+                query: String,
+                top_k: T.nilable(Integer),
+                request_options: Telnyx::RequestOptions::OrHash
+              ).returns(
+                Telnyx::Models::AI::Memory::Namespaces::ProfileRecallResponse
+              )
+            end
+            def recall(
+              # Path param
+              profile_id,
+              # Path param
+              namespace:,
+              # Body param
+              query:,
+              # Body param
+              top_k: nil,
+              request_options: {}
+            )
+            end
+
+            # For a fact the agent has already distilled: `text` is stored as given, with
+            # nothing extracted from it. Send a transcript to `ingest` instead. Remembering
+            # the same text again writes the same memory rather than a second copy of it, so a
+            # retry is safe. The write runs asynchronously -- poll the returned operation.
+            sig do
+              params(
+                profile_id: String,
+                namespace: String,
+                text: String,
+                request_options: Telnyx::RequestOptions::OrHash
+              ).returns(
+                Telnyx::Models::AI::Memory::Namespaces::ProfileRememberResponse
+              )
+            end
+            def remember(
+              # Path param
+              profile_id,
+              # Path param
+              namespace:,
+              # Body param
+              text:,
+              request_options: {}
+            )
+            end
+
+            # The whole profile as one card, precomputed, with no query. Built for the start
+            # of a session, where there is no question to ask yet.
+            #
+            # A summary is generated in the background. `is_stale` tells you newer memories
+            # have arrived since it was written; that is ordinary and the card is still
+            # usable.
+            sig do
+              params(
+                profile_id: String,
+                namespace: String,
+                request_options: Telnyx::RequestOptions::OrHash
+              ).returns(
+                Telnyx::Models::AI::Memory::Namespaces::ProfileRetrieveSummaryResponse
+              )
+            end
+            def retrieve_summary(
+              # The profile: your identifier for the user, caller or agent this memory is about.
+              profile_id,
+              # The namespace. `default` exists for every organization.
+              namespace:,
+              request_options: {}
+            )
+            end
+
+            # @api private
+            sig { params(client: Telnyx::Client).returns(T.attached_class) }
+            def self.new(client:)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/ai/memory/namespaces/settings.rbi

@@ -0,0 +1,67 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class AI
+      class Memory
+        class Namespaces
+          # How a namespace's summaries are written.
+          class Settings
+            # What is currently set for this namespace. `instructions: null` means none are
+            # set and summaries use the neutral default.
+            sig do
+              params(
+                namespace: String,
+                request_options: Telnyx::RequestOptions::OrHash
+              ).returns(
+                Telnyx::AI::Memory::Namespaces::NamespaceSettingsResponse
+              )
+            end
+            def list(
+              # The namespace. `default` exists for every organization.
+              namespace,
+              request_options: {}
+            )
+            end
+
+            # Only the fields you send are changed; anything omitted is left as it is, so `{}`
+            # changes nothing. Sending `instructions: null`, or an empty or whitespace-only
+            # string, clears them and returns summaries to the neutral default.
+            #
+            # Instructions are capped at 2000 characters. A longer note is refused rather than
+            # truncated, because a note cut mid-sentence is a worse steer than none. A change
+            # reaches each summary the next time that summary is regenerated, not immediately.
+            sig do
+              params(
+                namespace: String,
+                summary:
+                  T.nilable(
+                    Telnyx::AI::Memory::Namespaces::SettingPatchAllParams::Summary::OrHash
+                  ),
+                request_options: Telnyx::RequestOptions::OrHash
+              ).returns(
+                Telnyx::AI::Memory::Namespaces::NamespaceSettingsResponse
+              )
+            end
+            def patch_all(
+              # The namespace. `default` exists for every organization.
+              namespace,
+              # A partial update to a namespace's summary settings.
+              #
+              # Only the fields present in the request are changed; the rest are left as they
+              # are. Sending `instructions: null` (or empty) clears the instructions.
+              summary: nil,
+              request_options: {}
+            )
+            end
+
+            # @api private
+            sig { params(client: Telnyx::Client).returns(T.attached_class) }
+            def self.new(client:)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/ai/memory/namespaces.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class AI
+      class Memory
+        class Namespaces
+          sig { returns(Telnyx::Resources::AI::Memory::Namespaces::Profiles) }
+          attr_reader :profiles
+
+          # How a namespace's summaries are written.
+          sig { returns(Telnyx::Resources::AI::Memory::Namespaces::Settings) }
+          attr_reader :settings
+
+          # Create a namespace. An organization can have at most five, `default` among them
+          # — a sixth returns `403`.
+          sig do
+            params(
+              name: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(Telnyx::Models::AI::Memory::NamespaceCreateResponse)
+          end
+          def create(
+            # A name for the new namespace, unique within your organization.
+            name:,
+            request_options: {}
+          )
+          end
+
+          # Whether a write has finished. Both `ingest` and `remember` return an
+          # `operation_id`, and a memory is not recallable until its operation completes —
+          # extraction, embedding and consolidation all run first.
+          sig do
+            params(
+              operation_id: String,
+              namespace: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(Telnyx::Models::AI::Memory::NamespaceRetrieveResponse)
+          end
+          def retrieve(operation_id, namespace:, request_options: {})
+          end
+
+          # Every namespace in your organization, `default` among them.
+          sig do
+            params(request_options: Telnyx::RequestOptions::OrHash).returns(
+              Telnyx::Models::AI::Memory::NamespaceListResponse
+            )
+          end
+          def list(request_options: {})
+          end
+
+          # Delete a namespace and every profile and memory in it. `default` cannot be
+          # deleted. This cannot be undone.
+          sig do
+            params(
+              namespace: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).void
+          end
+          def delete(
+            # The namespace to delete. `default` cannot be deleted.
+            namespace,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: Telnyx::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/ai/memory.rbi

@@ -0,0 +1,17 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class AI
+      class Memory
+        sig { returns(Telnyx::Resources::AI::Memory::Namespaces) }
+        attr_reader :namespaces
+
+        # @api private
+        sig { params(client: Telnyx::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/ai/openai/chat.rbi

@@ -20,7 +20,7 @@ module Telnyx
               frequency_penalty: Float,
               length_penalty: Float,
               logprobs: T::Boolean,
-              max_tokens: Integer,
+              max_tokens: T.nilable(Integer),
               min_p: Float,
               mode: Telnyx::AI::ChatCompletionRequest::Mode::OrSymbol,
               model: String,
@@ -82,7 +82,26 @@ module Telnyx
             # returns the log probabilities of each output token returned in the `content` of
             # `message`.
             logprobs: nil,
-            # Maximum number of completion tokens the model should generate.
+            # Maximum number of completion (output) tokens, including reasoning and answer
+            # tokens combined. An omitted or null limit defaults to 8192 unless the model is
+            # excluded from that default; excluded models leave the limit to the serving
+            # engine. Explicit values and applied defaults are clamped to the model's
+            # max_completion_tokens metadata when that ceiling is set (see GET
+            # /v2/ai/openai/models). An omitted limit on an excluded model remains unset even
+            # when metadata declares a ceiling. Input and output together must fit the model's
+            # context window. Set an explicit limit when a bounded generation budget is
+            # required. For current Telnyx-hosted models, omitted or null limits default to
+            # 8192 for `zai-org/GLM-5.3`, `zai-org/GLM-5.3-Flash` and
+            # `deepseek-ai/DeepSeek-V4.1-Flash`. The hosted exclusions are
+            # `moonshotai/Kimi-K3`, `moonshotai/Kimi-K2.6`, `moonshotai/Kimi-K2.5`,
+            # `zai-org/GLM-5.2`, `zai-org/GLM-5.1-FP8`, `MiniMaxAI/MiniMax-M3-MXFP8`,
+            # `MiniMaxAI/MiniMax-M2.7`, `Qwen/Qwen3.8-27B`, `Qwen/Qwen3-235B-A22B`,
+            # `deepseek-ai/DeepSeek-V4-Flash-0731`, `meta-llama/Llama-3.3-70B-Instruct`,
+            # `meta-llama/Meta-Llama-3.1-70B-Instruct`,
+            # `meta-llama/Meta-Llama-3.1-8B-Instruct` and `google/gemma-2b-it`. Legacy
+            # external and fine-tuned model IDs can also bypass the default; model discovery
+            # reports completion ceilings, not whether this default applies. Set an explicit
+            # limit for predictable behavior across models.
             max_tokens: nil,
             # This is an alternative to `top_p` that
             # [many prefer](https://github.com/huggingface/transformers/issues/27670). Must be

data/rbi/telnyx/resources/ai/tools.rbi

@@ -144,7 +144,7 @@ module Telnyx
           params(
             tool_id: String,
             request_options: Telnyx::RequestOptions::OrHash
-          ).returns(T.anything)
+          ).void
         end
         def delete(
           # Unique identifier of the tool.

data/rbi/telnyx/resources/ai/typesafe/v1.rbi

@@ -5,27 +5,31 @@ module Telnyx
     class AI
       class Typesafe
         # Beta API for evaluating shared context with typed questions and structured
-        # answers. Telnyx manages model selection.
+        # answers using Flash or Pro.
         class V1
-          # **Beta API.** Telnyx controls model selection.
+          # **Beta API.** Choose telnyx/decision-flash for the lowest cost and latency, or
+          # telnyx/decision-pro for decisions that require long context, including inputs
+          # beyond Jev’s 32k per-decision limit. Omitted model defaults to
+          # telnyx/decision-flash.
           #
           # Evaluate shared context using named choice, noul (yes/no), and score questions.
-          # Returns TypeSafe System One-compatible answer shapes, an opaque compatibility
-          # identifier, and token usage. See the
+          # Returns TypeSafe System One-compatible answer shapes, the selected public model
+          # alias, and token usage. See the
           # [decision model guide](https://developers.telnyx.com/docs/inference/decision-models)
           # for examples and compatibility limits.
           #
           # The supported request subset requires instructions for every question, string
           # descriptions for criteria (or null for choice descriptions), 1–64 questions, and
-          # 2–64 options for choice and score questions. The SDK-supplied model value is
-          # ignored and cannot select a model. Other unknown fields are rejected. The
-          # endpoint is synchronous and does not stream.
+          # 2–64 options for choice and score questions. The model field accepts only
+          # telnyx/decision-flash or telnyx/decision-pro. Unsupported model values and
+          # unknown fields are rejected. The endpoint is synchronous and does not stream.
           #
           # Use the TypeSafe Python SDK with base_url set to
           # https://api.telnyx.com/v2/ai/typesafe and a Telnyx API key. The SDK appends
-          # /v1/systemone. Compatibility covers this operation and the documented request
-          # subset; it does not include TypeSafe model listing. Scores describe relative
-          # preference, not calibrated correctness.
+          # /v1/systemone; explicitly set model to a supported Telnyx alias because its own
+          # default model is not supported. Compatibility covers this operation and the
+          # documented request subset; it does not include TypeSafe model listing. Scores
+          # describe relative preference, not calibrated correctness.
           sig do
             params(
               questions:
@@ -38,6 +42,7 @@ module Telnyx
                   )
                 ],
               state: Telnyx::AI::Typesafe::V1SystemoneParams::State::Variants,
+              model: Telnyx::AI::Typesafe::V1SystemoneParams::Model::OrSymbol,
               request_options: Telnyx::RequestOptions::OrHash
             ).returns(Telnyx::Models::AI::Typesafe::V1SystemoneResponse)
           end
@@ -46,6 +51,11 @@ module Telnyx
             questions:,
             # Shared context evaluated by every question.
             state:,
+            # Public model alias. telnyx/decision-flash offers the lowest cost and latency;
+            # telnyx/decision-pro supports decisions that require long context, including
+            # inputs beyond Jev’s 32k per-decision limit. Applies to every question in the
+            # request. Other values are rejected.
+            model: nil,
             request_options: {}
           )
           end

data/rbi/telnyx/resources/ai/typesafe.rbi

@@ -5,7 +5,7 @@ module Telnyx
     class AI
       class Typesafe
         # Beta API for evaluating shared context with typed questions and structured
-        # answers. Telnyx manages model selection.
+        # answers using Flash or Pro.
         sig { returns(Telnyx::Resources::AI::Typesafe::V1) }
         attr_reader :v1
 

data/rbi/telnyx/resources/ai.rbi

@@ -58,6 +58,9 @@ module Telnyx
       sig { returns(Telnyx::Resources::AI::Typesafe) }
       attr_reader :typesafe
 
+      sig { returns(Telnyx::Resources::AI::Memory) }
+      attr_reader :memory
+
       # Performs semantic vector search across conversation history records.
       #
       # **How it works:**