OllamaInterface/Documentation/Source/Plugin_AI_Ollama.OllamaInterface.RunOllamaServerDialog.html

<!DOCTYPE html>
<html><head>
<title>Plugin_AI_Ollama.OllamaInterface.RunOllamaServerDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>Plugin_AI_Ollama.OllamaInterface.RunOllamaServerDialog</h1>
<p>
Module implementing a dialog to run the ollama server locally.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#RunOllamaServerDialog">RunOllamaServerDialog</a></td>
<td>Class implementing a dialog to run the ollama server locally.</td>
</tr>
</table>

<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>

<hr />
<hr />
<a NAME="RunOllamaServerDialog" ID="RunOllamaServerDialog"></a>
<h2>RunOllamaServerDialog</h2>
<p>
    Class implementing a dialog to run the ollama server locally.
</p>

<h3>Signals</h3>
<dl>

<dt>serverStarted()</dt>
<dd>
emitted after the start of the 'ollama' server
</dd>
<dt>serverStopped()</dt>
<dd>
emitted after the 'ollama' server was stopped
</dd>
</dl>
<h3>Derived from</h3>
QDialog, Ui_RunOllamaServerDialog
<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="#RunOllamaServerDialog.__init__">RunOllamaServerDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#RunOllamaServerDialog.__processFinished">__processFinished</a></td>
<td>Private slot handling the finishing of the server process.</td>
</tr>
<tr>
<td><a href="#RunOllamaServerDialog.__readStdOut">__readStdOut</a></td>
<td>Private slot to add the server process output to the output pane.</td>
</tr>
<tr>
<td><a href="#RunOllamaServerDialog.closeEvent">closeEvent</a></td>
<td>Protected method handling a close event.</td>
</tr>
<tr>
<td><a href="#RunOllamaServerDialog.on_restartServerButton_clicked">on_restartServerButton_clicked</a></td>
<td>Private slot to re-start the ollama server.</td>
</tr>
<tr>
<td><a href="#RunOllamaServerDialog.on_stopServerButton_clicked">on_stopServerButton_clicked</a></td>
<td>Private slot to stop the running server.</td>
</tr>
<tr>
<td><a href="#RunOllamaServerDialog.startServer">startServer</a></td>
<td>Public method to start the ollama server process.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="RunOllamaServerDialog.__init__" ID="RunOllamaServerDialog.__init__"></a>
<h4>RunOllamaServerDialog (Constructor)</h4>
<b>RunOllamaServerDialog</b>(<i>ollamaClient, plugin, parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>ollamaClient</i> (OllamaClient)</dt>
<dd>
reference to the 'ollama' client object
</dd>
<dt><i>plugin</i> (PluginOllamaInterface)</dt>
<dd>
reference to the plug-in object
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="RunOllamaServerDialog.__processFinished" ID="RunOllamaServerDialog.__processFinished"></a>
<h4>RunOllamaServerDialog.__processFinished</h4>
<b>__processFinished</b>(<i></i>)
<p>
        Private slot handling the finishing of the server process.
</p>

<a NAME="RunOllamaServerDialog.__readStdOut" ID="RunOllamaServerDialog.__readStdOut"></a>
<h4>RunOllamaServerDialog.__readStdOut</h4>
<b>__readStdOut</b>(<i></i>)
<p>
        Private slot to add the server process output to the output pane.
</p>

<a NAME="RunOllamaServerDialog.closeEvent" ID="RunOllamaServerDialog.closeEvent"></a>
<h4>RunOllamaServerDialog.closeEvent</h4>
<b>closeEvent</b>(<i>evt</i>)
<p>
        Protected method handling a close event.
</p>

<dl>

<dt><i>evt</i> (QCloseEvent)</dt>
<dd>
reference to the close event
</dd>
</dl>
<a NAME="RunOllamaServerDialog.on_restartServerButton_clicked" ID="RunOllamaServerDialog.on_restartServerButton_clicked"></a>
<h4>RunOllamaServerDialog.on_restartServerButton_clicked</h4>
<b>on_restartServerButton_clicked</b>(<i></i>)
<p>
        Private slot to re-start the ollama server.
</p>

<a NAME="RunOllamaServerDialog.on_stopServerButton_clicked" ID="RunOllamaServerDialog.on_stopServerButton_clicked"></a>
<h4>RunOllamaServerDialog.on_stopServerButton_clicked</h4>
<b>on_stopServerButton_clicked</b>(<i></i>)
<p>
        Private slot to stop the running server.
</p>

<a NAME="RunOllamaServerDialog.startServer" ID="RunOllamaServerDialog.startServer"></a>
<h4>RunOllamaServerDialog.startServer</h4>
<b>startServer</b>(<i></i>)
<p>
        Public method to start the ollama server process.
</p>

<dl>
<dt>Return:</dt>
<dd>
flag indicating success
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>