Skip to content

wiki_source

ChunkMeta

Bases: TypedDict

titles instance-attribute

titles: list[str]

Chunk

Bases: TypedDict

text instance-attribute

text: str

meta instance-attribute

meta: ChunkMeta

WikiProvider

WikiProvider(user_agent: str, language: str = 'en')
PARAMETER DESCRIPTION
user_agent

TYPE: str

language

TYPE: str DEFAULT: 'en'

search

search(query: str, max_pages: int = 1) -> list[Chunk]
PARAMETER DESCRIPTION
query

TYPE: str

max_pages

TYPE: int DEFAULT: 1

build_tree

build_tree(
    sections: list[WikipediaPageSection],
    tree: _Tree | None = None,
) -> _Tree
PARAMETER DESCRIPTION
sections

TYPE: list[WikipediaPageSection]

tree

TYPE: _Tree | None DEFAULT: None

build_text_chunk

build_text_chunk(text: str, titles: list[str]) -> Chunk
PARAMETER DESCRIPTION
text

TYPE: str

titles

TYPE: list[str]

build_tree_chunks

build_tree_chunks(
    tree: _Tree, titles: list[str] | None = None
) -> list[Chunk]
PARAMETER DESCRIPTION
tree

TYPE: _Tree

titles

TYPE: list[str] | None DEFAULT: None