Thu, 29 Aug 2024 13:15:36 +0200
Generated source code documentation.
<!DOCTYPE html> <html><head> <title>Plugin_AI_Ollama.OllamaInterface.OllamaChatMessageBox</title> <meta charset="UTF-8"> <link rel="stylesheet" href="styles.css"> </head> <body> <a NAME="top" ID="top"></a> <h1>Plugin_AI_Ollama.OllamaInterface.OllamaChatMessageBox</h1> <p> Module implementing a message box widget showing the role and content of a message. </p> <h3>Global Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> <table> <tr> <td><a href="#OllamaChatMessageBox">OllamaChatMessageBox</a></td> <td>Class implementing a message box widget showing the role and content of a message.</td> </tr> </table> <h3>Functions</h3> <table> <tr><td>None</td></tr> </table> <hr /> <hr /> <a NAME="OllamaChatMessageBox" ID="OllamaChatMessageBox"></a> <h2>OllamaChatMessageBox</h2> <p> Class implementing a message box widget showing the role and content of a message. </p> <h3>Derived from</h3> QWidget <h3>Class Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Class Methods</h3> <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> <table> <tr> <td><a href="#OllamaChatMessageBox.__init__">OllamaChatMessageBox</a></td> <td>Constructor</td> </tr> <tr> <td><a href="#OllamaChatMessageBox.appendMessage">appendMessage</a></td> <td>Public method to append the given message text to the current content.</td> </tr> <tr> <td><a href="#OllamaChatMessageBox.getMessage">getMessage</a></td> <td>Public method to get the message content.</td> </tr> </table> <h3>Static Methods</h3> <table> <tr><td>None</td></tr> </table> <a NAME="OllamaChatMessageBox.__init__" ID="OllamaChatMessageBox.__init__"></a> <h4>OllamaChatMessageBox (Constructor)</h4> <b>OllamaChatMessageBox</b>(<i>role, message, parent=None</i>) <p> Constructor </p> <dl> <dt><i>role</i> (str)</dt> <dd> role of the message sender (one of 'user' or 'assistant') </dd> <dt><i>message</i> (str)</dt> <dd> message text </dd> <dt><i>parent</i> (QWidget (optional))</dt> <dd> reference to the parent widget (defaults to None) </dd> </dl> <a NAME="OllamaChatMessageBox.appendMessage" ID="OllamaChatMessageBox.appendMessage"></a> <h4>OllamaChatMessageBox.appendMessage</h4> <b>appendMessage</b>(<i>msg</i>) <p> Public method to append the given message text to the current content. </p> <dl> <dt><i>msg</i> (str)</dt> <dd> message to be appended </dd> </dl> <a NAME="OllamaChatMessageBox.getMessage" ID="OllamaChatMessageBox.getMessage"></a> <h4>OllamaChatMessageBox.getMessage</h4> <b>getMessage</b>(<i></i>) <p> Public method to get the message content. </p> <dl> <dt>Return:</dt> <dd> message content </dd> </dl> <dl> <dt>Return Type:</dt> <dd> str </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html>