Class: Stagehand::Models::SessionObserveParams

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

Overview

See Also:

  • Stagehand::Resources::Sessions#observe
  • Stagehand::Resources::Sessions#observe_streaming

Defined Under Namespace

Modules: XStreamResponse Classes: Options

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 



37
 
# File 'sig/stagehand/models/session_observe_params.rbs', line 37

def initialize: (

Instance Attribute Details

#frame_id ⇒ String?

Target frame ID for the observation

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


22
 
# File 'lib/stagehand/models/session_observe_params.rb', line 22

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_observe_params.rb', line 16

required :id, String

#instruction ⇒ String?

Natural language instruction for what actions to find

Parameters:

  • (String)

Returns:

  • (String, nil) 


28
 
# File 'lib/stagehand/models/session_observe_params.rb', line 28

optional :instruction, String

#options ⇒ Stagehand::Models::SessionObserveParams::Options?

Returns:



33
 
# File 'lib/stagehand/models/session_observe_params.rb', line 33

optional :options, -> { Stagehand::SessionObserveParams::Options }

#x_stream_response ⇒ Symbol, ...

Whether to stream the response via SSE

Returns:



39
 
# File 'lib/stagehand/models/session_observe_params.rb', line 39

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

Class Method Details

.variants ⇒ Array(String, Float, Boolean, Stagehand::Models::SessionObserveParams::Options::Variable::UnionMember3)

Returns:




# File 'lib/stagehand/models/session_observe_params.rb', line 479

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {