@browserbasehq/stagehand 1.0.3 → 1.1.0-alpha.1

package/README.md

@@ -101,6 +101,7 @@ import { z } from "zod";
 
 const stagehand = new Stagehand({
   env: "BROWSERBASE",
+  enableCaching: true,
 });
 ```
 
@@ -136,7 +137,8 @@ This constructor is used to create an instance of Stagehand.
     - `1`: SDK-level logging
     - `2`: LLM-client level logging (most granular)
   - `debugDom`: a `boolean` that draws bounding boxes around elements presented to the LLM during automation.
-  - `domSettleTimeoutMs`: an `integer` that specifies the timeout in milliseconds for waiting for the DOM to settle. Defaults to 30000 (30 seconds).
+  - `domSettleTimeoutMs`: an `integer` that specifies the timeout in milliseconds for waiting for the DOM to settle. It can be overriden in individual function calls if needed. Defaults to 30000 (30 seconds).
+  - `enableCaching`: a `boolean` that enables caching of LLM responses. When set to `true`, the LLM requests will be cached on disk and reused for identical requests. Defaults to `false`.
 
 - **Returns:**
 
@@ -177,6 +179,7 @@ This constructor is used to create an instance of Stagehand.
   - `action`: a `string` describing the action to perform, e.g., `"search for 'x'"`.
   - `modelName`: (optional) an `AvailableModel` string to specify the model to use.
   - `useVision`: (optional) a `boolean` or `"fallback"` to determine if vision-based processing should be used. Defaults to `"fallback"`.
+  - `domSettleTimeoutMs`: (optional) an `integer` that specifies the timeout in milliseconds for waiting for the DOM to settle. If not set, defaults to the timeout value specified during initialization.
 
 - **Returns:**
 
@@ -199,6 +202,7 @@ This constructor is used to create an instance of Stagehand.
   - `instruction`: a `string` providing instructions for extraction.
   - `schema`: a `z.AnyZodObject` defining the structure of the data to extract.
   - `modelName`: (optional) an `AvailableModel` string to specify the model to use.
+  - `domSettleTimeoutMs`: (optional) an `integer` that specifies the timeout in milliseconds for waiting for the DOM to settle. If not set, defaults to the timeout value specified during initialization.
 
 - **Returns:**
 
@@ -227,6 +231,7 @@ If you are looking for a specific element, you can also pass in an instruction t
 
   - `instruction`: a `string` providing instructions for the observation.
   - `useVision`: (optional) a `boolean` or `"fallback"` to determine if vision-based processing should be used. Defaults to `"fallback"`.
+  - `domSettleTimeoutMs`: (optional) an `integer` that specifies the timeout in milliseconds for waiting for the DOM to settle. If not set, defaults to the timeout value specified during initialization.
 
 - **Returns:**
 
@@ -278,7 +283,6 @@ Stagehand currently supports the following models from OpenAI and Anthropic:
 
 These models can be specified when initializing the `Stagehand` instance or when calling methods like `act()` and `extract()`.
 
-
 ## How It Works
 
 The SDK has two major phases:
@@ -342,12 +346,14 @@ const productInfo = await stagehand.extract({
 - **Break down complex tasks into smaller, atomic steps**
 
 Instead of combining actions:
+
 ```javascript
 // Avoid this
 await stagehand.act({ action: "log in and purchase the first item" });
 ```
 
 Split them into individual steps:
+
 ```javascript
 await stagehand.act({ action: "click the login button" });
 // ...additional steps to log in...
@@ -385,11 +391,10 @@ await stagehand.act({ action: "fill out the form and submit it" });
 await stagehand.act({ action: "book the cheapest flight available" });
 ```
 
-By following these guidelines, you'll increase the reliability and effectiveness of your web automations with Stagehand. Remember, Stagehand excels at executing precise, well-defined actions so keeping your instructions atomic will lead to the best outcomes. 
+By following these guidelines, you'll increase the reliability and effectiveness of your web automations with Stagehand. Remember, Stagehand excels at executing precise, well-defined actions so keeping your instructions atomic will lead to the best outcomes.
 
 We leave the agentic behaviour to higher-level agentic systems which can use Stagehand as a tool.
 
-
 ## Roadmap
 
 At a high level, we're focused on improving reliability, speed, and cost in that order of priority.
@@ -464,7 +469,7 @@ Stagehand uses [tsup](https://github.com/egoist/tsup) to build the SDK and vanil
 
 ## Acknowledgements
 
-This project heavily relies on [Playwright](https://playwright.dev/) as a resilient backbone to automate the web. It also would not be possible without the awesome techniques and discoveries made by [tarsier](https://github.com/reworkd/tarsier), and [fuji-web](https://github.com/fuji-web).
+This project heavily relies on [Playwright](https://playwright.dev/) as a resilient backbone to automate the web. It also would not be possible without the awesome techniques and discoveries made by [tarsier](https://github.com/reworkd/tarsier), and [fuji-web](https://github.com/normal-computing/fuji-web).
 
 [Jeremy Press](https://x.com/jeremypress) wrote the original MVP of Stagehand and continues to be a major ally to the project.