Class: Revox::Models::AssistantCreateParams::CustomTool::Header

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Revox::Models::AssistantCreateParams::CustomTool::Header

Defined in:

lib/revox/models/assistant_create_params.rb,
sig/revox/models/assistant_create_params.rbs

Instance Attribute Summary

• #key ⇒ String
• #value ⇒ String

Instance Method Summary

• #initialize(body_template:, description:, headers:, input_schema:, method_:, name:, query_params:, url:) ⇒ Header constructor

  Some parameter documentations has been truncated, see Revox::Models::AssistantCreateParams::CustomTool for more details.

• #to_hash ⇒ { key: String, value: String }

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(body_template:, description:, headers:, input_schema:, method_:, name:, query_params:, url:) ⇒ Header

Some parameter documentations has been truncated, see Revox::Models::AssistantCreateParams::CustomTool for more details.

Parameters:

• body_template (String, nil) —

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

• description (String) —

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

• headers (Array<Revox::Models::AssistantCreateParams::CustomTool::Header>) —

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

• input_schema (Array<Revox::Models::AssistantCreateParams::CustomTool::InputSchema>) —

  Schema defining the parameters the LLM should extract from the conversation to p

• method_ (Symbol, Revox::Models::AssistantCreateParams::CustomTool::Method) —

  HTTP method to use when calling the API endpoint

• name (String) —

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

• query_params (Array<Revox::Models::AssistantCreateParams::CustomTool::QueryParam>) —

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

• url (String) —

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

• key: (String)
• value: (String)

# File 'lib/revox/models/assistant_create_params.rb', line 661

class Header < Revox::Internal::Type::BaseModel
  # @!attribute key
  #
  #   @return [String]
  required :key, String

  # @!attribute value
  #
  #   @return [String]
  required :value, String

  # @!method initialize(key:, value:)
  #   @param key [String]
  #   @param value [String]
end

Instance Attribute Details

#key ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/revox/models/assistant_create_params.rb', line 665

required :key, String

#value ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/revox/models/assistant_create_params.rb', line 670

required :value, String

Instance Method Details

#to_hash ⇒ { key: String, value: String }

Returns:

• ({ key: String, value: String })

# File 'sig/revox/models/assistant_create_params.rbs', line 495

def to_hash: -> { key: String, value: String }