Class WikipediaQueryRun

Class for interacting with and fetching data from the Wikipedia API. It extends the Tool class.

Example

const wikipediaQuery = new WikipediaQueryRun({
  topKResults: 3,
  maxDocContentLength: 4000,
});
const result = await wikipediaQuery.call("Langchain");

Hierarchy (view full)

Constructors

constructor

Properties

description name baseUrl maxDocContentLength topKResults

Methods

content buildUrl

Constructors

constructor

Properties

description

description: string = "A tool for interacting with and fetching data from the Wikipedia API."

name

name: string = "wikipedia-api"

Protected baseUrl

baseUrl: string = "https://en.wikipedia.org/w/api.php"

Protected maxDocContentLength

maxDocContentLength: number = 4000

Protected topKResults

topKResults: number = 3

Methods

content

  • content(page, redirect?): Promise<string>

  • Fetches the content of a specific Wikipedia page. It returns the extracted content as a string.

    Parameters

    • page: string

      The specific Wikipedia page to fetch its content.

    • redirect: boolean = true

      A boolean value to indicate whether to redirect or not.

    Returns Promise<string>

    The extracted content of the specific Wikipedia page as a string.

Protected buildUrl

  • buildUrl<P>(parameters): string

  • Builds a URL for the Wikipedia API using the provided parameters.

    Type Parameters

    • P extends UrlParameters

    Parameters

    • parameters: P

      The parameters to be used in building the URL.

    Returns string

    A string representing the built URL.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc