feat: [feat]: add ignoreSelectors to extract()

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 8
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/browserbase/stagehand-dbbff1a35360850898f7d60588e257faeac145a73cfcae634cfeb1b70109b6af.yml
-openapi_spec_hash: 28c4b734a5309067c39bb4c4b709b9ab
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/browserbase/stagehand-7182c741edd5e22cda9bd855d31ca7e60a97a409222bb887edf87b9ce15dd493.yml
+openapi_spec_hash: 174581867a9191c491b22855b64c4f19
 config_hash: a962ae71493deb11a1c903256fb25386

src/Stagehand.Tests/Models/Sessions/SessionExtractParamsTest.cs

@@ -20,6 +20,7 @@ public void FieldRoundtrip_Works()
             Instruction = "Extract all product names and prices from the page",
             Options = new()
             {
+                IgnoreSelectors = ["nav", ".cookie-banner", "#sidebar-ads"],
                 Model = new ModelConfig()
                 {
                     ModelName = "openai/gpt-5.4-mini",
@@ -43,6 +44,7 @@ public void FieldRoundtrip_Works()
         string expectedInstruction = "Extract all product names and prices from the page";
         SessionExtractParamsOptions expectedOptions = new()
         {
+            IgnoreSelectors = ["nav", ".cookie-banner", "#sidebar-ads"],
             Model = new ModelConfig()
             {
                 ModelName = "openai/gpt-5.4-mini",
@@ -129,6 +131,7 @@ public void OptionalNullableParamsUnsetAreNotSet_Works()
             Instruction = "Extract all product names and prices from the page",
             Options = new()
             {
+                IgnoreSelectors = ["nav", ".cookie-banner", "#sidebar-ads"],
                 Model = new ModelConfig()
                 {
                     ModelName = "openai/gpt-5.4-mini",
@@ -160,6 +163,7 @@ public void OptionalNullableParamsSetToNullAreSetToNull_Works()
             Instruction = "Extract all product names and prices from the page",
             Options = new()
             {
+                IgnoreSelectors = ["nav", ".cookie-banner", "#sidebar-ads"],
                 Model = new ModelConfig()
                 {
                     ModelName = "openai/gpt-5.4-mini",
@@ -241,6 +245,7 @@ public void CopyConstructor_Works()
             Instruction = "Extract all product names and prices from the page",
             Options = new()
             {
+                IgnoreSelectors = ["nav", ".cookie-banner", "#sidebar-ads"],
                 Model = new ModelConfig()
                 {
                     ModelName = "openai/gpt-5.4-mini",
@@ -272,6 +277,7 @@ public void FieldRoundtrip_Works()
     {
         var model = new SessionExtractParamsOptions
         {
+            IgnoreSelectors = ["nav", ".cookie-banner", "#sidebar-ads"],
             Model = new ModelConfig()
             {
                 ModelName = "openai/gpt-5.4-mini",
@@ -284,6 +290,7 @@ public void FieldRoundtrip_Works()
             Timeout = 30000,
         };
 
+        List<string> expectedIgnoreSelectors = ["nav", ".cookie-banner", "#sidebar-ads"];
         SessionExtractParamsOptionsModel expectedModel = new ModelConfig()
         {
             ModelName = "openai/gpt-5.4-mini",
@@ -295,6 +302,12 @@ public void FieldRoundtrip_Works()
         string expectedSelector = "#main-content";
         double expectedTimeout = 30000;
 
+        Assert.NotNull(model.IgnoreSelectors);
+        Assert.Equal(expectedIgnoreSelectors.Count, model.IgnoreSelectors.Count);
+        for (int i = 0; i < expectedIgnoreSelectors.Count; i++)
+        {
+            Assert.Equal(expectedIgnoreSelectors[i], model.IgnoreSelectors[i]);
+        }
         Assert.Equal(expectedModel, model.Model);
         Assert.Equal(expectedSelector, model.Selector);
         Assert.Equal(expectedTimeout, model.Timeout);
@@ -305,6 +318,7 @@ public void SerializationRoundtrip_Works()
     {
         var model = new SessionExtractParamsOptions
         {
+            IgnoreSelectors = ["nav", ".cookie-banner", "#sidebar-ads"],
             Model = new ModelConfig()
             {
                 ModelName = "openai/gpt-5.4-mini",
@@ -331,6 +345,7 @@ public void FieldRoundtripThroughSerialization_Works()
     {
         var model = new SessionExtractParamsOptions
         {
+            IgnoreSelectors = ["nav", ".cookie-banner", "#sidebar-ads"],
             Model = new ModelConfig()
             {
                 ModelName = "openai/gpt-5.4-mini",
@@ -350,6 +365,7 @@ public void FieldRoundtripThroughSerialization_Works()
         );
         Assert.NotNull(deserialized);
 
+        List<string> expectedIgnoreSelectors = ["nav", ".cookie-banner", "#sidebar-ads"];
         SessionExtractParamsOptionsModel expectedModel = new ModelConfig()
         {
             ModelName = "openai/gpt-5.4-mini",
@@ -361,6 +377,12 @@ public void FieldRoundtripThroughSerialization_Works()
         string expectedSelector = "#main-content";
         double expectedTimeout = 30000;
 
+        Assert.NotNull(deserialized.IgnoreSelectors);
+        Assert.Equal(expectedIgnoreSelectors.Count, deserialized.IgnoreSelectors.Count);
+        for (int i = 0; i < expectedIgnoreSelectors.Count; i++)
+        {
+            Assert.Equal(expectedIgnoreSelectors[i], deserialized.IgnoreSelectors[i]);
+        }
         Assert.Equal(expectedModel, deserialized.Model);
         Assert.Equal(expectedSelector, deserialized.Selector);
         Assert.Equal(expectedTimeout, deserialized.Timeout);
@@ -371,6 +393,7 @@ public void Validation_Works()
     {
         var model = new SessionExtractParamsOptions
         {
+            IgnoreSelectors = ["nav", ".cookie-banner", "#sidebar-ads"],
             Model = new ModelConfig()
             {
                 ModelName = "openai/gpt-5.4-mini",
@@ -391,6 +414,8 @@ public void OptionalNonNullablePropertiesUnsetAreNotSet_Works()
     {
         var model = new SessionExtractParamsOptions { };
 
+        Assert.Null(model.IgnoreSelectors);
+        Assert.False(model.RawData.ContainsKey("ignoreSelectors"));
         Assert.Null(model.Model);
         Assert.False(model.RawData.ContainsKey("model"));
         Assert.Null(model.Selector);
@@ -413,11 +438,14 @@ public void OptionalNonNullablePropertiesSetToNullAreNotSet_Works()
         var model = new SessionExtractParamsOptions
         {
             // Null should be interpreted as omitted for these properties
+            IgnoreSelectors = null,
             Model = null,
             Selector = null,
             Timeout = null,
         };
 
+        Assert.Null(model.IgnoreSelectors);
+        Assert.False(model.RawData.ContainsKey("ignoreSelectors"));
         Assert.Null(model.Model);
         Assert.False(model.RawData.ContainsKey("model"));
         Assert.Null(model.Selector);
@@ -432,6 +460,7 @@ public void OptionalNonNullablePropertiesSetToNullValidation_Works()
         var model = new SessionExtractParamsOptions
         {
             // Null should be interpreted as omitted for these properties
+            IgnoreSelectors = null,
             Model = null,
             Selector = null,
             Timeout = null,
@@ -445,6 +474,7 @@ public void CopyConstructor_Works()
     {
         var model = new SessionExtractParamsOptions
         {
+            IgnoreSelectors = ["nav", ".cookie-banner", "#sidebar-ads"],
             Model = new ModelConfig()
             {
                 ModelName = "openai/gpt-5.4-mini",

src/Stagehand/Models/Sessions/SessionExtractParams.cs

@@ -1,5 +1,6 @@
 using System.Collections.Frozen;
 using System.Collections.Generic;
+using System.Collections.Immutable;
 using System.Diagnostics.CodeAnalysis;
 using System.Net.Http;
 using System.Text;
@@ -255,6 +256,30 @@ public override int GetHashCode()
 )]
 public sealed record class SessionExtractParamsOptions : JsonModel
 {
+    /// <summary>
+    /// Selectors for elements and subtrees that should be excluded from extraction
+    /// </summary>
+    public IReadOnlyList<string>? IgnoreSelectors
+    {
+        get
+        {
+            this._rawData.Freeze();
+            return this._rawData.GetNullableStruct<ImmutableArray<string>>("ignoreSelectors");
+        }
+        init
+        {
+            if (value == null)
+            {
+                return;
+            }
+
+            this._rawData.Set<ImmutableArray<string>?>(
+                "ignoreSelectors",
+                value == null ? null : ImmutableArray.ToImmutableArray(value)
+            );
+        }
+    }
+
     /// <summary>
     /// Model configuration object or model name string (e.g., 'openai/gpt-5-nano')
     /// </summary>
@@ -321,6 +346,7 @@ public double? Timeout
     /// <inheritdoc/>
     public override void Validate()
     {
+        _ = this.IgnoreSelectors;
         this.Model?.Validate();
         _ = this.Selector;
         _ = this.Timeout;