Function refresh_openai_models

web/pgadmin/llm/__init__.py:552–614

Fetch available OpenAI models using a provided API key file path and/or custom API URL. Used by the preferences refresh button to load models before saving.

()

)
@pga_login_required
def refresh_openai_models():
    """
    Fetch available OpenAI models using a provided API key file path
    and/or custom API URL.
    Used by the preferences refresh button to load models before saving.
    """
    from pgadmin.llm.utils import (
        read_api_key_file, validate_api_key_path, validate_api_url
    )

    data = request.get_json(force=True, silent=True) or {}
    api_key_file = data.get('api_key_file', '')
    api_url = data.get('api_url', '')

    if api_url and not validate_api_url(api_url):
        return make_json_response(
            data={'models': [],
                  'error': 'API URL is not in the allowed list. '
                           'Contact your administrator to update '
                           'ALLOWED_LLM_API_URLS in the server '
                           'configuration.'},
            status=200
        )

    api_key = None
    if api_key_file:
        # Capture the resolved canonical path and pass it forward so
        # the file we open is the one we just validated (avoids a
        # symlink-swap TOCTOU between validation and read).
        safe_path = validate_api_key_path(api_key_file)
        if safe_path is None:
            return make_json_response(
                data={'models': [],
                      'error': 'API key file path is not permitted. '
                               'The file must be within your private '
                               'user storage directory; shared storage '
                               'and other locations are not allowed for '
                               'security reasons.'},
                status=200
            )
        api_key = read_api_key_file(safe_path)

    if not api_key and not api_url:
        return make_json_response(
            data={'models': [], 'error': 'No API key or custom URL provided'},
            status=200
        )

    try:
        models = _fetch_openai_models(api_key, api_url)
        return make_json_response(data={'models': models}, status=200)
    except LLMApiError as e:
        return make_json_response(
            data={'models': [], 'error': str(e)},
            status=200
        )
    except Exception:
        return make_json_response(