Class GitbookLoader

Class representing a document loader specifically designed for loading documents from Gitbook. It extends the CheerioWebBaseLoader.

Hierarchy

CheerioWebBaseLoader
- GitbookLoader

Index

Constructors

Properties

caller shouldLoadAllPaths timeout webPath selector? textDecoder?

Methods

load loadAndSplit scrape imports

Constructors

constructor

new GitbookLoader(webPath, params?): GitbookLoader
Parameters
- webPath: string
- params: GitbookLoaderParams = {}
Returns GitbookLoader
Overrides CheerioWebBaseLoader.constructor
- Defined in langchain/src/document_loaders/web/gitbook.ts:21

Properties

caller

caller: AsyncCaller

shouldLoadAllPaths

shouldLoadAllPaths: boolean = false

timeout

timeout: number

webPath

webPath: string

`Optional` selector

selector?: SelectorType

`Optional` textDecoder

textDecoder?: TextDecoder

Methods

load

load(): Promise<Document<Record<string, any>>[]>
Method that scrapes the web document using Cheerio and loads the content based on the value of shouldLoadAllPaths. If shouldLoadAllPaths is true, it calls the loadAllPaths() method to load all paths. Otherwise, it calls the loadPath() method to load a single path.

Returns Promise<Document<Record<string, any>>[]>
Promise resolving to an array of Document instances.
Overrides CheerioWebBaseLoader.load
- Defined in langchain/src/document_loaders/web/gitbook.ts:39

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 CheerioWebBaseLoader.loadAndSplit
- Defined in langchain/src/document_loaders/base.ts:32

scrape

scrape(): Promise<CheerioAPI>
Fetches the web document from the webPath and loads it using Cheerio. It returns a CheerioAPI instance.

Returns Promise<CheerioAPI>
A Promise that resolves to a CheerioAPI instance.
Inherited from CheerioWebBaseLoader.scrape
- Defined in langchain/src/document_loaders/web/cheerio.ts:87

`Static` imports

imports(): Promise<{
load: ((content, options?, isDocument?) => CheerioAPI);
}>
A static method that dynamically imports the Cheerio library and returns the load function. If the import fails, it throws an error.

Returns Promise<{
load: ((content, options?, isDocument?) => CheerioAPI);
}>
A Promise that resolves to an object containing the load function from the Cheerio library.
Inherited from CheerioWebBaseLoader.imports
- Defined in langchain/src/document_loaders/web/cheerio.ts:114

Generated using TypeDoc