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

BaseDocumentLoader
- SearchApiLoader

Index

Constructors

constructor

Methods

buildUrl load loadAndSplit processResponseData

Constructors

constructor

new SearchApiLoader(params): SearchApiLoader
Parameters
- params: SearchApiParameters
Returns SearchApiLoader
Overrides BaseDocumentLoader.constructor
- Defined in langchain/src/document_loaders/web/searchapi.ts:45

Methods

buildUrl

buildUrl(): string
Builds the URL for the SearchApi search request.

Returns string
The URL for the search request.
- Defined in langchain/src/document_loaders/web/searchapi.ts:68

load

load(): Promise<Document<Record<string, any>>[]>
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.
Overrides BaseDocumentLoader.load
- Defined in langchain/src/document_loaders/web/searchapi.ts:165

loadAndSplit

loadAndSplit(splitter?): Promise<Document<Record<string, any>>[]>
Loads the documents and splits them using a specified text splitter.
Parameters
- splitter: TextSplitter = ...
Returns Promise<Document<Record<string, any>>[]>
A Promise that resolves with an array of Document instances, each split according to the provided TextSplitter.
Inherited from BaseDocumentLoader.loadAndSplit
- Defined in langchain/src/document_loaders/base.ts:32

processResponseData

processResponseData(data): Document<Record<string, any>>[]
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.
- Defined in langchain/src/document_loaders/web/searchapi.ts:121

Class SearchApiLoader

Example

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

params: SearchApiParameters

Returns SearchApiLoader

Methods

buildUrl

Returns string

load

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

Throws

loadAndSplit

Parameters

splitter: TextSplitter = ...

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

processResponseData

Parameters

data: Record<string, unknown>

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

Settings

Member Visibility

Theme

On This Page