Class SearchApiLoader

Class representing a document loader for loading search results from the SearchApi. It extends the BaseDocumentLoader class.

Example

const loader = new SearchApiLoader({
  q: "{query}",
  apiKey: "{apiKey}",
  engine: "google",
});
const docs = await loader.load();

Hierarchy

Constructors

constructor

Methods

buildUrl load loadAndSplit processResponseData

Constructors

constructor

Methods

buildUrl

  • Builds the URL for the SearchApi search request.

    Returns string

    The URL for the search request.

load

  • Loads the search results from the SearchApi.

    Returns Promise<Document<Record<string, any>>[]>

    An array of Documents representing the search results.

    Throws

    An error if the search results could not be loaded.

loadAndSplit

  • Loads the documents and splits them using a specified text splitter.

    Parameters

    Returns Promise<Document<Record<string, any>>[]>

    A Promise that resolves with an array of Document instances, each split according to the provided TextSplitter.

processResponseData

  • Processes the response data from the SearchApi search request and converts it into an array of Documents.

    Parameters

    • data: Record<string, unknown>

      The response data from the SearchApi search request.

    Returns Document<Record<string, any>>[]

    An array of Documents.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc