telnyx 5.170.0 → 5.173.0

data/lib/telnyx/models/ai/tests/test_framework/v1/scenario_update_params.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            # @see Telnyx::Resources::AI::Tests::TestFramework::V1::Scenarios#update
+            class ScenarioUpdateParams < Telnyx::Internal::Type::BaseModel
+              extend Telnyx::Internal::Type::RequestParameters::Converter
+              include Telnyx::Internal::Type::RequestParameters
+
+              # @!attribute id
+              #
+              #   @return [Integer]
+              required :id, Integer
+
+              # @!attribute agent
+              #
+              #   @return [Integer, nil]
+              optional :agent, Integer, nil?: true
+
+              # @!attribute expected_outcome_prompt
+              #
+              #   @return [String, nil]
+              optional :expected_outcome_prompt, String
+
+              # @!attribute first_message
+              #
+              #   @return [String, nil]
+              optional :first_message, String
+
+              # @!attribute folder_path
+              #
+              #   @return [String, nil]
+              optional :folder_path, String, nil?: true
+
+              # @!attribute inbound_phone_number
+              #
+              #   @return [Integer, nil]
+              optional :inbound_phone_number, Integer
+
+              # @!attribute instructions
+              #
+              #   @return [String, nil]
+              optional :instructions, String
+
+              # @!attribute max_duration
+              #
+              #   @return [Integer, nil]
+              optional :max_duration, Integer, nil?: true
+
+              # @!attribute metrics
+              #
+              #   @return [Array<Integer>, nil]
+              optional :metrics, Telnyx::Internal::Type::ArrayOf[Integer]
+
+              # @!attribute name
+              #
+              #   @return [String, nil]
+              optional :name, String
+
+              # @!attribute personality
+              #
+              #   @return [Integer, nil]
+              optional :personality, Integer
+
+              # @!attribute phone_number
+              #
+              #   @return [Integer, nil]
+              optional :phone_number, Integer
+
+              # @!attribute scenario_language
+              #
+              #   @return [String, nil]
+              optional :scenario_language, String
+
+              # @!attribute tags
+              #
+              #   @return [Array<String>, nil]
+              optional :tags, Telnyx::Internal::Type::ArrayOf[String]
+
+              # @!attribute test_profile
+              #
+              #   @return [Integer, nil]
+              optional :test_profile, Integer
+
+              # @!attribute tool_ids
+              #
+              #   @return [Array<String>, nil]
+              optional :tool_ids, Telnyx::Internal::Type::ArrayOf[String]
+
+              # @!method initialize(id:, agent: nil, expected_outcome_prompt: nil, first_message: nil, folder_path: nil, inbound_phone_number: nil, instructions: nil, max_duration: nil, metrics: nil, name: nil, personality: nil, phone_number: nil, scenario_language: nil, tags: nil, test_profile: nil, tool_ids: nil, request_options: {})
+              #   @param id [Integer]
+              #   @param agent [Integer, nil]
+              #   @param expected_outcome_prompt [String]
+              #   @param first_message [String]
+              #   @param folder_path [String, nil]
+              #   @param inbound_phone_number [Integer]
+              #   @param instructions [String]
+              #   @param max_duration [Integer, nil]
+              #   @param metrics [Array<Integer>]
+              #   @param name [String]
+              #   @param personality [Integer]
+              #   @param phone_number [Integer]
+              #   @param scenario_language [String]
+              #   @param tags [Array<String>]
+              #   @param test_profile [Integer]
+              #   @param tool_ids [Array<String>]
+              #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/tests/test_framework/v1/test_agent.rb

@@ -0,0 +1,190 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            # @see Telnyx::Resources::AI::Tests::TestFramework::V1::Aiagents#create
+            class TestAgent < Telnyx::Internal::Type::BaseModel
+              # @!attribute id
+              #
+              #   @return [Integer]
+              required :id, Integer
+
+              # @!attribute agent_name
+              #   Name of the test agent.
+              #
+              #   @return [String]
+              required :agent_name, String
+
+              # @!attribute assistant_id
+              #   ID of the Telnyx AI assistant under test.
+              #
+              #   @return [String]
+              required :assistant_id, String
+
+              # @!attribute created_at
+              #
+              #   @return [Time]
+              required :created_at, Time
+
+              # @!attribute updated_at
+              #
+              #   @return [Time]
+              required :updated_at, Time
+
+              # @!attribute auto_update_dropoff_nodes
+              #
+              #   @return [Boolean, nil]
+              optional :auto_update_dropoff_nodes, Telnyx::Internal::Type::Boolean
+
+              # @!attribute auto_update_topic_nodes
+              #
+              #   @return [Boolean, nil]
+              optional :auto_update_topic_nodes, Telnyx::Internal::Type::Boolean
+
+              # @!attribute chat_assistant_id
+              #   ID of the chat assistant under test, when testing text channels.
+              #
+              #   @return [String, nil]
+              optional :chat_assistant_id, String
+
+              # @!attribute contact_number
+              #   Contact phone number for the test agent.
+              #
+              #   @return [String, nil]
+              optional :contact_number, String
+
+              # @!attribute description
+              #
+              #   @return [String, nil]
+              optional :description, String
+
+              # @!attribute enabled_personalities
+              #   IDs of the test personalities enabled for this agent.
+              #
+              #   @return [Array<Integer>, nil]
+              optional :enabled_personalities, Telnyx::Internal::Type::ArrayOf[Integer]
+
+              # @!attribute hallucination_metric_kb_files
+              #
+              #   @return [Array<Integer>, nil]
+              optional :hallucination_metric_kb_files, Telnyx::Internal::Type::ArrayOf[Integer]
+
+              # @!attribute inbound
+              #   Whether the test agent accepts inbound calls.
+              #
+              #   @return [Boolean, nil]
+              optional :inbound, Telnyx::Internal::Type::Boolean
+
+              # @!attribute knowledge_base_files
+              #   Knowledge-base files associated with the test agent.
+              #
+              #   @return [Array<Object>, nil]
+              optional :knowledge_base_files, Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::Unknown]
+
+              # @!attribute language
+              #   ISO language code the test agent converses in.
+              #
+              #   @return [String, nil]
+              optional :language, String
+
+              # @!attribute llm_max_tokens
+              #
+              #   @return [Integer, nil]
+              optional :llm_max_tokens, Integer
+
+              # @!attribute llm_model
+              #   Model used to drive the test agent's side of the conversation.
+              #
+              #   @return [String, nil]
+              optional :llm_model, String
+
+              # @!attribute llm_system_prompt
+              #
+              #   @return [String, nil]
+              optional :llm_system_prompt, String
+
+              # @!attribute llm_temperature
+              #
+              #   @return [Float, nil]
+              optional :llm_temperature, Float
+
+              # @!attribute outbound_auto_call
+              #
+              #   @return [Boolean, nil]
+              optional :outbound_auto_call, Telnyx::Internal::Type::Boolean
+
+              # @!attribute outbound_numbers
+              #   Outbound numbers associated with the test agent.
+              #
+              #   @return [Array<Object>, nil]
+              optional :outbound_numbers,
+                       Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::Unknown],
+                       nil?: true
+
+              # @!attribute sip_auth
+              #
+              #   @return [Hash{Symbol=>String}, nil]
+              optional :sip_auth, Telnyx::Internal::Type::HashOf[String], nil?: true
+
+              # @!attribute sip_endpoint
+              #
+              #   @return [String, nil]
+              optional :sip_endpoint, String
+
+              # @!method initialize(id:, agent_name:, assistant_id:, created_at:, updated_at:, auto_update_dropoff_nodes: nil, auto_update_topic_nodes: nil, chat_assistant_id: nil, contact_number: nil, description: nil, enabled_personalities: nil, hallucination_metric_kb_files: nil, inbound: nil, knowledge_base_files: nil, language: nil, llm_max_tokens: nil, llm_model: nil, llm_system_prompt: nil, llm_temperature: nil, outbound_auto_call: nil, outbound_numbers: nil, sip_auth: nil, sip_endpoint: nil)
+              #   @param id [Integer]
+              #
+              #   @param agent_name [String] Name of the test agent.
+              #
+              #   @param assistant_id [String] ID of the Telnyx AI assistant under test.
+              #
+              #   @param created_at [Time]
+              #
+              #   @param updated_at [Time]
+              #
+              #   @param auto_update_dropoff_nodes [Boolean]
+              #
+              #   @param auto_update_topic_nodes [Boolean]
+              #
+              #   @param chat_assistant_id [String] ID of the chat assistant under test, when testing text channels.
+              #
+              #   @param contact_number [String] Contact phone number for the test agent.
+              #
+              #   @param description [String]
+              #
+              #   @param enabled_personalities [Array<Integer>] IDs of the test personalities enabled for this agent.
+              #
+              #   @param hallucination_metric_kb_files [Array<Integer>]
+              #
+              #   @param inbound [Boolean] Whether the test agent accepts inbound calls.
+              #
+              #   @param knowledge_base_files [Array<Object>] Knowledge-base files associated with the test agent.
+              #
+              #   @param language [String] ISO language code the test agent converses in.
+              #
+              #   @param llm_max_tokens [Integer]
+              #
+              #   @param llm_model [String] Model used to drive the test agent's side of the conversation.
+              #
+              #   @param llm_system_prompt [String]
+              #
+              #   @param llm_temperature [Float]
+              #
+              #   @param outbound_auto_call [Boolean]
+              #
+              #   @param outbound_numbers [Array<Object>, nil] Outbound numbers associated with the test agent.
+              #
+              #   @param sip_auth [Hash{Symbol=>String}, nil]
+              #
+              #   @param sip_endpoint [String]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/tests/test_framework/v1/test_run_result.rb

@@ -0,0 +1,389 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            # @see Telnyx::Resources::AI::Tests::TestFramework::V1::Results#retrieve
+            class TestRunResult < Telnyx::Internal::Type::BaseModel
+              # @!attribute id
+              #
+              #   @return [Integer]
+              required :id, Integer
+
+              # @!attribute agent
+              #
+              #   @return [Integer]
+              required :agent, Integer
+
+              # @!attribute created_at
+              #
+              #   @return [Time]
+              required :created_at, Time
+
+              # @!attribute name
+              #
+              #   @return [String]
+              required :name, String
+
+              # @!attribute status
+              #   Run batch status: running, completed, failed, pending, in_progress, evaluating,
+              #   in_queue, timeout, cancelled, or scaling_up.
+              #
+              #   @return [String]
+              required :status, String
+
+              # @!attribute updated_at
+              #
+              #   @return [Time]
+              required :updated_at, Time
+
+              # @!attribute agent_inbound
+              #
+              #   @return [Boolean, nil]
+              optional :agent_inbound, Telnyx::Internal::Type::Boolean
+
+              # @!attribute agent_name
+              #
+              #   @return [String, nil]
+              optional :agent_name, String
+
+              # @!attribute completed_runs_count
+              #
+              #   @return [Integer, String, nil]
+              optional :completed_runs_count,
+                       union: -> { Telnyx::AI::Tests::TestFramework::V1::TestRunResult::CompletedRunsCount }
+
+              # @!attribute failed_runs_count
+              #
+              #   @return [Integer, String, nil]
+              optional :failed_runs_count,
+                       union: -> { Telnyx::AI::Tests::TestFramework::V1::TestRunResult::FailedRunsCount }
+
+              # @!attribute is_cronjob
+              #   Whether this batch was started by a scheduled job.
+              #
+              #   @return [Boolean, nil]
+              optional :is_cronjob, Telnyx::Internal::Type::Boolean
+
+              # @!attribute met_expected_outcome_count
+              #
+              #   @return [Integer, String, nil]
+              optional :met_expected_outcome_count,
+                       union: -> { Telnyx::AI::Tests::TestFramework::V1::TestRunResult::MetExpectedOutcomeCount }
+
+              # @!attribute run_as_text
+              #   Whether the batch ran as text chat rather than voice calls.
+              #
+              #   @return [Boolean, nil]
+              optional :run_as_text, Telnyx::Internal::Type::Boolean
+
+              # @!attribute run_type
+              #
+              #   @return [String, nil]
+              optional :run_type, String, nil?: true
+
+              # @!attribute runs
+              #   Per-run detail keyed by run ID.
+              #
+              #   @return [Hash{Symbol=>Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::Run}, nil]
+              optional :runs,
+                       -> {
+                         Telnyx::Internal::Type::HashOf[Telnyx::AI::Tests::TestFramework::V1::TestRunResult::Run]
+                       },
+                       nil?: true
+
+              # @!attribute scenarios
+              #
+              #   @return [Array<Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::Scenario>, nil]
+              optional :scenarios,
+                       -> {
+                         Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Tests::TestFramework::V1::TestRunResult::Scenario]
+                       },
+                       nil?: true
+
+              # @!attribute success_rate
+              #   Share of runs judged successful.
+              #
+              #   @return [Float, String, nil]
+              optional :success_rate, union: -> { Telnyx::AI::Tests::TestFramework::V1::TestRunResult::SuccessRate }
+
+              # @!attribute success_runs_count
+              #
+              #   @return [Integer, String, nil]
+              optional :success_runs_count,
+                       union: -> { Telnyx::AI::Tests::TestFramework::V1::TestRunResult::SuccessRunsCount }
+
+              # @!attribute total_expected_outcome_count
+              #
+              #   @return [Integer, String, nil]
+              optional :total_expected_outcome_count,
+                       union: -> { Telnyx::AI::Tests::TestFramework::V1::TestRunResult::TotalExpectedOutcomeCount }
+
+              # @!attribute total_runs_count
+              #
+              #   @return [Integer, String, nil]
+              optional :total_runs_count,
+                       union: -> { Telnyx::AI::Tests::TestFramework::V1::TestRunResult::TotalRunsCount }
+
+              # @!method initialize(id:, agent:, created_at:, name:, status:, updated_at:, agent_inbound: nil, agent_name: nil, completed_runs_count: nil, failed_runs_count: nil, is_cronjob: nil, met_expected_outcome_count: nil, run_as_text: nil, run_type: nil, runs: nil, scenarios: nil, success_rate: nil, success_runs_count: nil, total_expected_outcome_count: nil, total_runs_count: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult} for more details.
+              #
+              #   @param id [Integer]
+              #
+              #   @param agent [Integer]
+              #
+              #   @param created_at [Time]
+              #
+              #   @param name [String]
+              #
+              #   @param status [String] Run batch status: running, completed, failed, pending, in_progress, evaluating,
+              #
+              #   @param updated_at [Time]
+              #
+              #   @param agent_inbound [Boolean]
+              #
+              #   @param agent_name [String]
+              #
+              #   @param completed_runs_count [Integer, String]
+              #
+              #   @param failed_runs_count [Integer, String]
+              #
+              #   @param is_cronjob [Boolean] Whether this batch was started by a scheduled job.
+              #
+              #   @param met_expected_outcome_count [Integer, String]
+              #
+              #   @param run_as_text [Boolean] Whether the batch ran as text chat rather than voice calls.
+              #
+              #   @param run_type [String, nil]
+              #
+              #   @param runs [Hash{Symbol=>Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::Run}, nil] Per-run detail keyed by run ID.
+              #
+              #   @param scenarios [Array<Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::Scenario>, nil]
+              #
+              #   @param success_rate [Float, String] Share of runs judged successful.
+              #
+              #   @param success_runs_count [Integer, String]
+              #
+              #   @param total_expected_outcome_count [Integer, String]
+              #
+              #   @param total_runs_count [Integer, String]
+
+              # @see Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult#completed_runs_count
+              module CompletedRunsCount
+                extend Telnyx::Internal::Type::Union
+
+                variant Integer
+
+                variant String
+
+                # @!method self.variants
+                #   @return [Array(Integer, String)]
+              end
+
+              # @see Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult#failed_runs_count
+              module FailedRunsCount
+                extend Telnyx::Internal::Type::Union
+
+                variant Integer
+
+                variant String
+
+                # @!method self.variants
+                #   @return [Array(Integer, String)]
+              end
+
+              # @see Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult#met_expected_outcome_count
+              module MetExpectedOutcomeCount
+                extend Telnyx::Internal::Type::Union
+
+                variant Integer
+
+                variant String
+
+                # @!method self.variants
+                #   @return [Array(Integer, String)]
+              end
+
+              class Run < Telnyx::Internal::Type::BaseModel
+                # @!attribute id
+                #
+                #   @return [Integer, nil]
+                optional :id, Integer
+
+                # @!attribute duration
+                #
+                #   @return [String, nil]
+                optional :duration, String
+
+                # @!attribute error_message
+                #
+                #   @return [String, nil]
+                optional :error_message, String
+
+                # @!attribute evaluation_status
+                #
+                #   @return [String, nil]
+                optional :evaluation_status, String
+
+                # @!attribute executed_at
+                #
+                #   @return [String, nil]
+                optional :executed_at, String
+
+                # @!attribute personality_name
+                #
+                #   @return [String, nil]
+                optional :personality_name, String
+
+                # @!attribute scenario
+                #
+                #   @return [Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::Run::Scenario, nil]
+                optional :scenario, -> { Telnyx::AI::Tests::TestFramework::V1::TestRunResult::Run::Scenario }
+
+                # @!attribute scenario_name
+                #
+                #   @return [String, nil]
+                optional :scenario_name, String
+
+                # @!attribute status
+                #
+                #   @return [String, nil]
+                optional :status, String
+
+                # @!attribute success
+                #
+                #   @return [Boolean, nil]
+                optional :success, Telnyx::Internal::Type::Boolean, nil?: true
+
+                # @!attribute test_profile_name
+                #
+                #   @return [String, nil]
+                optional :test_profile_name, String
+
+                # @!attribute timestamp
+                #
+                #   @return [String, nil]
+                optional :timestamp, String
+
+                # @!method initialize(id: nil, duration: nil, error_message: nil, evaluation_status: nil, executed_at: nil, personality_name: nil, scenario: nil, scenario_name: nil, status: nil, success: nil, test_profile_name: nil, timestamp: nil)
+                #   @param id [Integer]
+                #   @param duration [String]
+                #   @param error_message [String]
+                #   @param evaluation_status [String]
+                #   @param executed_at [String]
+                #   @param personality_name [String]
+                #   @param scenario [Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::Run::Scenario]
+                #   @param scenario_name [String]
+                #   @param status [String]
+                #   @param success [Boolean, nil]
+                #   @param test_profile_name [String]
+                #   @param timestamp [String]
+
+                # @see Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::Run#scenario
+                class Scenario < Telnyx::Internal::Type::BaseModel
+                  # @!attribute id
+                  #
+                  #   @return [Integer, nil]
+                  optional :id, Integer
+
+                  # @!attribute expected_outcome_prompt
+                  #
+                  #   @return [String, nil]
+                  optional :expected_outcome_prompt, String
+
+                  # @!attribute name
+                  #
+                  #   @return [String, nil]
+                  optional :name, String
+
+                  # @!attribute personality_name
+                  #
+                  #   @return [String, nil]
+                  optional :personality_name, String
+
+                  # @!method initialize(id: nil, expected_outcome_prompt: nil, name: nil, personality_name: nil)
+                  #   @param id [Integer]
+                  #   @param expected_outcome_prompt [String]
+                  #   @param name [String]
+                  #   @param personality_name [String]
+                end
+              end
+
+              class Scenario < Telnyx::Internal::Type::BaseModel
+                # @!attribute id
+                #
+                #   @return [Integer, nil]
+                optional :id, Integer
+
+                # @!attribute name
+                #
+                #   @return [String, nil]
+                optional :name, String
+
+                # @!method initialize(id: nil, name: nil)
+                #   @param id [Integer]
+                #   @param name [String]
+              end
+
+              # Share of runs judged successful.
+              #
+              # @see Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult#success_rate
+              module SuccessRate
+                extend Telnyx::Internal::Type::Union
+
+                # Share of runs judged successful.
+                variant Float
+
+                # Share of runs judged successful.
+                variant String
+
+                # @!method self.variants
+                #   @return [Array(Float, String)]
+              end
+
+              # @see Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult#success_runs_count
+              module SuccessRunsCount
+                extend Telnyx::Internal::Type::Union
+
+                variant Integer
+
+                variant String
+
+                # @!method self.variants
+                #   @return [Array(Integer, String)]
+              end
+
+              # @see Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult#total_expected_outcome_count
+              module TotalExpectedOutcomeCount
+                extend Telnyx::Internal::Type::Union
+
+                variant Integer
+
+                variant String
+
+                # @!method self.variants
+                #   @return [Array(Integer, String)]
+              end
+
+              # @see Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult#total_runs_count
+              module TotalRunsCount
+                extend Telnyx::Internal::Type::Union
+
+                variant Integer
+
+                variant String
+
+                # @!method self.variants
+                #   @return [Array(Integer, String)]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end