autogen.tools.experimental.wikipedia.wikipedia.WikipediaClient

WikipediaClient

WikipediaClient(language: str = 'en', tool_name: str = 'wikipedia-client')

Client for interacting with the Wikipedia API.
Supports searching and page retrieval on a specified language edition.
Public methods:
search(query: str, limit: int) -> list[dict[str, Any]] get_page(title: str) -> Optional[wikipediaapi.WikipediaPage]

Attributes:
base_url (str): URL of the MediaWiki API endpoint.
headers (dict[str, str]): HTTP headers, including User-Agent.
wiki (wikipediaapi.Wikipedia): Low-level Wikipedia API client.
Initialize the WikipediaClient.

Parameters:

Name	Description
language	Type: str Default: ‘en’
tool_name	Type: str Default: ‘wikipedia-client’

Instance Methods

get_page

get_page(self, title: str) -> Any | None

Retrieve a WikipediaPage object by title.

Parameters:

Name	Description
title	Title of the Wikipedia page. Type: str

Returns:

Type	Description
Any | None	wikipediaapi.WikipediaPage | None: The page object if it exists, otherwise None.

search

search(
    self,
    query: str,
    limit: int = 3
) -> Any

Search Wikipedia for pages matching a query string.

Parameters:

Name	Description
query	The search keywords. Type: str
limit	Max number of results to return. Type: int Default: 3

Returns:

Type	Description
Any	list[dict[str, Any]]: Each dict has keys: - ‘title’ (str) - ‘size’ (int) - ‘wordcount’ (int) - ‘timestamp’ (str)