Skip to content

trading_agent.doctor.checks.openai_compatible_backend_check

Checks that an OpenAI-compatible backend's server answers.

A 401 answer means the server is running but wants an API key, which is reported as a warning until the key is configured.

Typical usage example:

result = OpenAICompatibleBackendCheck('qwen', backend_configuration).run()

OpenAICompatibleBackendCheck 

OpenAICompatibleBackendCheck(backend_name, backend_configuration)

Bases: DoctorCheck

Checks one backend of kind "openai_compatible".

Creates the check.

Parameters:

Name Type Description Default
backend_name str

The backend's name in trading_agent.toml.

 required
backend_configuration BackendConfiguration

Its settings.

 required
Source code in src/trading_agent/doctor/checks/openai_compatible_backend_check.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
def __init__(
    self,
    backend_name: str,
    backend_configuration: agent_configuration.BackendConfiguration,
):
    """Creates the check.

    Args:
        backend_name (str): The backend's name in trading_agent.toml.
        backend_configuration (agent_configuration.BackendConfiguration): Its settings.
    """
    self.name = f'Backend {backend_name} (OpenAI-compatible)'
    self._backend_configuration = backend_configuration

run 

run()

Asks the server for its list of models.

Returns:

Type Description
CheckResult

OK when it answers, a warning when it needs an API key, failed when it is unreachable.
Source code in src/trading_agent/doctor/checks/openai_compatible_backend_check.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def run(self) -> doctor_check.CheckResult:
    """Asks the server for its list of models.

    Returns:
        doctor_check.CheckResult: OK when it answers, a warning when it needs an API key, failed when it is unreachable.
    """
    base_url = self._backend_configuration.base_url
    try:
        response = httpx.get(f'{base_url}/models', timeout=_TIMEOUT_SECONDS)
    except httpx.HTTPError as error:
        return doctor_check.CheckResult(
            doctor_check.CheckStatus.FAILED,
            f'Server at {base_url} did not answer: {error!r}',
        )
    if response.status_code == _UNAUTHORIZED:
        return doctor_check.CheckResult(
            doctor_check.CheckStatus.WARNING,
            f'Server at {base_url} is running but needs an API key (added in milestone 4).',
        )
    if response.is_error:
        return doctor_check.CheckResult(
            doctor_check.CheckStatus.FAILED,
            f'Server at {base_url} answered HTTP {response.status_code}.',
        )
    return doctor_check.CheckResult(
        doctor_check.CheckStatus.OK,
        f'Server at {base_url} answered.',
    )