Copyright	(c) 2025 Tushar Adhatrao
License	MIT
Maintainer	Tushar Adhatrao <tusharadhatrao@gmail.com>
Stability	experimental
Safe Haskell	Safe-Inferred
Language	Haskell2010

Langchain.Tool.WikipediaTool

Contents

Configuration
Parameters
Internal types

Description

Synopsis

data WikipediaTool = WikipediaTool {
- topK :: Int
- docMaxChars :: Int
- languageCode :: Text
}
defaultWikipediaTool :: WikipediaTool
defaultTopK :: Int
defaultDocMaxChars :: Int
defaultLanguageCode :: Text
data SearchQuery = SearchQuery {
- search :: [SearchResult]
}
data SearchResponse = SearchResponse {
- query :: SearchQuery
}
data Page = Page {
- title :: Text
- extract :: Text
}
data SearchResult = SearchResult {
- ns :: Int
- title_ :: Text
- pageid :: Int
- size :: Int
- wordcount :: Int
- snippet :: Text
- timestamp :: Text
}
data Pages = Pages {
- pages :: Map String Page
}
data PageResponse = PageResponse {
- query :: Pages
}

Configuration

data WikipediaTool Source #

Wikipedia search tool configuration The tool uses Wikipedia's API to perform searches and retrieve page extracts.

Example configuration:

customTool = WikipediaTool
  { topK = 3
  , docMaxChars = 1000
  , languageCode = "es"
  }

Constructors

WikipediaTool
Fields topK :: Int Number of Wikipedia pages to include in the result. docMaxChars :: Int Number of characters to take from each page. languageCode :: Text Language code to use (e.g., "en" for English).

Instances

Instances details

Show WikipediaTool Source #
Instance details Defined in Langchain.Tool.WikipediaTool Methods showsPrec :: Int -> WikipediaTool -> ShowS # show :: WikipediaTool -> String # showList :: [WikipediaTool] -> ShowS #
Eq WikipediaTool Source #
Instance details Defined in Langchain.Tool.WikipediaTool Methods (==) :: WikipediaTool -> WikipediaTool -> Bool # (/=) :: WikipediaTool -> WikipediaTool -> Bool #
Runnable WikipediaTool Source #	Implements Runnable compatibility layer Note: The current implementation returns `Right` values only, though the type signature allows for future error handling. Example usage: response <- invoke defaultWikipediaTool "Artificial intelligence" case response of Right content -> putStrLn content Left err -> print err
Instance details Defined in Langchain.Tool.WikipediaTool Associated Types type RunnableInput WikipediaTool Source # type RunnableOutput WikipediaTool Source # Methods invoke :: WikipediaTool -> RunnableInput WikipediaTool -> IO (Either String (RunnableOutput WikipediaTool)) Source # batch :: WikipediaTool -> [RunnableInput WikipediaTool] -> IO (Either String [RunnableOutput WikipediaTool]) Source # stream :: WikipediaTool -> RunnableInput WikipediaTool -> (RunnableOutput WikipediaTool -> IO ()) -> IO (Either String ()) Source #
Tool WikipediaTool Source #	Tool instance for WikipediaTool.
Instance details Defined in Langchain.Tool.WikipediaTool Associated Types type Input WikipediaTool Source # type Output WikipediaTool Source # Methods toolName :: WikipediaTool -> Text Source # toolDescription :: WikipediaTool -> Text Source # runTool :: WikipediaTool -> Input WikipediaTool -> IO (Output WikipediaTool) Source #
type RunnableInput WikipediaTool Source #
Instance details Defined in Langchain.Tool.WikipediaTool type RunnableInput WikipediaTool = Text
type RunnableOutput WikipediaTool Source #
Instance details Defined in Langchain.Tool.WikipediaTool type RunnableOutput WikipediaTool = Text
type Input WikipediaTool Source #
Instance details Defined in Langchain.Tool.WikipediaTool type Input WikipediaTool = Text
type Output WikipediaTool Source #
Instance details Defined in Langchain.Tool.WikipediaTool type Output WikipediaTool = Text

defaultWikipediaTool :: WikipediaTool Source #

Wikipedia search tool configuration The tool uses Wikipedia's API to perform searches and retrieve page extracts.

Example configuration:

customTool = WikipediaTool
  { topK = 3
  , docMaxChars = 1000
  , languageCode = "es"
  }

Parameters

defaultTopK :: Int Source #

Default value for top K

defaultDocMaxChars :: Int Source #

Default value for max chars

defaultLanguageCode :: Text Source #

Default language

Internal types

data SearchQuery Source #

Type for list of search result

Constructors

SearchQuery
Fields search :: [SearchResult]

Instances

Instances details

FromJSON SearchQuery Source #
Instance details Defined in Langchain.Tool.WikipediaTool Methods parseJSON :: Value -> Parser SearchQuery # parseJSONList :: Value -> Parser [SearchQuery] # omittedField :: Maybe SearchQuery #
Show SearchQuery Source #
Instance details Defined in Langchain.Tool.WikipediaTool Methods showsPrec :: Int -> SearchQuery -> ShowS # show :: SearchQuery -> String # showList :: [SearchQuery] -> ShowS #

data SearchResponse Source #

Data types for JSON parsing.

Constructors

SearchResponse
Fields query :: SearchQuery

Instances

Instances details

FromJSON SearchResponse Source #
Instance details Defined in Langchain.Tool.WikipediaTool Methods parseJSON :: Value -> Parser SearchResponse # parseJSONList :: Value -> Parser [SearchResponse] # omittedField :: Maybe SearchResponse #
Generic SearchResponse Source #
Instance details Defined in Langchain.Tool.WikipediaTool Associated Types type Rep SearchResponse :: Type -> Type # Methods from :: SearchResponse -> Rep SearchResponse x # to :: Rep SearchResponse x -> SearchResponse #
Show SearchResponse Source #
Instance details Defined in Langchain.Tool.WikipediaTool Methods showsPrec :: Int -> SearchResponse -> ShowS # show :: SearchResponse -> String # showList :: [SearchResponse] -> ShowS #
type Rep SearchResponse Source #
Instance details Defined in Langchain.Tool.WikipediaTool type Rep SearchResponse = D1 ('MetaData "SearchResponse" "Langchain.Tool.WikipediaTool" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "SearchResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "query") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SearchQuery)))

data Page Source #

Represents wikipedia page

Constructors

Page
Fields title :: Text extract :: Text

Instances

Instances details

FromJSON Page Source #
Instance details Defined in Langchain.Tool.WikipediaTool Methods parseJSON :: Value -> Parser Page # parseJSONList :: Value -> Parser [Page] # omittedField :: Maybe Page #
Show Page Source #
Instance details Defined in Langchain.Tool.WikipediaTool Methods showsPrec :: Int -> Page -> ShowS # show :: Page -> String # showList :: [Page] -> ShowS #
Eq Page Source #
Instance details Defined in Langchain.Tool.WikipediaTool Methods (==) :: Page -> Page -> Bool # (/=) :: Page -> Page -> Bool #

data SearchResult Source #

Result of SearchResult

Constructors

SearchResult
Fields ns :: Int title_ :: Text pageid :: Int size :: Int wordcount :: Int snippet :: Text timestamp :: Text

Instances

Instances details

FromJSON SearchResult Source #
Instance details Defined in Langchain.Tool.WikipediaTool Methods parseJSON :: Value -> Parser SearchResult # parseJSONList :: Value -> Parser [SearchResult] # omittedField :: Maybe SearchResult #
Show SearchResult Source #
Instance details Defined in Langchain.Tool.WikipediaTool Methods showsPrec :: Int -> SearchResult -> ShowS # show :: SearchResult -> String # showList :: [SearchResult] -> ShowS #

data Pages Source #

Collection of Wikipedia pages, where key is page id

Constructors

Pages
Fields pages :: Map String Page

Instances

Instances details

FromJSON Pages Source #
Instance details Defined in Langchain.Tool.WikipediaTool Methods parseJSON :: Value -> Parser Pages # parseJSONList :: Value -> Parser [Pages] # omittedField :: Maybe Pages #
Generic Pages Source #
Instance details Defined in Langchain.Tool.WikipediaTool Associated Types type Rep Pages :: Type -> Type # Methods from :: Pages -> Rep Pages x # to :: Rep Pages x -> Pages #
Show Pages Source #
Instance details Defined in Langchain.Tool.WikipediaTool Methods showsPrec :: Int -> Pages -> ShowS # show :: Pages -> String # showList :: [Pages] -> ShowS #
Eq Pages Source #
Instance details Defined in Langchain.Tool.WikipediaTool Methods (==) :: Pages -> Pages -> Bool # (/=) :: Pages -> Pages -> Bool #
type Rep Pages Source #
Instance details Defined in Langchain.Tool.WikipediaTool type Rep Pages = D1 ('MetaData "Pages" "Langchain.Tool.WikipediaTool" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "Pages" 'PrefixI 'True) (S1 ('MetaSel ('Just "pages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map String Page))))

data PageResponse Source #

Wikipedia response

Constructors

PageResponse
Fields query :: Pages

Instances

Instances details

FromJSON PageResponse Source #
Instance details Defined in Langchain.Tool.WikipediaTool Methods parseJSON :: Value -> Parser PageResponse # parseJSONList :: Value -> Parser [PageResponse] # omittedField :: Maybe PageResponse #
Generic PageResponse Source #
Instance details Defined in Langchain.Tool.WikipediaTool Associated Types type Rep PageResponse :: Type -> Type # Methods from :: PageResponse -> Rep PageResponse x # to :: Rep PageResponse x -> PageResponse #
Show PageResponse Source #
Instance details Defined in Langchain.Tool.WikipediaTool Methods showsPrec :: Int -> PageResponse -> ShowS # show :: PageResponse -> String # showList :: [PageResponse] -> ShowS #
Eq PageResponse Source #
Instance details Defined in Langchain.Tool.WikipediaTool Methods (==) :: PageResponse -> PageResponse -> Bool # (/=) :: PageResponse -> PageResponse -> Bool #
type Rep PageResponse Source #
Instance details Defined in Langchain.Tool.WikipediaTool type Rep PageResponse = D1 ('MetaData "PageResponse" "Langchain.Tool.WikipediaTool" "langchain-hs-0.0.1.0-inplace" 'False) (C1 ('MetaCons "PageResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "query") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Pages)))