Class: Stagehand::Models::SessionStartParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/stagehand/models/session_start_params.rb

Overview

See Also:

• Resources::Sessions#start

Defined Under Namespace

Modules: Verbose, XStreamResponse Classes: Browser, BrowserbaseSessionCreateParams

Instance Attribute Summary

• #act_timeout_ms ⇒ Float^?

  Timeout in ms for act operations (deprecated, v2 only).

• #browser ⇒ Stagehand::Models::SessionStartParams::Browser^?
• #browserbase_session_create_params ⇒ Stagehand::Models::SessionStartParams::BrowserbaseSessionCreateParams^?
• #browserbase_session_id ⇒ String^?

  Existing Browserbase session ID to resume.

• #dom_settle_timeout_ms ⇒ Float^?

  Timeout in ms to wait for DOM to settle.

• #experimental ⇒ Boolean^?
• #model_name ⇒ String

  Model name to use for AI operations.

• #self_heal ⇒ Boolean^?

  Enable self-healing for failed actions.

• #system_prompt ⇒ String^?

  Custom system prompt for AI operations.

• #verbose ⇒ Float, ...

  Logging verbosity level (0=quiet, 1=normal, 2=debug).

• #wait_for_captcha_solves ⇒ Boolean^?

  Wait for captcha solves (deprecated, v2 only).

• #x_stream_response ⇒ Symbol, ...

  Whether to stream the response via SSE.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Float>

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, #initialize, 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

This class inherits a constructor from Stagehand::Internal::Type::BaseModel

Instance Attribute Details

#act_timeout_ms ⇒ Float^?

Timeout in ms for act operations (deprecated, v2 only)

Returns:

• (Float, nil)

# File 'lib/stagehand/models/session_start_params.rb', line 20

optional :act_timeout_ms, Float, api_name: :actTimeoutMs

#browser ⇒ Stagehand::Models::SessionStartParams::Browser^?

Returns:

• (Stagehand::Models::SessionStartParams::Browser, nil)

# File 'lib/stagehand/models/session_start_params.rb', line 25

optional :browser, -> { Stagehand::SessionStartParams::Browser }

#browserbase_session_create_params ⇒ Stagehand::Models::SessionStartParams::BrowserbaseSessionCreateParams^?

Returns:

• (Stagehand::Models::SessionStartParams::BrowserbaseSessionCreateParams, nil)

# File 'lib/stagehand/models/session_start_params.rb', line 30

optional :browserbase_session_create_params,
-> { Stagehand::SessionStartParams::BrowserbaseSessionCreateParams },
api_name: :browserbaseSessionCreateParams

#browserbase_session_id ⇒ String^?

Existing Browserbase session ID to resume

Returns:

• (String, nil)

# File 'lib/stagehand/models/session_start_params.rb', line 38

optional :browserbase_session_id, String, api_name: :browserbaseSessionID

#dom_settle_timeout_ms ⇒ Float^?

Timeout in ms to wait for DOM to settle

Returns:

• (Float, nil)

# File 'lib/stagehand/models/session_start_params.rb', line 44

optional :dom_settle_timeout_ms, Float, api_name: :domSettleTimeoutMs

#experimental ⇒ Boolean^?

Returns:

• (Boolean, nil)

# File 'lib/stagehand/models/session_start_params.rb', line 49

optional :experimental, Stagehand::Internal::Type::Boolean

#model_name ⇒ String

Model name to use for AI operations

Returns:

• (String)

# File 'lib/stagehand/models/session_start_params.rb', line 14

required :model_name, String, api_name: :modelName

#self_heal ⇒ Boolean^?

Enable self-healing for failed actions

Returns:

• (Boolean, nil)

# File 'lib/stagehand/models/session_start_params.rb', line 55

optional :self_heal, Stagehand::Internal::Type::Boolean, api_name: :selfHeal

#system_prompt ⇒ String^?

Custom system prompt for AI operations

Returns:

• (String, nil)

# File 'lib/stagehand/models/session_start_params.rb', line 61

optional :system_prompt, String, api_name: :systemPrompt

#verbose ⇒ Float, ...

Logging verbosity level (0=quiet, 1=normal, 2=debug)

Returns:

• (Float, Stagehand::Models::SessionStartParams::Verbose, nil)

# File 'lib/stagehand/models/session_start_params.rb', line 67

optional :verbose, enum: -> { Stagehand::SessionStartParams::Verbose }

#wait_for_captcha_solves ⇒ Boolean^?

Wait for captcha solves (deprecated, v2 only)

Returns:

• (Boolean, nil)

# File 'lib/stagehand/models/session_start_params.rb', line 73

optional :wait_for_captcha_solves, Stagehand::Internal::Type::Boolean, api_name: :waitForCaptchaSolves

#x_stream_response ⇒ Symbol, ...

Whether to stream the response via SSE

Returns:

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

# File 'lib/stagehand/models/session_start_params.rb', line 79

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

Class Method Details

.values ⇒ Array<Float>

Returns:

• (Array<Float>)

# File 'lib/stagehand/models/session_start_params.rb', line 332