ConversationModel.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2023-2023 Istituto Italiano di Tecnologia (IIT)
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef CONVERSATIONMODEL_H
#define CONVERSATIONMODEL_H
 
#include <yarp/os/Bottle.h>
#include <yarp/os/BufferedPort.h>
#include <yarp/os/Log.h>
#include <yarp/os/LogStream.h>
#include <yarp/os/Property.h>
 
#include <yarp/dev/ILLM.h>
#include <yarp/dev/LLM_Message.h>
#include <yarp/dev/PolyDriver.h>
 
#include <ConversationCallback.h>
#include <QAbstractListModel>
 
class Message
{
public:
    Message(const QString& type, const QString& content) :
            m_type {type}, m_content {content}
    {
    }
 
    QString type() const
    {
        return m_type;
    }
    QString content() const
    {
        return m_content;
    }
 
private:
    QString m_type;
    QString m_content;
};
 
class ConversationModel : public QAbstractListModel
{
    Q_OBJECT
 
public:
    enum ConversationRoles
    {
        TypeRole = Qt::UserRole + 1,
        ContentRole
    };
 
    explicit ConversationModel(QObject* parent = nullptr) :
            QAbstractListModel(parent)
    {
        m_prop.put("device", "LLM_nwc_yarp");
        m_prop.put("local", m_local_rpc_port);
    }
 
    ~ConversationModel()
    {
        m_conversation_port.close();
        m_poly.close();
    }
 
    bool configure(const std::string& remote_rpc, const std::string& streaming_port_name);
 
    // QAbstractListModel overrides
    QVariant data(const QModelIndex& index, int role) const override;
    int rowCount(const QModelIndex& parent = QModelIndex()) const override;
 
    Q_INVOKABLE void deleteConversation();
    Q_INVOKABLE void eraseMessage(const int& index);
 
    Q_INVOKABLE void sendMessage(const QString& message);
 
    Q_INVOKABLE void configure(const QString& remote_rpc, const QString& streaming_port_name);
 
public slots:
 
    void refreshConversation();
 
protected:
    QHash<int, QByteArray> roleNames() const override;
 
private:
    yarp::dev::PolyDriver m_poly;
    yarp::os::Property m_prop;
 
    yarp::dev::ILLM* m_iLlm = nullptr;
    ConversationCallback m_callback;
    QList<Message> m_conversation;
    yarp::os::BufferedPort<yarp::os::Bottle> m_conversation_port;
    const std::string m_conversation_port_name = "/llmgui/conv:i";
    const std::string m_local_rpc_port = "/yarpllmgui/rpc";
    const std::string m_no_device_message = "yarpLLMGui: no LLM_nwc was found. Operation is not allowed.";
 
    void setRemoteRpc(const std::string& remoteRpc);
    bool setRemoteStreamingPort(const std::string& remote_streaming_port_name);
    bool setInterface();
    void addMessage(const Message& message);
    void eraseConversation();
};
 
#endif // CONVERSATIONMODEL_H