Source code for maeser.controllers.conversation_history_api

"""
Module for handling conversation history retrieval in a Flask API.

This module defines a controller function that retrieves the conversation history
for a given session and branch. The conversation history is processed to handle
system messages by applying HTML response formatting.

© 2024 Carson Bush, Blaine Freestone

This file is part of Maeser.

Maeser is free software: you can redistribute it and/or modify it under the terms of
the GNU Lesser General Public License as published by the Free Software Foundation,
either version 3 of the License, or (at your option) any later version.

Maeser is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with
Maeser. If not, see <https://www.gnu.org/licenses/>.
"""

from flask import jsonify, request
from maeser.render import get_response_html



def controller(session_handler):
    """
    Retrieves the conversation history for a given session and branch.

    Args:
        session_handler (object): An object that handles session management
            and provides a method to retrieve conversation history.

    Returns:
        dict: A dictionary containing the conversation history, with system
            messages having their content processed by the `get_response_html` function.

    The function expects the request data to contain 'session' and 'branch' keys,
    which are used to retrieve the conversation history from the `session_handler` object.
    If the conversation history contains 'messages', it iterates through them and processes
    the content of system messages using the `get_response_html` function. Finally, it
    returns the conversation history as a JSON response.
    """
    data = request.get_json()

    session = data.get('session')
    branch = data.get('branch')
    
    conversation_history = session_handler.get_conversation_history(branch, session)
    if 'messages' in conversation_history:
        for message in conversation_history['messages']:
            if message['role'] == 'system':
                message['content'] = get_response_html(message['content'])
            else:
                message['content'] = message['content']

    return jsonify(conversation_history)