Class GitbookLoader

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

Hierarchy (view full)

CheerioWebBaseLoader
- GitbookLoader

Index

Constructors

constructor

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

Properties

caller

caller: AsyncCaller

shouldLoadAllPaths

shouldLoadAllPaths: boolean = false

timeout

timeout: number

webPath

webPath: string

`Optional` headers

headers?: Record<string, string> | [string, string][] | Headers

`Optional` selector

selector?: `.${number}${string}` | `.i${string}` | `.a${string}` | `.b${string}` | `.c${string}` | `.d${string}` | `.e${string}` | `.f${string}` | `.g${string}` | `.h${string}` | `.j${string}` | `.k${string}` | `.l${string}` | `.m${string}` | `.n${string}` | `.o${string}` | `.p${string}` | `.q${string}` | `.r${string}` | `.s${string}` | `.t${string}` | `.u${string}` | `.v${string}` | `.w${string}` | `.x${string}` | `.y${string}` | `.z${string}` | `.I${string}` | `.A${string}` | `.B${string}` | `.C${string}` | `.D${string}` | `.E${string}` | `.F${string}` | `.G${string}` | `.H${string}` | `.J${string}` | `.K${string}` | `.L${string}` | `.M${string}` | `.N${string}` | `.O${string}` | `.P${string}` | `.Q${string}` | `.R${string}` | `.S${string}` | `.T${string}` | `.U${string}` | `.V${string}` | `.W${string}` | `.X${string}` | `.Y${string}` | `.Z${string}` | `#${number}${string}` | `#i${string}` | `#a${string}` | `#b${string}` | `#c${string}` | `#d${string}` | `#e${string}` | `#f${string}` | `#g${string}` | `#h${string}` | `#j${string}` | `#k${string}` | `#l${string}` | `#m${string}` | `#n${string}` | `#o${string}` | `#p${string}` | `#q${string}` | `#r${string}` | `#s${string}` | `#t${string}` | `#u${string}` | `#v${string}` | `#w${string}` | `#x${string}` | `#y${string}` | `#z${string}` | `#I${string}` | `#A${string}` | `#B${string}` | `#C${string}` | `#D${string}` | `#E${string}` | `#F${string}` | `#G${string}` | `#H${string}` | `#J${string}` | `#K${string}` | `#L${string}` | `#M${string}` | `#N${string}` | `#O${string}` | `#P${string}` | `#Q${string}` | `#R${string}` | `#S${string}` | `#T${string}` | `#U${string}` | `#V${string}` | `#W${string}` | `#X${string}` | `#Y${string}` | `#Z${string}` | `:${number}${string}` | `:i${string}` | `:a${string}` | `:b${string}` | `:c${string}` | `:d${string}` | `:e${string}` | `:f${string}` | `:g${string}` | `:h${string}` | `:j${string}` | `:k${string}` | `:l${string}` | `:m${string}` | `:n${string}` | `:o${string}` | `:p${string}` | `:q${string}` | `:r${string}` | `:s${string}` | `:t${string}` | `:u${string}` | `:v${string}` | `:w${string}` | `:x${string}` | `:y${string}` | `:z${string}` | `:I${string}` | `:A${string}` | `:B${string}` | `:C${string}` | `:D${string}` | `:E${string}` | `:F${string}` | `:G${string}` | `:H${string}` | `:J${string}` | `:K${string}` | `:L${string}` | `:M${string}` | `:N${string}` | `:O${string}` | `:P${string}` | `:Q${string}` | `:R${string}` | `:S${string}` | `:T${string}` | `:U${string}` | `:V${string}` | `:W${string}` | `:X${string}` | `:Y${string}` | `:Z${string}` | `|${number}${string}` | `|i${string}` | `|a${string}` | `|b${string}` | `|c${string}` | `|d${string}` | `|e${string}` | `|f${string}` | `|g${string}` | `|h${string}` | `|j${string}` | `|k${string}` | `|l${string}` | `|m${string}` | `|n${string}` | `|o${string}` | `|p${string}` | `|q${string}` | `|r${string}` | `|s${string}` | `|t${string}` | `|u${string}` | `|v${string}` | `|w${string}` | `|x${string}` | `|y${string}` | `|z${string}` | `|I${string}` | `|A${string}` | `|B${string}` | `|C${string}` | `|D${string}` | `|E${string}` | `|F${string}` | `|G${string}` | `|H${string}` | `|J${string}` | `|K${string}` | `|L${string}` | `|M${string}` | `|N${string}` | `|O${string}` | `|P${string}` | `|Q${string}` | `|R${string}` | `|S${string}` | `|T${string}` | `|U${string}` | `|V${string}` | `|W${string}` | `|X${string}` | `|Y${string}` | `|Z${string}` | `>${number}${string}` | `>i${string}` | `>a${string}` | `>b${string}` | `>c${string}` | `>d${string}` | `>e${string}` | `>f${string}` | `>g${string}` | `>h${string}` | `>j${string}` | `>k${string}` | `>l${string}` | `>m${string}` | `>n${string}` | `>o${string}` | `>p${string}` | `>q${string}` | `>r${string}` | `>s${string}` | `>t${string}` | `>u${string}` | `>v${string}` | `>w${string}` | `>x${string}` | `>y${string}` | `>z${string}` | `>I${string}` | `>A${string}` | `>B${string}` | `>C${string}` | `>D${string}` | `>E${string}` | `>F${string}` | `>G${string}` | `>H${string}` | `>J${string}` | `>K${string}` | `>L${string}` | `>M${string}` | `>N${string}` | `>O${string}` | `>P${string}` | `>Q${string}` | `>R${string}` | `>S${string}` | `>T${string}` | `>U${string}` | `>V${string}` | `>W${string}` | `>X${string}` | `>Y${string}` | `>Z${string}` | `+${number}${string}` | `+i${string}` | `+a${string}` | `+b${string}` | `+c${string}` | `+d${string}` | `+e${string}` | `+f${string}` | `+g${string}` | `+h${string}` | `+j${string}` | `+k${string}` | `+l${string}` | `+m${string}` | `+n${string}` | `+o${string}` | `+p${string}` | `+q${string}` | `+r${string}` | `+s${string}` | `+t${string}` | `+u${string}` | `+v${string}` | `+w${string}` | `+x${string}` | `+y${string}` | `+z${string}` | `+I${string}` | `+A${string}` | `+B${string}` | `+C${string}` | `+D${string}` | `+E${string}` | `+F${string}` | `+G${string}` | `+H${string}` | `+J${string}` | `+K${string}` | `+L${string}` | `+M${string}` | `+N${string}` | `+O${string}` | `+P${string}` | `+Q${string}` | `+R${string}` | `+S${string}` | `+T${string}` | `+U${string}` | `+V${string}` | `+W${string}` | `+X${string}` | `+Y${string}` | `+Z${string}` | `~${number}${string}` | `~i${string}` | `~a${string}` | `~b${string}` | `~c${string}` | `~d${string}` | `~e${string}` | `~f${string}` | `~g${string}` | `~h${string}` | `~j${string}` | `~k${string}` | `~l${string}` | `~m${string}` | `~n${string}` | `~o${string}` | `~p${string}` | `~q${string}` | `~r${string}` | `~s${string}` | `~t${string}` | `~u${string}` | `~v${string}` | `~w${string}` | `~x${string}` | `~y${string}` | `~z${string}` | `~I${string}` | `~A${string}` | `~B${string}` | `~C${string}` | `~D${string}` | `~E${string}` | `~F${string}` | `~G${string}` | `~H${string}` | `~J${string}` | `~K${string}` | `~L${string}` | `~M${string}` | `~N${string}` | `~O${string}` | `~P${string}` | `~Q${string}` | `~R${string}` | `~S${string}` | `~T${string}` | `~U${string}` | `~V${string}` | `~W${string}` | `~X${string}` | `~Y${string}` | `~Z${string}` | `[${number}${string}` | `[i${string}` | `[a${string}` | `[b${string}` | `[c${string}` | `[d${string}` | `[e${string}` | `[f${string}` | `[g${string}` | `[h${string}` | `[j${string}` | `[k${string}` | `[l${string}` | `[m${string}` | `[n${string}` | `[o${string}` | `[p${string}` | `[q${string}` | `[r${string}` | `[s${string}` | `[t${string}` | `[u${string}` | `[v${string}` | `[w${string}` | `[x${string}` | `[y${string}` | `[z${string}` | `[I${string}` | `[A${string}` | `[B${string}` | `[C${string}` | `[D${string}` | `[E${string}` | `[F${string}` | `[G${string}` | `[H${string}` | `[J${string}` | `[K${string}` | `[L${string}` | `[M${string}` | `[N${string}` | `[O${string}` | `[P${string}` | `[Q${string}` | `[R${string}` | `[S${string}` | `[T${string}` | `[U${string}` | `[V${string}` | `[W${string}` | `[X${string}` | `[Y${string}` | `[Z${string}` | `${number}${string}` | `i${string}` | `a${string}` | `b${string}` | `c${string}` | `d${string}` | `e${string}` | `f${string}` | `g${string}` | `h${string}` | `j${string}` | `k${string}` | `l${string}` | `m${string}` | `n${string}` | `o${string}` | `p${string}` | `q${string}` | `r${string}` | `s${string}` | `t${string}` | `u${string}` | `v${string}` | `w${string}` | `x${string}` | `y${string}` | `z${string}` | `I${string}` | `A${string}` | `B${string}` | `C${string}` | `D${string}` | `E${string}` | `F${string}` | `G${string}` | `H${string}` | `J${string}` | `K${string}` | `L${string}` | `M${string}` | `N${string}` | `O${string}` | `P${string}` | `Q${string}` | `R${string}` | `S${string}` | `T${string}` | `U${string}` | `V${string}` | `W${string}` | `X${string}` | `Y${string}` | `Z${string}`

`Optional` textDecoder

textDecoder?: TextDecoder

Methods

load

load(): Promise<Document[]>
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[]>
Promise resolving to an array of Document instances.
Overrides CheerioWebBaseLoader.load
- Defined in libs/langchain-community/src/document_loaders/web/gitbook.ts:42

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 libs/langchain-community/src/document_loaders/web/cheerio.ts:125

`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 libs/langchain-community/src/document_loaders/web/cheerio.ts:154

`Static` scrapeAll

scrapeAll(urls, caller, timeout, textDecoder?, options?): Promise<CheerioAPI[]>
Fetches web documents from the given array of URLs and loads them using Cheerio. It returns an array of CheerioAPI instances.
Parameters
- urls: string[]
  An array of URLs to fetch and load.
- caller: AsyncCaller
- timeout: undefined | number
- Optional textDecoder: TextDecoder
- Optional options: CheerioOptions & {
  headers?: Record<string, string> | [string, string][] | Headers;
  }
Returns Promise<CheerioAPI[]>
A Promise that resolves to an array of CheerioAPI instances.
Inherited from CheerioWebBaseLoader.scrapeAll
- Defined in libs/langchain-community/src/document_loaders/web/cheerio.ts:83

Class GitbookLoader

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

webPath: string

params: GitbookLoaderParams = {}

Returns GitbookLoader

Properties

caller

shouldLoadAllPaths

timeout

webPath

`Optional` headers

`Optional` selector

`Optional` textDecoder

Methods

load

Returns Promise<Document[]>

scrape

Returns Promise<CheerioAPI>

`Static` imports

Returns Promise<{
load: ((content, options?, isDocument?) => CheerioAPI);
}>

`Static` scrapeAll

Parameters

urls: string[]

caller: AsyncCaller

timeout: undefined | number

`Optional` textDecoder: TextDecoder

`Optional` options: CheerioOptions & {
headers?: Record<string, string> | [string, string][] | Headers;
}

Returns Promise<CheerioAPI[]>

Settings

Member Visibility

Theme

On This Page

Class GitbookLoader

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

webPath: string

params: GitbookLoaderParams = {}

Returns GitbookLoader

Properties

caller

shouldLoadAllPaths

timeout

webPath

Optional headers

Optional selector

Optional textDecoder

Methods

load

Returns Promise<Document[]>

scrape

Returns Promise<CheerioAPI>

Static imports

Returns Promise<{ load: ((content, options?, isDocument?) => CheerioAPI); }>

Static scrapeAll

Parameters

urls: string[]

caller: AsyncCaller

timeout: undefined | number

Optional textDecoder: TextDecoder

Optional options: CheerioOptions & { headers?: Record<string, string> | [string, string][] | Headers; }

Returns Promise<CheerioAPI[]>

Settings

Member Visibility

Theme

On This Page

`Optional` headers

`Optional` selector

`Optional` textDecoder

`Static` imports

Returns Promise<{
load: ((content, options?, isDocument?) => CheerioAPI);
}>

`Static` scrapeAll

`Optional` textDecoder: TextDecoder

`Optional` options: CheerioOptions & {
headers?: Record<string, string> | [string, string][] | Headers;
}