Skip to content

trading_agent.doctor.checks.searxng_check

Checks that the local SearXNG search server answers JSON searches.

Typical usage example:

result = SearxngCheck('http://127.0.0.1:4001').run()

SearxngCheck 

SearxngCheck(base_url)

Bases: DoctorCheck

Checks the web search server.

Creates the check.

Parameters:

Name Type Description Default
base_url str

The SearXNG server's address.

 required
Source code in src/trading_agent/doctor/checks/searxng_check.py 
20
21
22
23
24
25
26
def __init__(self, base_url: str):
    """Creates the check.

    Args:
        base_url (str): The SearXNG server's address.
    """
    self._base_url = base_url.rstrip('/')

run 

run()

Runs one small search and counts the results.

Returns:

Type Description
CheckResult

OK when results come back, failed when the server is down or JSON answers are switched off.
Source code in src/trading_agent/doctor/checks/searxng_check.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
def run(self) -> doctor_check.CheckResult:
    """Runs one small search and counts the results.

    Returns:
        doctor_check.CheckResult: OK when results come back, failed when the server is down or JSON answers are switched off.
    """
    try:
        response = httpx.get(
            f'{self._base_url}/search',
            params={
                'q': 'NSE India',
                'format': 'json',
            },
            timeout=_TIMEOUT_SECONDS,
        )
        response.raise_for_status()
    except httpx.HTTPError as error:
        return doctor_check.CheckResult(
            doctor_check.CheckStatus.FAILED,
            f'SearXNG at {self._base_url} did not answer ({error!r}); start it with: docker compose up -d',
        )
    result_count = len(response.json().get('results', []))
    if result_count == 0:
        return doctor_check.CheckResult(
            doctor_check.CheckStatus.WARNING,
            f'SearXNG at {self._base_url} answered, but with no results.',
        )
    return doctor_check.CheckResult(
        doctor_check.CheckStatus.OK,
        f'SearXNG at {self._base_url} returned {result_count} results.',
    )