BetaBetaCreate a new Fulltext search
Session to use for requests.
Search query
Search params
OptionaldslFts?: booleanEnable Domain-Specific Query language
Optionallimit?: numberMaximum amount of results to return. By default all results will be returned
OptionalmaxRetries?: numberMaximum number of retries for each API call (default: 5)
Optionalscope?: IaScopeThe scope of the query.
Possible values are 'standard' or 'all'.
The 'all' scope requires authorization
Optionalsize?: numberSpecifies how many results to return per page, positive integer
Protected Optional Readonly BetalimitProtected BetanumProtected Readonly BetaparamsProtected BetaqueryProtected Readonly BetasessionProtected Readonly BetasizeProtected Readonly BetaurlProtectedfetchBetaGet aggregations for the query.
object with aggregations for
"top-collection", "top-mediatype", "top-year",
"top-subject", "top-languages" and "top-creator".
BetaGenerator which yields Items that match the full text query
BetaGet the number if items found by this query.
Note that this number can change over time. The number also gets updated with every call to the search API.
Number of items found
BetaCreate a generator that yields search results.
The maximum amount of results returned can be defined by limit.
If limit is not set, all results will be returned, which may
require a lot of slow requests to be made to fetch all results.
AsyncGenerator which yields one Full Text Search result at a time.
BetaBeta
This class creates a full text search using the Internet Archive FTS API endpoint. It offers methods for fetching a single page of results, creating an AsyncGenerator that continuously yields results, and a method that returns pre-defined aggregations.