search-wikipedia

Documentation / search/search-wikipedia

Search

searchWikipedia()

function searchWikipedia(query: string, options?: object): object;

Defined in: packages/ai-research-agent/src/search/search-wikipedia.js:23

Function to query phrase in Wikipedia Search API and return page titles, images and first few sentences of each result. Wikipedia Search API has complex documentation and is dificult to parse and clean up results.

Parameters

Parameter	Type	Description
query	string	search phrase
options?	{ plainText: boolean; summarySentenceLimit: number; limitSearchResults: number; images: boolean; imageSize: number; searchInTitleOnly: boolean; filterDisambiguation: boolean; }
options.plainText?	boolean	default=false Return plain text instead of HTML
options.summarySentenceLimit?	number	default=3 Limit summary to this many sentences
options.limitSearchResults?	number	default=1 Limit number of search results
options.images?	boolean	default=true Include image in results
options.imageSize?	number	default=200 Image size in pixels
options.searchInTitleOnly?	boolean	default=false Search in title only
options.filterDisambiguation?	boolean	default=true Filter disambiguation pages

Returns

object

Name	Type	Defined in
results	object[]	packages/ai-research-agent/src/search/search-wikipedia.js:19

Example

await searchWikipedia("JavaScript", { plainText: true })

Author

ai-research-agent (2024)