Class: Revox::Models::CampaignLaunchResponse::Campaign::Assistant::CustomTool

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/revox/models/campaign_launch_response.rb,
sig/revox/models/campaign_launch_response.rbs

Defined Under Namespace

Modules: Method Classes: Header, InputSchema, QueryParam

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(key:, value:) ⇒ Object

Parameters:

  • key (String)
  • value (String) 



# File 'lib/revox/models/campaign_launch_response.rb', line 909

Instance Attribute Details

#body_template ⇒ String?

JSON body template for the request. Use quoted {variable} placeholders (e.g. "{name}") for dynamic values

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


824
 
# File 'lib/revox/models/campaign_launch_response.rb', line 824

required :body_template, String, nil?: true

#description ⇒ String

Human-readable description of what the tool does, used by the LLM to decide when to call it

Parameters:

  • value (String)

Returns:

  • (String) 


831
 
# File 'lib/revox/models/campaign_launch_response.rb', line 831

required :description, String

#headers ⇒ Array<Revox::Models::CampaignLaunchResponse::Campaign::Assistant::CustomTool::Header>

HTTP headers to include in the request. Values support {variable} placeholders

Parameters:

Returns:



837
838
 
# File 'lib/revox/models/campaign_launch_response.rb', line 837

required :headers,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignLaunchResponse::Campaign::Assistant::CustomTool::Header] }

#input_schema ⇒ Array<Revox::Models::CampaignLaunchResponse::Campaign::Assistant::CustomTool::InputSchema>

Schema defining the parameters the LLM should extract from the conversation to pass to this tool

Parameters:

Returns:



845
846
 
# File 'lib/revox/models/campaign_launch_response.rb', line 845

required :input_schema,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignLaunchResponse::Campaign::Assistant::CustomTool::InputSchema] }

#method_ ⇒ Symbol, Revox::Models::CampaignLaunchResponse::Campaign::Assistant::CustomTool::Method

HTTP method to use when calling the API endpoint

Parameters:

  • value (Revox::Models::CampaignLaunchResponse::Campaign::Assistant::CustomTool::method_)

Returns:



852
853
854
 
# File 'lib/revox/models/campaign_launch_response.rb', line 852

required :method_,
enum: -> { Revox::Models::CampaignLaunchResponse::Campaign::Assistant::CustomTool::Method },
api_name: :method

#name ⇒ String

Unique tool name in lowercase_snake_case (e.g. check_inventory)

Parameters:

  • value (String)

Returns:

  • (String) 


860
 
# File 'lib/revox/models/campaign_launch_response.rb', line 860

required :name, String

#query_params ⇒ Array<Revox::Models::CampaignLaunchResponse::Campaign::Assistant::CustomTool::QueryParam>

Query string parameters appended to the URL. Values support {variable} placeholders

Parameters:

Returns:



867
868
 
# File 'lib/revox/models/campaign_launch_response.rb', line 867

required :query_params,
-> { Revox::Internal::Type::ArrayOf[Revox::Models::CampaignLaunchResponse::Campaign::Assistant::CustomTool::QueryParam] }

#url ⇒ String

Full URL of the API endpoint. Supports {variable} placeholders for dynamic values

Parameters:

  • value (String)

Returns:

  • (String) 


875
 
# File 'lib/revox/models/campaign_launch_response.rb', line 875

required :url, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/revox/models/campaign_launch_response.rb', line 959

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


633
 
# File 'sig/revox/models/campaign_launch_response.rbs', line 633

def to_hash: -> {