langchain.js
    Preparing search index...

    Class ConfluencePagesLoader

    Class representing a document loader for loading pages from Confluence.

    const loader = new ConfluencePagesLoader({
      baseUrl: "https:
      spaceKey: "~EXAMPLE362906de5d343d49dcdbae5dEXAMPLE",
      username: "your-username",
      accessToken: "your-access-token",
    });
    const documents = await loader.load();
    console.log(documents);

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    accessToken? baseUrl expand? limit maxRetries personalAccessToken? spaceKey username?

    Methods

    fetchConfluenceData load

    Constructors

    Properties

    accessToken?: string
    baseUrl: string
    expand?: string

    expand parameter for confluence rest api description can be found at https://developer.atlassian.com/server/confluence/expansions-in-the-rest-api/

    limit: number
    maxRetries: number
    personalAccessToken?: string
    spaceKey: string
    username?: string

    Methods

    • 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.

    • Fetches all the pages in the specified space and converts each page to a Document instance.

      Parameters

      • Optionaloptions: { limit?: number; start?: number }

        the extra options of the load function

        • Optionallimit?: number

          The limit parameter to overwrite the size to fetch pages.

        • Optionalstart?: number

          The start parameter to set inital offset to fetch pages.

      Returns Promise<Document[]>

      Promise resolving to an array of Document instances.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods