Module: Stagehand::Models::SessionExecuteParams::ExecuteOptions::Variable

Extended by:
Internal::Type::Union
Defined in:
lib/stagehand/models/session_execute_params.rb

Defined Under Namespace

Classes: UnionMember3

Instance Method Summary collapse

Methods included from Internal::Type::Union

==, ===, coerce, dump, hash, inspect, to_sorbet_type, variants

Methods included from Internal::Util::SorbetRuntimeSupport

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

Methods included from Internal::Type::Converter

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

Instance Method Details

#initialize(instruction:, highlight_cursor: nil, max_steps: nil, tool_timeout: nil, use_search: nil, variables: nil) ⇒ Object

Parameters:

  • instruction (String) —

    Natural language instruction for the agent

  • highlight_cursor (Boolean) (defaults to: nil) —

    Whether to visually highlight the cursor during execution

  • max_steps (Float) (defaults to: nil) —

    Maximum number of steps the agent can take

  • tool_timeout (Float) (defaults to: nil) —

    Timeout in milliseconds for each agent tool call

  • use_search (Boolean) (defaults to: nil) —

    Whether to enable the web search tool powered by Browserbase Search API

  • variables (Hash{Symbol=>String, Float, Boolean, Stagehand::Models::SessionExecuteParams::ExecuteOptions::Variable::UnionMember3}) (defaults to: nil) —

    Variables available to the agent via %variableName% syntax in supported tools



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
 
# File 'lib/stagehand/models/session_execute_params.rb', line 888

module Variable
  extend Stagehand::Internal::Type::Union

  variant String

  variant Float

  variant Stagehand::Internal::Type::Boolean

  variant -> { Stagehand::SessionExecuteParams::ExecuteOptions::Variable::UnionMember3 }

  class UnionMember3 < Stagehand::Internal::Type::BaseModel
    # @!attribute value
    #
    #   @return [String, Float, Boolean]
    required :value,
             union: -> { Stagehand::SessionExecuteParams::ExecuteOptions::Variable::UnionMember3::Value }

    # @!attribute description
    #
    #   @return [String, nil]
    optional :description, String

    # @!method initialize(value:, description: nil)
    #   @param value [String, Float, Boolean]
    #   @param description [String]

    # @see Stagehand::Models::SessionExecuteParams::ExecuteOptions::Variable::UnionMember3#value
    module Value
      extend Stagehand::Internal::Type::Union

      variant String

      variant Float

      variant Stagehand::Internal::Type::Boolean

      # @!method self.variants
      #   @return [Array(String, Float, Boolean)]
    end
  end

  # @!method self.variants
  #   @return [Array(String, Float, Boolean, Stagehand::Models::SessionExecuteParams::ExecuteOptions::Variable::UnionMember3)]
end