mirrors/searxng
1
0
Fork 0
mirror of https://github.com/searxng/searxng.git synced 2025-03-01 02:01:01 +00:00
Code Issues Projects Releases Wiki Activity
searxng/docs/dev/engines/index.rst
Markus Heiser 36a1ef1239 [refactor] typification of SearXNG / EngineResults 
In [1] and [2] we discussed the need of a Result.results property and how we can
avoid unclear code.  This patch implements a class for the reslut-lists of
engines::

    searx.result_types.EngineResults

A simple example for the usage in engine development::

    from searx.result_types import EngineResults
    ...
    def response(resp) -> EngineResults:
        res = EngineResults()
        ...
        res.add( res.types.Answer(answer="lorem ipsum ..", url="https://example.org") )
        ...
        return res

[1] https://github.com/searxng/searxng/pull/4183#pullrequestreview-257400034
[2] https://github.com/searxng/searxng/pull/4183#issuecomment-2614301580
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2025-01-28 07:07:08 +01:00

1.9 KiB
Raw Blame History

Engine Implementations

enginelib engines engine_overview

ResultList and engines

searx.result_types.ResultList

searx.result_types.EngineResults

Engine Types

The :pyengine_type <searx.enginelib.Engine.engine_type> of an engine determines which search processor <searx.search.processors> is used by the engine.

In this section a list of the engines that are documented is given, a complete list of the engines can be found in the source under: searx/engines.

Online Engines

info

  • :pyprocessors.online <searx.search.processors.online>

demo/demo_online xpath mediawiki json_engine

online/*

Offline Engines

info

  • :pyprocessors.offline <searx.search.processors.offline>

offline_concept demo/demo_offline offline/*

Online URL Search

info

  • :pyprocessors.online_url_search <searx.search.processors.online_url_search>

online_url_search/*

Online Currency

info

  • :pyprocessors.online_currency <searx.search.processors.online_currency>

no engine of this type is documented yet / coming soon

Online Dictionary

info

  • :pyprocessors.online_dictionary <searx.search.processors.online_dictionary>

no engine of this type is documented yet / coming soon