.oO SearXNG Developer Documentation Oo.
|
Functions | |
bool | setup (dict[str, t.Any] engine_settings) |
None | request (str query, "OnlineParams" params) |
EngineResults | response ("SXNG_Response" resp) |
Variables | |
dict | about |
list | categories = ["science", "scientific publications"] |
bool | paging = True |
str | base_url = "https://api.adsabs.harvard.edu/v1/search/query" |
str | api_key = "unset" |
list | ads_field_list |
int | ads_rows = 10 |
str | ads_sort = "read_count desc" |
The Astrophysics Data System (ADS_) is a digital library portal for researchers in astronomy and physics, operated by the Smithsonian Astrophysical Observatory (SAO) under a NASA grant. The ADS_ is a solr instance, but not with the standard API paths. .. note:: The ADS_ engine requires an :py:obj:`API key <api_key>`. This engine uses the `search/query`_ API endpoint. Since the user's search term is passed through, the `search syntax`_ of ADS can be used (at least to some extent). .. _ADS: https://ui.adsabs.harvard.edu .. _search/query: https://ui.adsabs.harvard.edu/help/api/api-docs.html#get-/search/query .. _search syntax: https://ui.adsabs.harvard.edu/help/search/search-syntax Configuration ============= The engine has the following additional settings: - :py:obj:`api_key` - :py:obj:`ads_sort` .. code:: yaml - name: astrophysics data system api_key: "..." inactive: false Implementations ===============
None searx.engines.astrophysics_data_system.request | ( | str | query, |
"OnlineParams" | params ) |
Definition at line 110 of file astrophysics_data_system.py.
EngineResults searx.engines.astrophysics_data_system.response | ( | "SXNG_Response" | resp | ) |
Definition at line 125 of file astrophysics_data_system.py.
bool searx.engines.astrophysics_data_system.setup | ( | dict[str, t.Any] | engine_settings | ) |
Initialization of the ADS_ engine, checks whether the :py:obj:`api_key` is set, otherwise the engine is inactive.
Definition at line 99 of file astrophysics_data_system.py.
dict searx.engines.astrophysics_data_system.about |
Definition at line 52 of file astrophysics_data_system.py.
list searx.engines.astrophysics_data_system.ads_field_list |
Definition at line 68 of file astrophysics_data_system.py.
int searx.engines.astrophysics_data_system.ads_rows = 10 |
Definition at line 91 of file astrophysics_data_system.py.
str searx.engines.astrophysics_data_system.ads_sort = "read_count desc" |
Definition at line 94 of file astrophysics_data_system.py.
str searx.engines.astrophysics_data_system.api_key = "unset" |
Definition at line 65 of file astrophysics_data_system.py.
str searx.engines.astrophysics_data_system.base_url = "https://api.adsabs.harvard.edu/v1/search/query" |
Definition at line 63 of file astrophysics_data_system.py.
list searx.engines.astrophysics_data_system.categories = ["science", "scientific publications"] |
Definition at line 61 of file astrophysics_data_system.py.
bool searx.engines.astrophysics_data_system.paging = True |
Definition at line 62 of file astrophysics_data_system.py.