added Browserbase loader #5248
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # Browserbase Loader | ||
|
|
||
| ## Description | ||
|
|
||
| [Browserbase](https://browserbase.com) is a serverless platform for running headless browsers, it offers advanced debugging, session recordings, stealth mode, integrated proxies and captcha solving. | ||
|
|
||
| ## Installation | ||
|
|
||
| - Get an API key from [browserbase.com](https://browserbase.com) and set it in environment variables (`BROWSERBASE_API_KEY`). | ||
| - Install the [Browserbase SDK](http://github.com/browserbase/js-sdk): | ||
|
|
||
| ``` | ||
| npm i @browserbasehq/sdk | ||
| ``` | ||
|
|
||
| ## Example | ||
|
|
||
| Utilize the BrowserbaseLoader as follows to allow your agent to load websites: | ||
|
|
||
| ```js | ||
| import { BrowserbaseLoader } from "langchain/document_loaders/web/browserbase.js"; | ||
|
|
||
| const loader = new BrowserbaseLoader(["https://example.com"], { textContent: true }); | ||
| const docs = await loader.load(); | ||
| ``` | ||
|
|
||
| ## Arguments | ||
|
|
||
| - `urls`: Required. List of URLs to load. | ||
|
|
||
| ## Options | ||
|
|
||
| - `api_key`: Optional. Specifies Browserbase API key. Defaults is the `BROWSERBASE_API_KEY` environment variable. | ||
| - `text_content`: Optional. Load pages as readable text. Default is `False`. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| import { Document } from "@langchain/core/documents"; | ||
| import type { BrowserbaseLoadOptions } from "@browserbasehq/sdk"; | ||
| import { BaseDocumentLoader } from "../base.js"; | ||
| import type { DocumentLoader } from "../base.js"; | ||
|
|
||
| type BrowserbaseLoaderOptions = BrowserbaseLoadOptions & { | ||
mishushakov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| apiKey?: string; | ||
mishushakov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| }; | ||
|
|
||
| /** | ||
| * Load pre-rendered web pages using a headless browser hosted on Browserbase. | ||
| * | ||
| * Depends on `@browserbasehq/sdk` package. | ||
| * Get your API key from https://browserbase.com | ||
| * | ||
| * @param {string[]} urls - The URLs of the web pages to load. | ||
| * @param {BrowserbaseLoaderOptions} [options] - Browserbase client options. | ||
| */ | ||
mishushakov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| export class BrowserbaseLoader | ||
| extends BaseDocumentLoader | ||
| implements DocumentLoader | ||
| { | ||
| urls: string[]; | ||
|
|
||
| options: BrowserbaseLoaderOptions; | ||
|
|
||
| constructor(urls: string[], options: BrowserbaseLoaderOptions = {}) { | ||
| super(); | ||
| this.urls = urls; | ||
| this.options = options; | ||
| } | ||
|
|
||
| /** | ||
| * Load pages from URLs. | ||
| * | ||
| * @returns {Promise<Document[]>} - A generator that yields loaded documents. | ||
mishushakov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| */ | ||
|
|
||
| async load(): Promise<Document[]> { | ||
mishushakov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| const documents: Document[] = []; | ||
| for await (const doc of this.lazyLoad()) { | ||
| documents.push(doc); | ||
| } | ||
|
|
||
| return documents; | ||
| } | ||
|
|
||
| /** | ||
| * Load pages from URLs. | ||
| * | ||
| * @returns {Generator<Document>} - A generator that yields loaded documents. | ||
| */ | ||
| async *lazyLoad() { | ||
| const browserbase = await BrowserbaseLoader.imports(this.options.apiKey); | ||
| const pages = await browserbase.loadURLs(this.urls, this.options); | ||
|
|
||
| let index = 0; | ||
| for await (const page of pages) { | ||
| yield new Document({ | ||
| pageContent: page, | ||
| metadata: { | ||
| url: this.urls[index], | ||
| }, | ||
| }); | ||
|
|
||
| index += index + 1; | ||
| } | ||
| } | ||
|
|
||
| static async imports(apiKey?: string) { | ||
| try { | ||
| const { default: Browserbase } = await import("@browserbasehq/sdk"); | ||
| return new Browserbase(apiKey); | ||
| } catch (error) { | ||
| throw new Error( | ||
| "You must run " + | ||
| "`npm install --save @browserbasehq/sdk` " + | ||
| "to use the Browserbase loader." | ||
| ); | ||
| } | ||
| } | ||
| } | ||
mishushakov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.