Class: Stagehand::Models::SessionActParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Stagehand::Models::SessionActParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/stagehand/models/session_act_params.rb

Overview

See Also:

• Resources::Sessions#act
• Resources::Sessions#act_streaming

Defined Under Namespace

Modules: Input, XStreamResponse Classes: Options

Instance Attribute Summary

• #frame_id ⇒ String^?

  Target frame ID for the action.

• #id ⇒ String

  Unique session identifier.

• #input ⇒ String, Stagehand::Models::Action

  Natural language instruction or Action object.

• #options ⇒ Stagehand::Models::SessionActParams::Options^?
• #x_stream_response ⇒ Symbol, ...

  Whether to stream the response via SSE.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

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

Instance Method Summary

• #initialize(id:, input:, frame_id: nil, options: nil, x_stream_response: nil, request_options: {}) ⇒ Object constructor

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(id:, input:, frame_id: nil, options: nil, x_stream_response: nil, request_options: {}) ⇒ Object

Parameters:

• id (String) —

  Unique session identifier

• input (String, Stagehand::Models::Action) —

  Natural language instruction or Action object

• frame_id (String, nil) (defaults to: nil) —

  Target frame ID for the action

• options (Stagehand::Models::SessionActParams::Options) (defaults to: nil)
• x_stream_response (Symbol, Stagehand::Models::SessionActParams::XStreamResponse) (defaults to: nil) —

  Whether to stream the response via SSE

• request_options (Stagehand::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/stagehand/models/session_act_params.rb', line 41

Instance Attribute Details

#frame_id ⇒ String^?

Target frame ID for the action

Returns:

• (String, nil)

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

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

#id ⇒ String

Unique session identifier

Returns:

• (String)

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

required :id, String

#input ⇒ String, Stagehand::Models::Action

Natural language instruction or Action object

Returns:

• (String, Stagehand::Models::Action)

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

required :input, union: -> { Stagehand::SessionActParams::Input }

#options ⇒ Stagehand::Models::SessionActParams::Options^?

Returns:

• (Stagehand::Models::SessionActParams::Options, nil)

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

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

#x_stream_response ⇒ Symbol, ...

Whether to stream the response via SSE

Returns:

• (Symbol, Stagehand::Models::SessionActParams::XStreamResponse, nil)

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

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

Class Method Details

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

Returns:

• (Array(String, Float, Boolean, Stagehand::Models::SessionActParams::Options::Variable::UnionMember3))

# File 'lib/stagehand/models/session_act_params.rb', line 63