telnyx 5.170.0 → 5.171.0

data/lib/telnyx/models/llm_token_gateway/token_group.rb

@@ -0,0 +1,413 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module LlmTokenGateway
+      # @see Telnyx::Resources::LlmTokenGateway::TokenGroups#list
+      class TokenGroup < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute allowed_models
+        #
+        #   @return [Array<String>]
+        required :allowed_models, Telnyx::Internal::Type::ArrayOf[String]
+
+        # @!attribute blocked
+        #
+        #   @return [Boolean]
+        required :blocked, Telnyx::Internal::Type::Boolean
+
+        # @!attribute budget_duration
+        #
+        #   @return [Symbol, Telnyx::Models::LlmTokenGateway::BudgetDuration, nil]
+        required :budget_duration, enum: -> { Telnyx::LlmTokenGateway::BudgetDuration }, nil?: true
+
+        # @!attribute budget_started_at
+        #
+        #   @return [Time, nil]
+        required :budget_started_at, Time, nil?: true
+
+        # @!attribute cache_ttl
+        #
+        #   @return [Integer, nil]
+        required :cache_ttl, Integer, nil?: true
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute fallbacks
+        #   Per-group model fallbacks: primary alias -> ordered list of 1..3 other aliases.
+        #   Every key and listed alias must be in allowed_models (a PATCH removing a
+        #   referenced alias is 400); a chain never lists its own key; wildcards are
+        #   rejected. Chains are one level deep (a step's own chain is not expanded).
+        #   Fallback is attempted only for managed routes, only before the first provider
+        #   event is forwarded, and only to steps the key may use; each attempt is reserved
+        #   and recorded. {} and null both disable fallbacks.
+        #
+        #   @return [Hash{Symbol=>Array<String>}, nil]
+        required :fallbacks,
+                 Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::ArrayOf[String]],
+                 nil?: true
+
+        # @!attribute guardrails
+        #   Per-group guardrail policy. Missing actions default to ignore. profiles may be
+        #   listed with both dlp actions ignore (staged, inactive) but a non-ignore dlp
+        #   action requires at least one profile. streaming defaults to buffered when any
+        #   response action is block and passthrough otherwise; passthrough with a response
+        #   block is 400. Findings are codes and counts only; content is never stored. The
+        #   stored form is echoed back canonicalised (all actions explicit, profiles
+        #   sorted); {} is stored as an all-ignore policy, null disables.
+        #
+        #   @return [Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails, nil]
+        required :guardrails, -> { Telnyx::LlmTokenGateway::TokenGroup::Guardrails }, nil?: true
+
+        # @!attribute max_budget
+        #   USD, decimal precision at most 6 places; parse exactly to integer micro-USD,
+        #   never binary float accounting.
+        #
+        #   @return [Float, nil]
+        required :max_budget, Float, nil?: true
+
+        # @!attribute name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute provider_key_ids
+        #
+        #   @return [Array<String>]
+        required :provider_key_ids, Telnyx::Internal::Type::ArrayOf[String]
+
+        # @!attribute record_type
+        #
+        #   @return [Symbol, :token_group]
+        required :record_type, const: :token_group
+
+        # @!attribute reserved_spend
+        #   USD, decimal precision at most 6 places; parse exactly to integer micro-USD,
+        #   never binary float accounting.
+        #
+        #   @return [Float]
+        required :reserved_spend, Float
+
+        # @!attribute resets_at
+        #
+        #   @return [Time, nil]
+        required :resets_at, Time, nil?: true
+
+        # @!attribute retries
+        #   Per-group same-route retries. max_attempts counts the first try of each step
+        #   (the primary and each fallback) and is the ceiling for the x-ltg-max-attempts
+        #   request header. A step is retried only when its attempt definitely did no
+        #   provider work (connection failure before dispatch, or 429/529) before the first
+        #   provider event; an uncertain failure (timeout, 408/500/502/503/504) moves to the
+        #   next fallback step instead. max_attempts x (1 + the longest fallback chain) must
+        #   not exceed 8, else 400. The n-th retry waits retry_delay_ms (constant),
+        #   retry_delay_ms*n (linear) or retry_delay_ms*2^(n-1) (exponential), at most 5 s
+        #   and never past the request deadline, then jittered uniformly down to half that
+        #   value so concurrent retries spread out; a provider Retry-After of at most 5 s is
+        #   honoured and a longer one moves to the next step. request_timeout_ms applies to
+        #   streaming requests only: it bounds each attempt's time to its first provider
+        #   event and never applies after it. Non-stream requests keep the per-attempt hop
+        #   and idle bounds (their headers arrive only with the finished completion).
+        #   retry_delay_ms and backoff are floors for the request knobs. Each planned
+        #   attempt is reserved (at most 8 per request); unused reservation is released at
+        #   settlement. Managed routes only. The stored form is echoed back with defaults
+        #   filled in; null disables retries.
+        #
+        #   @return [Telnyx::Models::LlmTokenGateway::TokenGroup::Retries, nil]
+        required :retries, -> { Telnyx::LlmTokenGateway::TokenGroup::Retries }, nil?: true
+
+        # @!attribute rpm_limit
+        #
+        #   @return [Integer, nil]
+        required :rpm_limit, Integer, nil?: true
+
+        # @!attribute spend
+        #   USD, decimal precision at most 6 places; parse exactly to integer micro-USD,
+        #   never binary float accounting.
+        #
+        #   @return [Float]
+        required :spend, Float
+
+        # @!attribute tpm_limit
+        #
+        #   @return [Integer, nil]
+        required :tpm_limit, Integer, nil?: true
+
+        # @!attribute updated_at
+        #
+        #   @return [Time]
+        required :updated_at, Time
+
+        # @!attribute version
+        #
+        #   @return [Integer]
+        required :version, Integer
+
+        # @!attribute max_parallel_requests
+        #   Optional maximum concurrent reserved/dispatched cache misses across replicas.
+        #   Null means no concurrency cap. Cache hits do not consume slots; unknown usage
+        #   retains its budget hold without a slot.
+        #
+        #   @return [Integer, nil]
+        optional :max_parallel_requests, Integer, nil?: true
+
+        # @!method initialize(id:, allowed_models:, blocked:, budget_duration:, budget_started_at:, cache_ttl:, created_at:, fallbacks:, guardrails:, max_budget:, name:, provider_key_ids:, reserved_spend:, resets_at:, retries:, rpm_limit:, spend:, tpm_limit:, updated_at:, version:, max_parallel_requests: nil, record_type: :token_group)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::LlmTokenGateway::TokenGroup} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param allowed_models [Array<String>]
+        #
+        #   @param blocked [Boolean]
+        #
+        #   @param budget_duration [Symbol, Telnyx::Models::LlmTokenGateway::BudgetDuration, nil]
+        #
+        #   @param budget_started_at [Time, nil]
+        #
+        #   @param cache_ttl [Integer, nil]
+        #
+        #   @param created_at [Time]
+        #
+        #   @param fallbacks [Hash{Symbol=>Array<String>}, nil] Per-group model fallbacks: primary alias -> ordered list of 1..3 other aliases.
+        #
+        #   @param guardrails [Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails, nil] Per-group guardrail policy. Missing actions default to ignore. profiles may be l
+        #
+        #   @param max_budget [Float, nil] USD, decimal precision at most 6 places; parse exactly to integer micro-USD, nev
+        #
+        #   @param name [String]
+        #
+        #   @param provider_key_ids [Array<String>]
+        #
+        #   @param reserved_spend [Float] USD, decimal precision at most 6 places; parse exactly to integer micro-USD, nev
+        #
+        #   @param resets_at [Time, nil]
+        #
+        #   @param retries [Telnyx::Models::LlmTokenGateway::TokenGroup::Retries, nil] Per-group same-route retries. max_attempts counts the first try of each step (th
+        #
+        #   @param rpm_limit [Integer, nil]
+        #
+        #   @param spend [Float] USD, decimal precision at most 6 places; parse exactly to integer micro-USD, nev
+        #
+        #   @param tpm_limit [Integer, nil]
+        #
+        #   @param updated_at [Time]
+        #
+        #   @param version [Integer]
+        #
+        #   @param max_parallel_requests [Integer, nil] Optional maximum concurrent reserved/dispatched cache misses across replicas. Nu
+        #
+        #   @param record_type [Symbol, :token_group]
+
+        # @see Telnyx::Models::LlmTokenGateway::TokenGroup#guardrails
+        class Guardrails < Telnyx::Internal::Type::BaseModel
+          # @!attribute dlp
+          #
+          #   @return [Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp, nil]
+          optional :dlp, -> { Telnyx::LlmTokenGateway::TokenGroup::Guardrails::Dlp }
+
+          # @!attribute secrets
+          #
+          #   @return [Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Secrets, nil]
+          optional :secrets, -> { Telnyx::LlmTokenGateway::TokenGroup::Guardrails::Secrets }
+
+          # @!attribute streaming
+          #
+          #   @return [Symbol, Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Streaming, nil]
+          optional :streaming, enum: -> { Telnyx::LlmTokenGateway::TokenGroup::Guardrails::Streaming }
+
+          # @!method initialize(dlp: nil, secrets: nil, streaming: nil)
+          #   Per-group guardrail policy. Missing actions default to ignore. profiles may be
+          #   listed with both dlp actions ignore (staged, inactive) but a non-ignore dlp
+          #   action requires at least one profile. streaming defaults to buffered when any
+          #   response action is block and passthrough otherwise; passthrough with a response
+          #   block is 400. Findings are codes and counts only; content is never stored. The
+          #   stored form is echoed back canonicalised (all actions explicit, profiles
+          #   sorted); {} is stored as an all-ignore policy, null disables.
+          #
+          #   @param dlp [Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp]
+          #   @param secrets [Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Secrets]
+          #   @param streaming [Symbol, Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Streaming]
+
+          # @see Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails#dlp
+          class Dlp < Telnyx::Internal::Type::BaseModel
+            # @!attribute profiles
+            #
+            #   @return [Array<Symbol, Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::Profile>, nil]
+            optional :profiles,
+                     -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::LlmTokenGateway::TokenGroup::Guardrails::Dlp::Profile] }
+
+            # @!attribute prompt
+            #
+            #   @return [Symbol, Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::Prompt, nil]
+            optional :prompt, enum: -> { Telnyx::LlmTokenGateway::TokenGroup::Guardrails::Dlp::Prompt }
+
+            # @!attribute response
+            #
+            #   @return [Symbol, Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::Response, nil]
+            optional :response, enum: -> { Telnyx::LlmTokenGateway::TokenGroup::Guardrails::Dlp::Response }
+
+            # @!method initialize(profiles: nil, prompt: nil, response: nil)
+            #   @param profiles [Array<Symbol, Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::Profile>]
+            #   @param prompt [Symbol, Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::Prompt]
+            #   @param response [Symbol, Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::Response]
+
+            module Profile
+              extend Telnyx::Internal::Type::Enum
+
+              FINANCIAL = :financial
+              GOVERNMENT_ID = :government_id
+              CONTACT = :contact
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # @see Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp#prompt
+            module Prompt
+              extend Telnyx::Internal::Type::Enum
+
+              IGNORE = :ignore
+              FLAG = :flag
+              BLOCK = :block
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # @see Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp#response
+            module Response
+              extend Telnyx::Internal::Type::Enum
+
+              IGNORE = :ignore
+              FLAG = :flag
+              BLOCK = :block
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # @see Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails#secrets
+          class Secrets < Telnyx::Internal::Type::BaseModel
+            # @!attribute prompt
+            #
+            #   @return [Symbol, Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Secrets::Prompt, nil]
+            optional :prompt, enum: -> { Telnyx::LlmTokenGateway::TokenGroup::Guardrails::Secrets::Prompt }
+
+            # @!attribute response
+            #
+            #   @return [Symbol, Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Secrets::Response, nil]
+            optional :response, enum: -> { Telnyx::LlmTokenGateway::TokenGroup::Guardrails::Secrets::Response }
+
+            # @!method initialize(prompt: nil, response: nil)
+            #   @param prompt [Symbol, Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Secrets::Prompt]
+            #   @param response [Symbol, Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Secrets::Response]
+
+            # @see Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Secrets#prompt
+            module Prompt
+              extend Telnyx::Internal::Type::Enum
+
+              IGNORE = :ignore
+              FLAG = :flag
+              BLOCK = :block
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # @see Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Secrets#response
+            module Response
+              extend Telnyx::Internal::Type::Enum
+
+              IGNORE = :ignore
+              FLAG = :flag
+              BLOCK = :block
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # @see Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails#streaming
+          module Streaming
+            extend Telnyx::Internal::Type::Enum
+
+            BUFFERED = :buffered
+            PASSTHROUGH = :passthrough
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @see Telnyx::Models::LlmTokenGateway::TokenGroup#retries
+        class Retries < Telnyx::Internal::Type::BaseModel
+          # @!attribute max_attempts
+          #
+          #   @return [Integer]
+          required :max_attempts, Integer
+
+          # @!attribute backoff
+          #
+          #   @return [Symbol, Telnyx::Models::LlmTokenGateway::TokenGroup::Retries::Backoff, nil]
+          optional :backoff, enum: -> { Telnyx::LlmTokenGateway::TokenGroup::Retries::Backoff }
+
+          # @!attribute request_timeout_ms
+          #
+          #   @return [Integer, nil]
+          optional :request_timeout_ms, Integer, nil?: true
+
+          # @!attribute retry_delay_ms
+          #
+          #   @return [Integer, nil]
+          optional :retry_delay_ms, Integer
+
+          # @!method initialize(max_attempts:, backoff: nil, request_timeout_ms: nil, retry_delay_ms: nil)
+          #   Per-group same-route retries. max_attempts counts the first try of each step
+          #   (the primary and each fallback) and is the ceiling for the x-ltg-max-attempts
+          #   request header. A step is retried only when its attempt definitely did no
+          #   provider work (connection failure before dispatch, or 429/529) before the first
+          #   provider event; an uncertain failure (timeout, 408/500/502/503/504) moves to the
+          #   next fallback step instead. max_attempts x (1 + the longest fallback chain) must
+          #   not exceed 8, else 400. The n-th retry waits retry_delay_ms (constant),
+          #   retry_delay_ms*n (linear) or retry_delay_ms*2^(n-1) (exponential), at most 5 s
+          #   and never past the request deadline, then jittered uniformly down to half that
+          #   value so concurrent retries spread out; a provider Retry-After of at most 5 s is
+          #   honoured and a longer one moves to the next step. request_timeout_ms applies to
+          #   streaming requests only: it bounds each attempt's time to its first provider
+          #   event and never applies after it. Non-stream requests keep the per-attempt hop
+          #   and idle bounds (their headers arrive only with the finished completion).
+          #   retry_delay_ms and backoff are floors for the request knobs. Each planned
+          #   attempt is reserved (at most 8 per request); unused reservation is released at
+          #   settlement. Managed routes only. The stored form is echoed back with defaults
+          #   filled in; null disables retries.
+          #
+          #   @param max_attempts [Integer]
+          #   @param backoff [Symbol, Telnyx::Models::LlmTokenGateway::TokenGroup::Retries::Backoff]
+          #   @param request_timeout_ms [Integer, nil]
+          #   @param retry_delay_ms [Integer]
+
+          # @see Telnyx::Models::LlmTokenGateway::TokenGroup::Retries#backoff
+          module Backoff
+            extend Telnyx::Internal::Type::Enum
+
+            CONSTANT = :constant
+            LINEAR = :linear
+            EXPONENTIAL = :exponential
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end