telnyx 5.171.0 → 5.174.0

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

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            # @see Telnyx::Resources::AI::Tests::TestFramework::V1::Scenarios#run_scenarios
+            class ScenarioRunScenariosParams < Telnyx::Internal::Type::BaseModel
+              extend Telnyx::Internal::Type::RequestParameters::Converter
+              include Telnyx::Internal::Type::RequestParameters
+
+              # @!attribute agent_id
+              #
+              #   @return [Integer, nil]
+              optional :agent_id, Integer
+
+              # @!attribute agent_number
+              #
+              #   @return [String, nil]
+              optional :agent_number, String
+
+              # @!attribute assistant_id
+              #
+              #   @return [String, nil]
+              optional :assistant_id, String
+
+              # @!attribute concurrency_limit
+              #   Maximum number of concurrent simulated calls.
+              #
+              #   @return [Integer, nil]
+              optional :concurrency_limit, Integer
+
+              # @!attribute frequency
+              #
+              #   @return [Integer, nil]
+              optional :frequency, Integer
+
+              # @!attribute mode
+              #
+              #   @return [Symbol, Telnyx::Models::AI::Tests::TestFramework::V1::ScenarioRunScenariosParams::Mode, nil]
+              optional :mode, enum: -> { Telnyx::AI::Tests::TestFramework::V1::ScenarioRunScenariosParams::Mode }
+
+              # @!attribute name
+              #
+              #   @return [String, nil]
+              optional :name, String
+
+              # @!attribute outbound_phone_number
+              #
+              #   @return [String, nil]
+              optional :outbound_phone_number, String
+
+              # @!attribute personality_ids
+              #
+              #   @return [Array<Integer>, nil]
+              optional :personality_ids, Telnyx::Internal::Type::ArrayOf[Integer]
+
+              # @!attribute scenarios
+              #   Scenario IDs to run, or the literal string 'all'.
+              #
+              #   @return [Array<Object>, String, nil]
+              optional :scenarios,
+                       union: -> { Telnyx::AI::Tests::TestFramework::V1::ScenarioRunScenariosParams::Scenarios }
+
+              # @!attribute tags
+              #
+              #   @return [Array<String>, nil]
+              optional :tags, Telnyx::Internal::Type::ArrayOf[String]
+
+              # @!attribute test_profile_ids
+              #
+              #   @return [Array<Integer>, nil]
+              optional :test_profile_ids, Telnyx::Internal::Type::ArrayOf[Integer]
+
+              # @!method initialize(agent_id: nil, agent_number: nil, assistant_id: nil, concurrency_limit: nil, frequency: nil, mode: nil, name: nil, outbound_phone_number: nil, personality_ids: nil, scenarios: nil, tags: nil, test_profile_ids: nil, request_options: {})
+              #   @param agent_id [Integer]
+              #
+              #   @param agent_number [String]
+              #
+              #   @param assistant_id [String]
+              #
+              #   @param concurrency_limit [Integer] Maximum number of concurrent simulated calls.
+              #
+              #   @param frequency [Integer]
+              #
+              #   @param mode [Symbol, Telnyx::Models::AI::Tests::TestFramework::V1::ScenarioRunScenariosParams::Mode]
+              #
+              #   @param name [String]
+              #
+              #   @param outbound_phone_number [String]
+              #
+              #   @param personality_ids [Array<Integer>]
+              #
+              #   @param scenarios [Array<Object>, String] Scenario IDs to run, or the literal string 'all'.
+              #
+              #   @param tags [Array<String>]
+              #
+              #   @param test_profile_ids [Array<Integer>]
+              #
+              #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+              module Mode
+                extend Telnyx::Internal::Type::Enum
+
+                SAME_NUMBER = :same_number
+                DIFFERENT_NUMBERS = :different_numbers
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+
+              # Scenario IDs to run, or the literal string 'all'.
+              module Scenarios
+                extend Telnyx::Internal::Type::Union
+
+                # Scenario IDs to run, or the literal string 'all'.
+                variant -> { Telnyx::Models::AI::Tests::TestFramework::V1::ScenarioRunScenariosParams::Scenarios::UnionMember0Array }
+
+                # Scenario IDs to run, or the literal string 'all'.
+                variant String
+
+                # @!method self.variants
+                #   @return [Array(Array<Object>, String)]
+
+                # @type [Telnyx::Internal::Type::Converter]
+                UnionMember0Array = Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::Unknown]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            # @see Telnyx::Resources::AI::Tests::TestFramework::V1::Scenarios#run_scenarios
+            class ScenarioRunScenariosResponse < Telnyx::Internal::Type::BaseModel
+              # @!attribute id
+              #   ID of the created test-run batch whose results can be polled.
+              #
+              #   @return [Integer]
+              required :id, Integer
+
+              # @!attribute status
+              #   Initial status of the run batch.
+              #
+              #   @return [String]
+              required :status, String
+
+              # @!method initialize(id:, status:)
+              #   @param id [Integer] ID of the created test-run batch whose results can be polled.
+              #
+              #   @param status [String] Initial status of the run batch.
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            # @see Telnyx::Resources::AI::Tests::TestFramework::V1::Scenarios#scenario_agent
+            class ScenarioScenarioAgentParams < Telnyx::Internal::Type::BaseModel
+              extend Telnyx::Internal::Type::RequestParameters::Converter
+              include Telnyx::Internal::Type::RequestParameters
+
+              # @!attribute scenarios
+              #   Scenario IDs to improve, or the literal string 'all'.
+              #
+              #   @return [Array<Object>, String]
+              required :scenarios,
+                       union: -> { Telnyx::AI::Tests::TestFramework::V1::ScenarioScenarioAgentParams::Scenarios }
+
+              # @!attribute user_message
+              #   What the assistant should improve about the selected scenarios.
+              #
+              #   @return [String]
+              required :user_message, String
+
+              # @!attribute agent_id
+              #
+              #   @return [Integer, nil]
+              optional :agent_id, Integer, nil?: true
+
+              # @!attribute agent_resolution_response
+              #
+              #   @return [String, nil]
+              optional :agent_resolution_response, String
+
+              # @!attribute apply_changes
+              #
+              #   @return [Boolean, nil]
+              optional :apply_changes, Telnyx::Internal::Type::Boolean
+
+              # @!attribute context
+              #
+              #   @return [Array<Telnyx::Models::AI::Tests::TestFramework::V1::ScenarioScenarioAgentParams::Context>, nil]
+              optional :context,
+                       -> {
+                         Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Tests::TestFramework::V1::ScenarioScenarioAgentParams::Context]
+                       },
+                       nil?: true
+
+              # @!attribute knowledge_base
+              #
+              #   @return [Array<Integer>, nil]
+              optional :knowledge_base, Telnyx::Internal::Type::ArrayOf[Integer]
+
+              # @!attribute num_scenarios
+              #
+              #   @return [Integer, nil]
+              optional :num_scenarios, Integer
+
+              # @!attribute pending_tool_calls
+              #
+              #   @return [Array<Hash{Symbol=>Object}>, nil]
+              optional :pending_tool_calls,
+                       Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]],
+                       nil?: true
+
+              # @!attribute scenarios_needing_agent
+              #
+              #   @return [Array<Integer>, nil]
+              optional :scenarios_needing_agent, Telnyx::Internal::Type::ArrayOf[Integer]
+
+              # @!attribute session_id
+              #
+              #   @return [Integer, nil]
+              optional :session_id, Integer, nil?: true
+
+              # @!attribute updated_scenarios
+              #
+              #   @return [Array<Hash{Symbol=>Object}>, nil]
+              optional :updated_scenarios,
+                       Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]]
+
+              # @!method initialize(scenarios:, user_message:, agent_id: nil, agent_resolution_response: nil, apply_changes: nil, context: nil, knowledge_base: nil, num_scenarios: nil, pending_tool_calls: nil, scenarios_needing_agent: nil, session_id: nil, updated_scenarios: nil, request_options: {})
+              #   @param scenarios [Array<Object>, String] Scenario IDs to improve, or the literal string 'all'.
+              #
+              #   @param user_message [String] What the assistant should improve about the selected scenarios.
+              #
+              #   @param agent_id [Integer, nil]
+              #
+              #   @param agent_resolution_response [String]
+              #
+              #   @param apply_changes [Boolean]
+              #
+              #   @param context [Array<Telnyx::Models::AI::Tests::TestFramework::V1::ScenarioScenarioAgentParams::Context>, nil]
+              #
+              #   @param knowledge_base [Array<Integer>]
+              #
+              #   @param num_scenarios [Integer]
+              #
+              #   @param pending_tool_calls [Array<Hash{Symbol=>Object}>, nil]
+              #
+              #   @param scenarios_needing_agent [Array<Integer>]
+              #
+              #   @param session_id [Integer, nil]
+              #
+              #   @param updated_scenarios [Array<Hash{Symbol=>Object}>]
+              #
+              #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+              # Scenario IDs to improve, or the literal string 'all'.
+              module Scenarios
+                extend Telnyx::Internal::Type::Union
+
+                # Scenario IDs to improve, or the literal string 'all'.
+                variant -> { Telnyx::Models::AI::Tests::TestFramework::V1::ScenarioScenarioAgentParams::Scenarios::UnionMember0Array }
+
+                # Scenario IDs to improve, or the literal string 'all'.
+                variant String
+
+                # @!method self.variants
+                #   @return [Array(Array<Object>, String)]
+
+                # @type [Telnyx::Internal::Type::Converter]
+                UnionMember0Array = Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::Unknown]
+              end
+
+              class Context < Telnyx::Internal::Type::BaseModel
+                # @!attribute content
+                #
+                #   @return [String, nil]
+                optional :content, String
+
+                # @!attribute role
+                #
+                #   @return [String, nil]
+                optional :role, String
+
+                # @!attribute timestamp
+                #
+                #   @return [String, nil]
+                optional :timestamp, String
+
+                # @!method initialize(content: nil, role: nil, timestamp: nil)
+                #   @param content [String]
+                #   @param role [String]
+                #   @param timestamp [String]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            # @see Telnyx::Resources::AI::Tests::TestFramework::V1::Scenarios#scenario_agent
+            class ScenarioScenarioAgentResponse < Telnyx::Internal::Type::BaseModel
+              # @!attribute progress_id
+              #
+              #   @return [String]
+              required :progress_id, String
+
+              # @!attribute session_id
+              #
+              #   @return [Integer, nil]
+              optional :session_id, Integer, nil?: true
+
+              # @!method initialize(progress_id:, session_id: nil)
+              #   @param progress_id [String]
+              #   @param session_id [Integer, nil]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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