Class: Stagehand::Models::SessionExecuteParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/stagehand/models/session_execute_params.rb,
sig/stagehand/models/session_execute_params.rbs

Overview

See Also:

  • Stagehand::Resources::Sessions#execute
  • Stagehand::Resources::Sessions#execute_streaming

Defined Under Namespace

Modules: XStreamResponse Classes: AgentConfig, ExecuteOptions

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::Stagehand

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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 ⇒ Object 



36
 
# File 'sig/stagehand/models/session_execute_params.rbs', line 36

def initialize: (

Instance Attribute Details

#agent_config ⇒ Stagehand::Models::SessionExecuteParams::AgentConfig

Parameters:

  • value (Stagehand::SessionExecuteParams::AgentConfig)

Returns:



21
 
# File 'lib/stagehand/models/session_execute_params.rb', line 21

required :agent_config, -> { Stagehand::SessionExecuteParams::AgentConfig }, api_name: :agentConfig

#execute_options ⇒ Stagehand::Models::SessionExecuteParams::ExecuteOptions

Parameters:

  • value (Stagehand::SessionExecuteParams::ExecuteOptions)

Returns:



26
27
28
 
# File 'lib/stagehand/models/session_execute_params.rb', line 26

required :execute_options,
-> { Stagehand::SessionExecuteParams::ExecuteOptions },
api_name: :executeOptions

#frame_id ⇒ String?

Target frame ID for the agent

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


34
 
# File 'lib/stagehand/models/session_execute_params.rb', line 34

optional :frame_id, String, api_name: :frameId, nil?: true

#id ⇒ String

Unique session identifier

Parameters:

  • value (String)

Returns:

  • (String) 


16
 
# File 'lib/stagehand/models/session_execute_params.rb', line 16

required :id, String

#should_cache ⇒ Boolean?

If true, the server captures a cache entry and returns it to the client

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


40
 
# File 'lib/stagehand/models/session_execute_params.rb', line 40

optional :should_cache, Stagehand::Internal::Type::Boolean, api_name: :shouldCache

#x_stream_response ⇒ Symbol, ...

Whether to stream the response via SSE

Returns:



46
 
# File 'lib/stagehand/models/session_execute_params.rb', line 46

optional :x_stream_response, enum: -> { Stagehand::SessionExecuteParams::XStreamResponse }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/stagehand/models/session_execute_params.rb', line 832

.variants ⇒ Array(String, Float, Boolean, Stagehand::Models::SessionExecuteParams::ExecuteOptions::Variable::UnionMember3)

Returns:




# File 'lib/stagehand/models/session_execute_params.rb', line 925

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


46
 
# File 'sig/stagehand/models/session_execute_params.rbs', line 46

def to_hash: -> {