stagehand 3.20.0 → 3.21.0

data/lib/stagehand/models/session_extract_params.rb

@@ -69,9 +69,16 @@ module Stagehand
         # @!attribute model
         #   Model configuration object or model name string (e.g., 'openai/gpt-5-nano')
         #
-        #   @return [Stagehand::Models::ModelConfig, String, nil]
+        #   @return [Stagehand::Models::SessionExtractParams::Options::Model::VertexModelConfigObject, Stagehand::Models::SessionExtractParams::Options::Model::GenericModelConfigObject, String, nil]
         optional :model, union: -> { Stagehand::SessionExtractParams::Options::Model }
 
+        # @!attribute screenshot
+        #   When true, include a screenshot of the current viewport in the extraction LLM
+        #   call. Defaults to false.
+        #
+        #   @return [Boolean, nil]
+        optional :screenshot, Stagehand::Internal::Type::Boolean
+
         # @!attribute selector
         #   CSS selector to scope extraction to a specific element
         #
@@ -84,10 +91,15 @@ module Stagehand
         #   @return [Float, nil]
         optional :timeout, Float
 
-        # @!method initialize(ignore_selectors: nil, model: nil, selector: nil, timeout: nil)
+        # @!method initialize(ignore_selectors: nil, model: nil, screenshot: nil, selector: nil, timeout: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Stagehand::Models::SessionExtractParams::Options} for more details.
+        #
         #   @param ignore_selectors [Array<String>] Selectors for elements and subtrees that should be excluded from extraction
         #
-        #   @param model [Stagehand::Models::ModelConfig, String] Model configuration object or model name string (e.g., 'openai/gpt-5-nano')
+        #   @param model [Stagehand::Models::SessionExtractParams::Options::Model::VertexModelConfigObject, Stagehand::Models::SessionExtractParams::Options::Model::GenericModelConfigObject, String] Model configuration object or model name string (e.g., 'openai/gpt-5-nano')
+        #
+        #   @param screenshot [Boolean] When true, include a screenshot of the current viewport in the extraction LLM ca
         #
         #   @param selector [String] CSS selector to scope extraction to a specific element
         #
@@ -99,12 +111,339 @@ module Stagehand
         module Model
           extend Stagehand::Internal::Type::Union
 
-          variant -> { Stagehand::ModelConfig }
+          variant -> { Stagehand::SessionExtractParams::Options::Model::VertexModelConfigObject }
+
+          variant -> { Stagehand::SessionExtractParams::Options::Model::GenericModelConfigObject }
 
           variant String
 
+          class VertexModelConfigObject < Stagehand::Internal::Type::BaseModel
+            # @!attribute auth
+            #   Vertex provider authentication configuration
+            #
+            #   @return [Stagehand::Models::SessionExtractParams::Options::Model::VertexModelConfigObject::Auth]
+            required :auth, -> { Stagehand::SessionExtractParams::Options::Model::VertexModelConfigObject::Auth }
+
+            # @!attribute model_name
+            #   Model name string with provider prefix (e.g., 'openai/gpt-5-nano')
+            #
+            #   @return [String]
+            required :model_name, String, api_name: :modelName
+
+            # @!attribute provider
+            #   Vertex AI model provider
+            #
+            #   @return [Symbol, :vertex]
+            required :provider, const: :vertex
+
+            # @!attribute provider_options
+            #   Vertex provider-specific model configuration
+            #
+            #   @return [Stagehand::Models::SessionExtractParams::Options::Model::VertexModelConfigObject::ProviderOptions]
+            required :provider_options,
+                     -> {
+                       Stagehand::SessionExtractParams::Options::Model::VertexModelConfigObject::ProviderOptions
+                     },
+                     api_name: :providerOptions
+
+            # @!attribute api_key
+            #   API key for the model provider
+            #
+            #   @return [String, nil]
+            optional :api_key, String, api_name: :apiKey
+
+            # @!attribute base_url
+            #   Base URL for the model provider
+            #
+            #   @return [String, nil]
+            optional :base_url, String, api_name: :baseURL
+
+            # @!attribute headers
+            #   Custom headers sent with every request to the model provider
+            #
+            #   @return [Hash{Symbol=>String}, nil]
+            optional :headers, Stagehand::Internal::Type::HashOf[String]
+
+            # @!method initialize(auth:, model_name:, provider_options:, api_key: nil, base_url: nil, headers: nil, provider: :vertex)
+            #   @param auth [Stagehand::Models::SessionExtractParams::Options::Model::VertexModelConfigObject::Auth] Vertex provider authentication configuration
+            #
+            #   @param model_name [String] Model name string with provider prefix (e.g., 'openai/gpt-5-nano')
+            #
+            #   @param provider_options [Stagehand::Models::SessionExtractParams::Options::Model::VertexModelConfigObject::ProviderOptions] Vertex provider-specific model configuration
+            #
+            #   @param api_key [String] API key for the model provider
+            #
+            #   @param base_url [String] Base URL for the model provider
+            #
+            #   @param headers [Hash{Symbol=>String}] Custom headers sent with every request to the model provider
+            #
+            #   @param provider [Symbol, :vertex] Vertex AI model provider
+
+            # @see Stagehand::Models::SessionExtractParams::Options::Model::VertexModelConfigObject#auth
+            class Auth < Stagehand::Internal::Type::BaseModel
+              # @!attribute credentials
+              #   Google Cloud service account credentials
+              #
+              #   @return [Stagehand::Models::SessionExtractParams::Options::Model::VertexModelConfigObject::Auth::Credentials]
+              required :credentials,
+                       -> { Stagehand::SessionExtractParams::Options::Model::VertexModelConfigObject::Auth::Credentials }
+
+              # @!attribute type
+              #   Use inline Google Cloud service account credentials for provider authentication
+              #
+              #   @return [Symbol, :googleServiceAccount]
+              required :type, const: :googleServiceAccount
+
+              # @!attribute project_id
+              #   Google Cloud project ID used by google-auth-library
+              #
+              #   @return [String, nil]
+              optional :project_id, String, api_name: :projectId
+
+              # @!attribute scopes
+              #   Google auth scopes for the desired API request
+              #
+              #   @return [String, Array<String>, nil]
+              optional :scopes,
+                       union: -> { Stagehand::SessionExtractParams::Options::Model::VertexModelConfigObject::Auth::Scopes }
+
+              # @!attribute universe_domain
+              #   Google Cloud universe domain
+              #
+              #   @return [String, nil]
+              optional :universe_domain, String, api_name: :universeDomain
+
+              # @!method initialize(credentials:, project_id: nil, scopes: nil, universe_domain: nil, type: :googleServiceAccount)
+              #   Vertex provider authentication configuration
+              #
+              #   @param credentials [Stagehand::Models::SessionExtractParams::Options::Model::VertexModelConfigObject::Auth::Credentials] Google Cloud service account credentials
+              #
+              #   @param project_id [String] Google Cloud project ID used by google-auth-library
+              #
+              #   @param scopes [String, Array<String>] Google auth scopes for the desired API request
+              #
+              #   @param universe_domain [String] Google Cloud universe domain
+              #
+              #   @param type [Symbol, :googleServiceAccount] Use inline Google Cloud service account credentials for provider authentication
+
+              # @see Stagehand::Models::SessionExtractParams::Options::Model::VertexModelConfigObject::Auth#credentials
+              class Credentials < Stagehand::Internal::Type::BaseModel
+                # @!attribute client_email
+                #
+                #   @return [String]
+                required :client_email, String
+
+                # @!attribute private_key
+                #
+                #   @return [String]
+                required :private_key, String
+
+                # @!attribute auth_provider_x509_cert_url
+                #
+                #   @return [String, nil]
+                optional :auth_provider_x509_cert_url, String
+
+                # @!attribute auth_uri
+                #
+                #   @return [String, nil]
+                optional :auth_uri, String
+
+                # @!attribute client_id
+                #
+                #   @return [String, nil]
+                optional :client_id, String
+
+                # @!attribute client_x509_cert_url
+                #
+                #   @return [String, nil]
+                optional :client_x509_cert_url, String
+
+                # @!attribute private_key_id
+                #
+                #   @return [String, nil]
+                optional :private_key_id, String
+
+                # @!attribute project_id
+                #
+                #   @return [String, nil]
+                optional :project_id, String
+
+                # @!attribute token_uri
+                #
+                #   @return [String, nil]
+                optional :token_uri, String
+
+                # @!attribute type
+                #
+                #   @return [Symbol, Stagehand::Models::SessionExtractParams::Options::Model::VertexModelConfigObject::Auth::Credentials::Type, nil]
+                optional :type,
+                         enum: -> { Stagehand::SessionExtractParams::Options::Model::VertexModelConfigObject::Auth::Credentials::Type }
+
+                # @!attribute universe_domain
+                #
+                #   @return [String, nil]
+                optional :universe_domain, String
+
+                # @!method initialize(client_email:, private_key:, auth_provider_x509_cert_url: nil, auth_uri: nil, client_id: nil, client_x509_cert_url: nil, private_key_id: nil, project_id: nil, token_uri: nil, type: nil, universe_domain: nil)
+                #   Google Cloud service account credentials
+                #
+                #   @param client_email [String]
+                #   @param private_key [String]
+                #   @param auth_provider_x509_cert_url [String]
+                #   @param auth_uri [String]
+                #   @param client_id [String]
+                #   @param client_x509_cert_url [String]
+                #   @param private_key_id [String]
+                #   @param project_id [String]
+                #   @param token_uri [String]
+                #   @param type [Symbol, Stagehand::Models::SessionExtractParams::Options::Model::VertexModelConfigObject::Auth::Credentials::Type]
+                #   @param universe_domain [String]
+
+                # @see Stagehand::Models::SessionExtractParams::Options::Model::VertexModelConfigObject::Auth::Credentials#type
+                module Type
+                  extend Stagehand::Internal::Type::Enum
+
+                  SERVICE_ACCOUNT = :service_account
+
+                  # @!method self.values
+                  #   @return [Array<Symbol>]
+                end
+              end
+
+              # Google auth scopes for the desired API request
+              #
+              # @see Stagehand::Models::SessionExtractParams::Options::Model::VertexModelConfigObject::Auth#scopes
+              module Scopes
+                extend Stagehand::Internal::Type::Union
+
+                variant String
+
+                variant -> { Stagehand::Models::SessionExtractParams::Options::Model::VertexModelConfigObject::Auth::Scopes::StringArray }
+
+                # @!method self.variants
+                #   @return [Array(String, Array<String>)]
+
+                # @type [Stagehand::Internal::Type::Converter]
+                StringArray = Stagehand::Internal::Type::ArrayOf[String]
+              end
+            end
+
+            # @see Stagehand::Models::SessionExtractParams::Options::Model::VertexModelConfigObject#provider_options
+            class ProviderOptions < Stagehand::Internal::Type::BaseModel
+              # @!attribute vertex
+              #   Vertex AI provider-specific settings
+              #
+              #   @return [Stagehand::Models::SessionExtractParams::Options::Model::VertexModelConfigObject::ProviderOptions::Vertex]
+              required :vertex,
+                       -> { Stagehand::SessionExtractParams::Options::Model::VertexModelConfigObject::ProviderOptions::Vertex }
+
+              # @!method initialize(vertex:)
+              #   Vertex provider-specific model configuration
+              #
+              #   @param vertex [Stagehand::Models::SessionExtractParams::Options::Model::VertexModelConfigObject::ProviderOptions::Vertex] Vertex AI provider-specific settings
+
+              # @see Stagehand::Models::SessionExtractParams::Options::Model::VertexModelConfigObject::ProviderOptions#vertex
+              class Vertex < Stagehand::Internal::Type::BaseModel
+                # @!attribute location
+                #   Google Cloud location for Vertex AI models
+                #
+                #   @return [String]
+                required :location, String
+
+                # @!attribute project
+                #   Google Cloud project ID for Vertex AI models
+                #
+                #   @return [String]
+                required :project, String
+
+                # @!attribute base_url
+                #   Base URL for the Vertex AI provider
+                #
+                #   @return [String, nil]
+                optional :base_url, String, api_name: :baseURL
+
+                # @!attribute headers
+                #   Custom headers sent with every request to the Vertex AI provider
+                #
+                #   @return [Hash{Symbol=>String}, nil]
+                optional :headers, Stagehand::Internal::Type::HashOf[String]
+
+                # @!method initialize(location:, project:, base_url: nil, headers: nil)
+                #   Vertex AI provider-specific settings
+                #
+                #   @param location [String] Google Cloud location for Vertex AI models
+                #
+                #   @param project [String] Google Cloud project ID for Vertex AI models
+                #
+                #   @param base_url [String] Base URL for the Vertex AI provider
+                #
+                #   @param headers [Hash{Symbol=>String}] Custom headers sent with every request to the Vertex AI provider
+              end
+            end
+          end
+
+          class GenericModelConfigObject < Stagehand::Internal::Type::BaseModel
+            # @!attribute model_name
+            #   Model name string with provider prefix (e.g., 'openai/gpt-5-nano')
+            #
+            #   @return [String]
+            required :model_name, String, api_name: :modelName
+
+            # @!attribute api_key
+            #   API key for the model provider
+            #
+            #   @return [String, nil]
+            optional :api_key, String, api_name: :apiKey
+
+            # @!attribute base_url
+            #   Base URL for the model provider
+            #
+            #   @return [String, nil]
+            optional :base_url, String, api_name: :baseURL
+
+            # @!attribute headers
+            #   Custom headers sent with every request to the model provider
+            #
+            #   @return [Hash{Symbol=>String}, nil]
+            optional :headers, Stagehand::Internal::Type::HashOf[String]
+
+            # @!attribute provider
+            #   AI provider for the model (or provide a baseURL endpoint instead)
+            #
+            #   @return [Symbol, Stagehand::Models::SessionExtractParams::Options::Model::GenericModelConfigObject::Provider, nil]
+            optional :provider,
+                     enum: -> { Stagehand::SessionExtractParams::Options::Model::GenericModelConfigObject::Provider }
+
+            # @!method initialize(model_name:, api_key: nil, base_url: nil, headers: nil, provider: nil)
+            #   @param model_name [String] Model name string with provider prefix (e.g., 'openai/gpt-5-nano')
+            #
+            #   @param api_key [String] API key for the model provider
+            #
+            #   @param base_url [String] Base URL for the model provider
+            #
+            #   @param headers [Hash{Symbol=>String}] Custom headers sent with every request to the model provider
+            #
+            #   @param provider [Symbol, Stagehand::Models::SessionExtractParams::Options::Model::GenericModelConfigObject::Provider] AI provider for the model (or provide a baseURL endpoint instead)
+
+            # AI provider for the model (or provide a baseURL endpoint instead)
+            #
+            # @see Stagehand::Models::SessionExtractParams::Options::Model::GenericModelConfigObject#provider
+            module Provider
+              extend Stagehand::Internal::Type::Enum
+
+              OPENAI = :openai
+              ANTHROPIC = :anthropic
+              GOOGLE = :google
+              MICROSOFT = :microsoft
+              BEDROCK = :bedrock
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
           # @!method self.variants
-          #   @return [Array(Stagehand::Models::ModelConfig, String)]
+          #   @return [Array(Stagehand::Models::SessionExtractParams::Options::Model::VertexModelConfigObject, Stagehand::Models::SessionExtractParams::Options::Model::GenericModelConfigObject, String)]
         end
       end