Skip to main content
Ctrl+K

WikibaseIntegrator

  • User guide
  • API reference
  • Changelog
  • GitHub
  • PyPI
  • User guide
  • API reference
  • Changelog
  • GitHub
  • PyPI

Section Navigation

  • WikibaseIntegrator
    • WikibaseIntegrator
  • Entities
    • ItemEntity
    • PropertyEntity
    • LexemeEntity
    • MediaInfoEntity
    • BaseEntity
    • TermsEntity
  • Data types
    • BaseDataType
    • CommonsMedia
    • EntitySchema
    • ExternalID
    • Form
    • GeoShape
    • GlobeCoordinate
    • Item
    • Lexeme
    • Math
    • MonolingualText
    • MusicalNotation
    • Property
    • Quantity
    • Sense
    • String
    • TabularData
    • Time
    • URL
    • EDTF
    • LocalMedia
  • Models
    • Claim
    • Claims
    • Snak
    • Snaks
    • Qualifiers
    • Reference
    • References
    • Labels
    • Descriptions
    • Aliases
    • Alias
    • LanguageValues
    • LanguageValue
    • Sitelinks
    • Sitelink
    • Lemmas
    • Forms
    • Form
    • Representations
    • Senses
    • Sense
    • Glosses
    • BaseModel
  • Login
    • OAuth2
    • OAuth1
    • Login
    • Clientlogin
    • WCQSAuth
    • LoginError
  • Helpers
    • mediawiki_api_call_helper
    • mediawiki_api_call
    • edit_entity
    • search_entities
    • fulltext_search
    • generate_entity_instances
    • execute_sparql_query
    • merge_items
    • merge_multiple_items
    • merge_lexemes
    • create_redirect
    • set_claim
    • remove_claims
    • delete_page
    • lexeme_add_form
    • lexeme_edit_form
    • lexeme_remove_form
    • lexeme_add_sense
    • lexeme_edit_sense
    • lexeme_remove_sense
    • parse_value
    • format_amount
    • get_available_badges
    • check_constraints
    • check_wikibase
    • WikibaseCheck
    • get_user_agent
    • download_entity_ttl
    • format2wbi
  • Fast run
    • FastRunContainer
    • get_fastrun_container
  • Configuration, enums and exceptions
    • ActionIfExists
    • EntityField
    • WikibaseDatatype
    • WikibaseRank
    • WikibaseSnakType
    • WikibaseTimePrecision
    • MWApiError
    • ModificationFailed
    • SaveFailed
    • NonExistentEntityError
    • MissingExtensionError
    • MissingEntityException
    • EmptyValueError
    • UnknownDatatypeError
    • AnonymousEditNotAllowedError
    • MaxRetriesReachedException
    • SearchError
    • WCQSAuthenticationError
    • wbi_backoff
    • RetryAfterError
    • wbi_backoff_wait
    • wbi_backoff_giveup
    • get_manifest
    • WikibaseManifest
    • manifest_url
    • EditGroup
  • API reference
  • Helpers
  • fulltext_search

fulltext_search#

wikibaseintegrator.wbi_helpers.fulltext_search(search, max_results=50, allow_anonymous=True, **kwargs)[source]#

Perform a fulltext search on the mediawiki instance. It’s an exception to the “only wikibase related function” rule! WikibaseIntegrator is focused on wikibase-only functions to avoid spreading out and covering all functions of MediaWiki.

Parameters:
  • search (str) – Search for page titles or content matching this value. You can use the search string to invoke special search features, depending on what the wiki’s search backend implements.

  • max_results (int, default: 50) – How many total pages to return. The value must be between 1 and 500.

  • allow_anonymous (bool, default: True) – Allow anonymous interaction with the MediaWiki API. ‘True’ by default.

  • kwargs (Any) – Extra parameters for mediawiki_api_call_helper()

Return type:

list[dict[str, Any]]

Returns:

previous

search_entities

next

generate_entity_instances

On this page
  • fulltext_search()
Edit on GitHub
Show Source

© Copyright 2026, LeMyst.

Created using Sphinx 9.2.0.

Built with the PyData Sphinx Theme 0.23.0.