Class ConfluencePagesLoader

Class representing a document loader for loading pages from Confluence.

Hierarchy

BaseDocumentLoader
- ConfluencePagesLoader

Index

Constructors

Properties

accessToken baseUrl limit spaceKey username

Methods

load loadAndSplit fetchConfluenceData

Constructors

constructor

new ConfluencePagesLoader(__namedParameters): ConfluencePagesLoader
Parameters
- __namedParameters: ConfluencePagesLoaderParams
Returns ConfluencePagesLoader
Overrides BaseDocumentLoader.constructor
- Defined in langchain/src/document_loaders/web/confluence.ts:52

Properties

`Readonly` accessToken

accessToken: string

`Readonly` baseUrl

baseUrl: string

`Readonly` limit

limit: number

`Readonly` spaceKey

spaceKey: string

`Readonly` username

username: string

Methods

load

load(): Promise<Document<Record<string, any>>[]>
Fetches all the pages in the specified space and converts each page to a Document instance.

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

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

`Protected` fetchConfluenceData

fetchConfluenceData(url): Promise<ConfluenceAPIResponse>
Fetches data from the Confluence API using the provided URL.
Parameters
- url: string
  
  The URL to fetch data from.
Returns Promise<ConfluenceAPIResponse>
Promise resolving to the JSON response from the API.
- Defined in langchain/src/document_loaders/web/confluence.ts:87

Generated using TypeDoc