Thu, 29 Aug 2024 13:15:36 +0200
Generated source code documentation.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/OllamaInterface/Documentation/Source/Plugin_AI_Ollama.OllamaInterface.AutoResizeTextBrowser.html Thu Aug 29 13:15:36 2024 +0200 @@ -0,0 +1,111 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_AI_Ollama.OllamaInterface.AutoResizeTextBrowser</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>Plugin_AI_Ollama.OllamaInterface.AutoResizeTextBrowser</h1> +<p> +Module implementing a QTextBrowser widget that resizes automatically. +</p> + +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> + +<h3>Classes</h3> +<table> +<tr> +<td><a href="#AutoResizeTextBrowser">AutoResizeTextBrowser</a></td> +<td>Class implementing a QTextBrowser widget that resizes automatically.</td> +</tr> +</table> + +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> + +<hr /> +<hr /> +<a NAME="AutoResizeTextBrowser" ID="AutoResizeTextBrowser"></a> +<h2>AutoResizeTextBrowser</h2> +<p> + Class implementing a QTextBrowser widget that resizes automatically. +</p> + +<h3>Derived from</h3> +QTextBrowser +<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="#AutoResizeTextBrowser.__init__">AutoResizeTextBrowser</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#AutoResizeTextBrowser.resizeEvent">resizeEvent</a></td> +<td>Protected method to handle resize events.</td> +</tr> +<tr> +<td><a href="#AutoResizeTextBrowser.updateGeometry">updateGeometry</a></td> +<td>Public method to update the geometry depending on the current text.</td> +</tr> +</table> + +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + + +<a NAME="AutoResizeTextBrowser.__init__" ID="AutoResizeTextBrowser.__init__"></a> +<h4>AutoResizeTextBrowser (Constructor)</h4> +<b>AutoResizeTextBrowser</b>(<i>parent=None</i>) +<p> + Constructor +</p> + +<dl> + +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="AutoResizeTextBrowser.resizeEvent" ID="AutoResizeTextBrowser.resizeEvent"></a> +<h4>AutoResizeTextBrowser.resizeEvent</h4> +<b>resizeEvent</b>(<i>evt</i>) +<p> + Protected method to handle resize events. +</p> + +<dl> + +<dt><i>evt</i> (QResizeEvent)</dt> +<dd> +reference to the resize event +</dd> +</dl> +<a NAME="AutoResizeTextBrowser.updateGeometry" ID="AutoResizeTextBrowser.updateGeometry"></a> +<h4>AutoResizeTextBrowser.updateGeometry</h4> +<b>updateGeometry</b>(<i></i>) +<p> + Public method to update the geometry depending on the current text. +</p> + +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/OllamaInterface/Documentation/Source/Plugin_AI_Ollama.OllamaInterface.ConfigurationPage.OllamaPage.html Thu Aug 29 13:15:36 2024 +0200 @@ -0,0 +1,93 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_AI_Ollama.OllamaInterface.ConfigurationPage.OllamaPage</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>Plugin_AI_Ollama.OllamaInterface.ConfigurationPage.OllamaPage</h1> +<p> +Module implementing the 'ollama' interface configuration page. +</p> + +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> + +<h3>Classes</h3> +<table> +<tr> +<td><a href="#OllamaPage">OllamaPage</a></td> +<td>Class implementing the 'ollama' interface configuration page.</td> +</tr> +</table> + +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> + +<hr /> +<hr /> +<a NAME="OllamaPage" ID="OllamaPage"></a> +<h2>OllamaPage</h2> +<p> + Class implementing the 'ollama' interface configuration page. +</p> + +<h3>Derived from</h3> +ConfigurationPageBase, Ui_OllamaPage +<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="#OllamaPage.__init__">OllamaPage</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#OllamaPage.save">save</a></td> +<td>Public slot to save the 'ollama' interface configuration.</td> +</tr> +</table> + +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + + +<a NAME="OllamaPage.__init__" ID="OllamaPage.__init__"></a> +<h4>OllamaPage (Constructor)</h4> +<b>OllamaPage</b>(<i>plugin</i>) +<p> + Constructor +</p> + +<dl> + +<dt><i>plugin</i> (PluginOllamaInterface)</dt> +<dd> +reference to the plugin object +</dd> +</dl> +<a NAME="OllamaPage.save" ID="OllamaPage.save"></a> +<h4>OllamaPage.save</h4> +<b>save</b>(<i></i>) +<p> + Public slot to save the 'ollama' interface configuration. +</p> + +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/OllamaInterface/Documentation/Source/Plugin_AI_Ollama.OllamaInterface.OllamaChatMessageBox.html Thu Aug 29 13:15:36 2024 +0200 @@ -0,0 +1,131 @@ +<!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>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/OllamaInterface/Documentation/Source/Plugin_AI_Ollama.OllamaInterface.OllamaChatWidget.html Thu Aug 29 13:15:36 2024 +0200 @@ -0,0 +1,191 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_AI_Ollama.OllamaInterface.OllamaChatWidget</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>Plugin_AI_Ollama.OllamaInterface.OllamaChatWidget</h1> +<p> +Module implementing a widget showing the chat with the 'ollama' server. +</p> + +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> + +<h3>Classes</h3> +<table> +<tr> +<td><a href="#OllamaChatWidget">OllamaChatWidget</a></td> +<td>Class implementing a widget showing the chat with the 'ollama' server.</td> +</tr> +</table> + +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> + +<hr /> +<hr /> +<a NAME="OllamaChatWidget" ID="OllamaChatWidget"></a> +<h2>OllamaChatWidget</h2> +<p> + Class implementing a widget showing the chat with the 'ollama' server. +</p> + +<h3>Derived from</h3> +QWidget, Ui_OllamaChatWidget +<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="#OllamaChatWidget.__init__">OllamaChatWidget</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#OllamaChatWidget.__scrollChatToBottom">__scrollChatToBottom</a></td> +<td>Private slot to scroll the chat scroll area to the bottom.</td> +</tr> +<tr> +<td><a href="#OllamaChatWidget.addMessage">addMessage</a></td> +<td>Public method to add a new message.</td> +</tr> +<tr> +<td><a href="#OllamaChatWidget.appendMessage">appendMessage</a></td> +<td>Public method to append a given message to the bottom most message box.</td> +</tr> +<tr> +<td><a href="#OllamaChatWidget.getHistoryId">getHistoryId</a></td> +<td>Public method to get the history ID of this chat.</td> +</tr> +<tr> +<td><a href="#OllamaChatWidget.getRecentMessage">getRecentMessage</a></td> +<td>Public method to get the message of the last message box.</td> +</tr> +</table> + +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + + +<a NAME="OllamaChatWidget.__init__" ID="OllamaChatWidget.__init__"></a> +<h4>OllamaChatWidget (Constructor)</h4> +<b>OllamaChatWidget</b>(<i>hid, title, model, parent=None</i>) +<p> + Constructor +</p> + +<dl> + +<dt><i>hid</i> (str)</dt> +<dd> +ID of the chat history +</dd> +<dt><i>title</i> (str)</dt> +<dd> +title of the chat +</dd> +<dt><i>model</i> (str)</dt> +<dd> +model name used for the chat +</dd> +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="OllamaChatWidget.__scrollChatToBottom" ID="OllamaChatWidget.__scrollChatToBottom"></a> +<h4>OllamaChatWidget.__scrollChatToBottom</h4> +<b>__scrollChatToBottom</b>(<i></i>) +<p> + Private slot to scroll the chat scroll area to the bottom. +</p> + +<a NAME="OllamaChatWidget.addMessage" ID="OllamaChatWidget.addMessage"></a> +<h4>OllamaChatWidget.addMessage</h4> +<b>addMessage</b>(<i>role, message</i>) +<p> + Public method to add a new message. +</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> +</dl> +<a NAME="OllamaChatWidget.appendMessage" ID="OllamaChatWidget.appendMessage"></a> +<h4>OllamaChatWidget.appendMessage</h4> +<b>appendMessage</b>(<i>message</i>) +<p> + Public method to append a given message to the bottom most message box. +</p> + +<dl> + +<dt><i>message</i> (str)</dt> +<dd> +message text to be appended +</dd> +</dl> +<a NAME="OllamaChatWidget.getHistoryId" ID="OllamaChatWidget.getHistoryId"></a> +<h4>OllamaChatWidget.getHistoryId</h4> +<b>getHistoryId</b>(<i></i>) +<p> + Public method to get the history ID of this chat. +</p> + +<dl> +<dt>Return:</dt> +<dd> +DESCRIPTION +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +TYPE +</dd> +</dl> +<a NAME="OllamaChatWidget.getRecentMessage" ID="OllamaChatWidget.getRecentMessage"></a> +<h4>OllamaChatWidget.getRecentMessage</h4> +<b>getRecentMessage</b>(<i></i>) +<p> + Public method to get the message of the last message box. +</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>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/OllamaInterface/Documentation/Source/Plugin_AI_Ollama.OllamaInterface.OllamaClient.html Thu Aug 29 13:15:36 2024 +0200 @@ -0,0 +1,742 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_AI_Ollama.OllamaInterface.OllamaClient</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>Plugin_AI_Ollama.OllamaInterface.OllamaClient</h1> +<p> +Module implementing the 'ollama' client. +</p> + +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> + +<h3>Classes</h3> +<table> +<tr> +<td><a href="#OllamaClient">OllamaClient</a></td> +<td>Class implementing the 'ollama' client.</td> +</tr> +<tr> +<td><a href="#OllamaClientState">OllamaClientState</a></td> +<td>Class defining the various client states.</td> +</tr> +</table> + +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> + +<hr /> +<hr /> +<a NAME="OllamaClient" ID="OllamaClient"></a> +<h2>OllamaClient</h2> +<p> + Class implementing the 'ollama' client. +</p> + +<h3>Signals</h3> +<dl> + +<dt>errorOccurred(error:str)</dt> +<dd> +emitted to indicate a network error occurred + while processing the request +</dd> +<dt>finished()</dt> +<dd> +emitted to indicate the completion of a request +</dd> +<dt>modelsList(modelNames:list[str])</dt> +<dd> +emitted after the list of model + names was obtained from the 'ollama' server +</dd> +<dt>pullError(msg:str)</dt> +<dd> +emitted to indicate an error during a pull operation +</dd> +<dt>pullStatus(msg:str, id:str, total:int, completed:int)</dt> +<dd> +emitted to indicate + the status of a pull request as reported by the 'ollama' server +</dd> +<dt>replyReceived(content:str, role:str, done:bool)</dt> +<dd> +emitted after a response + from the 'ollama' server was received +</dd> +<dt>serverStateChanged(ok:bool, msg:str)</dt> +<dd> +emitted to indicate a change of the + server responsiveness +</dd> +<dt>serverVersion(version:str)</dt> +<dd> +emitted after the server version was obtained + from the 'ollama' server +</dd> +</dl> +<h3>Derived from</h3> +QObject +<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="#OllamaClient.__init__">OllamaClient</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#OllamaClient.__errorOccurred">__errorOccurred</a></td> +<td>Private method to handle a network error of the given reply.</td> +</tr> +<tr> +<td><a href="#OllamaClient.__getHeartbeatUrl">__getHeartbeatUrl</a></td> +<td>Private method to get the current heartbeat URL.</td> +</tr> +<tr> +<td><a href="#OllamaClient.__getServerReply">__getServerReply</a></td> +<td>Private method to send a request to the 'ollama' server and return a reply object.</td> +</tr> +<tr> +<td><a href="#OllamaClient.__periodicHeartbeat">__periodicHeartbeat</a></td> +<td>Private slot to do a periodic check of the 'ollama' server responsiveness.</td> +</tr> +<tr> +<td><a href="#OllamaClient.__processChatResponse">__processChatResponse</a></td> +<td>Private method to process the chat response of the 'ollama' server.</td> +</tr> +<tr> +<td><a href="#OllamaClient.__processData">__processData</a></td> +<td>Private method to receive data from the 'ollama' server and process it with a given processing function or method.</td> +</tr> +<tr> +<td><a href="#OllamaClient.__processGenerateResponse">__processGenerateResponse</a></td> +<td>Private method to process the generate response of the 'ollama' server.</td> +</tr> +<tr> +<td><a href="#OllamaClient.__processModelsList">__processModelsList</a></td> +<td>Private method to process the tags response of the 'ollama' server.</td> +</tr> +<tr> +<td><a href="#OllamaClient.__processPullResponse">__processPullResponse</a></td> +<td>Private method to process a pull response of the 'ollama' server.</td> +</tr> +<tr> +<td><a href="#OllamaClient.__processVersion">__processVersion</a></td> +<td>Private method to process the version response of the 'ollama' server.</td> +</tr> +<tr> +<td><a href="#OllamaClient.__replyFinished">__replyFinished</a></td> +<td>Private method to handle the finished signal of the reply.</td> +</tr> +<tr> +<td><a href="#OllamaClient.__sendRequest">__sendRequest</a></td> +<td>Private method to send a request to the 'ollama' server and handle its responses.</td> +</tr> +<tr> +<td><a href="#OllamaClient.__sendSyncRequest">__sendSyncRequest</a></td> +<td>Private method to send a request to the 'ollama' server and handle its responses.</td> +</tr> +<tr> +<td><a href="#OllamaClient.__serverNotRespondingMessage">__serverNotRespondingMessage</a></td> +<td>Private method to assemble and return a message for a non-responsive server.</td> +</tr> +<tr> +<td><a href="#OllamaClient.__setHeartbeatTimer">__setHeartbeatTimer</a></td> +<td>Private slot to configure the heartbeat timer.</td> +</tr> +<tr> +<td><a href="#OllamaClient.abortPull">abortPull</a></td> +<td>Public method to abort an ongoing pull operation.</td> +</tr> +<tr> +<td><a href="#OllamaClient.chat">chat</a></td> +<td>Public method to request a chat completion from the 'ollama' server.</td> +</tr> +<tr> +<td><a href="#OllamaClient.generate">generate</a></td> +<td>Public method to request to generate a completion from the 'ollama' server.</td> +</tr> +<tr> +<td><a href="#OllamaClient.heartbeat">heartbeat</a></td> +<td>Public method to check, if the 'ollama' server has started and is responsive.</td> +</tr> +<tr> +<td><a href="#OllamaClient.list">list</a></td> +<td>Public method to request a list of models available locally from the 'ollama' server.</td> +</tr> +<tr> +<td><a href="#OllamaClient.listDetails">listDetails</a></td> +<td>Public method to request a list of models available locally from the 'ollama' server with some model details.</td> +</tr> +<tr> +<td><a href="#OllamaClient.listRunning">listRunning</a></td> +<td>Public method to request a list of running models from the 'ollama' server.</td> +</tr> +<tr> +<td><a href="#OllamaClient.pull">pull</a></td> +<td>Public method to ask the 'ollama' server to pull the given model.</td> +</tr> +<tr> +<td><a href="#OllamaClient.remove">remove</a></td> +<td>Public method to ask the 'ollama' server to delete the given model.</td> +</tr> +<tr> +<td><a href="#OllamaClient.setMode">setMode</a></td> +<td>Public method to set the client mode to local.</td> +</tr> +<tr> +<td><a href="#OllamaClient.state">state</a></td> +<td>Public method to get the current client state.</td> +</tr> +<tr> +<td><a href="#OllamaClient.version">version</a></td> +<td>Public method to request the version from the 'ollama' server.</td> +</tr> +</table> + +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + + +<a NAME="OllamaClient.__init__" ID="OllamaClient.__init__"></a> +<h4>OllamaClient (Constructor)</h4> +<b>OllamaClient</b>(<i>plugin, parent=None</i>) +<p> + Constructor +</p> + +<dl> + +<dt><i>plugin</i> (PluginOllamaInterface)</dt> +<dd> +reference to the plugin object +</dd> +<dt><i>parent</i> (QObject (optional))</dt> +<dd> +reference to the parent object (defaults to None) +</dd> +</dl> +<a NAME="OllamaClient.__errorOccurred" ID="OllamaClient.__errorOccurred"></a> +<h4>OllamaClient.__errorOccurred</h4> +<b>__errorOccurred</b>(<i>errorCode, reply</i>) +<p> + Private method to handle a network error of the given reply. +</p> + +<dl> + +<dt><i>errorCode</i> (QNetworkReply.NetworkError)</dt> +<dd> +error code reported by the reply +</dd> +<dt><i>reply</i> (QNetworkReply)</dt> +<dd> +reference to the network reply object +</dd> +</dl> +<a NAME="OllamaClient.__getHeartbeatUrl" ID="OllamaClient.__getHeartbeatUrl"></a> +<h4>OllamaClient.__getHeartbeatUrl</h4> +<b>__getHeartbeatUrl</b>(<i></i>) +<p> + Private method to get the current heartbeat URL. +</p> + +<dl> +<dt>Return:</dt> +<dd> +URL to be contacted by the heartbeat check +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<a NAME="OllamaClient.__getServerReply" ID="OllamaClient.__getServerReply"></a> +<h4>OllamaClient.__getServerReply</h4> +<b>__getServerReply</b>(<i>endpoint, data=None, delete=False</i>) +<p> + Private method to send a request to the 'ollama' server and return a reply + object. +</p> + +<dl> + +<dt><i>endpoint</i> (str)</dt> +<dd> +'ollama' API endpoint to be contacted +</dd> +<dt><i>data</i> (dict (optional))</dt> +<dd> +dictionary containing the data to send to the server + (defaults to None) +</dd> +<dt><i>delete</i> (bool (optional))</dt> +<dd> +flag indicating to send a delete request (defaults to False) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +'ollama' server reply +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QNetworkReply +</dd> +</dl> +<a NAME="OllamaClient.__periodicHeartbeat" ID="OllamaClient.__periodicHeartbeat"></a> +<h4>OllamaClient.__periodicHeartbeat</h4> +<b>__periodicHeartbeat</b>(<i></i>) +<p> + Private slot to do a periodic check of the 'ollama' server responsiveness. +</p> + +<a NAME="OllamaClient.__processChatResponse" ID="OllamaClient.__processChatResponse"></a> +<h4>OllamaClient.__processChatResponse</h4> +<b>__processChatResponse</b>(<i>response</i>) +<p> + Private method to process the chat response of the 'ollama' server. +</p> + +<dl> + +<dt><i>response</i> (dict)</dt> +<dd> +dictionary containing the chat response +</dd> +</dl> +<a NAME="OllamaClient.__processData" ID="OllamaClient.__processData"></a> +<h4>OllamaClient.__processData</h4> +<b>__processData</b>(<i>reply, processResponse</i>) +<p> + Private method to receive data from the 'ollama' server and process it with a + given processing function or method. +</p> + +<dl> + +<dt><i>reply</i> (QNetworkReply)</dt> +<dd> +reference to the network reply object +</dd> +<dt><i>processResponse</i> (function)</dt> +<dd> +processing function +</dd> +</dl> +<a NAME="OllamaClient.__processGenerateResponse" ID="OllamaClient.__processGenerateResponse"></a> +<h4>OllamaClient.__processGenerateResponse</h4> +<b>__processGenerateResponse</b>(<i>response</i>) +<p> + Private method to process the generate response of the 'ollama' server. +</p> + +<dl> + +<dt><i>response</i> (dict)</dt> +<dd> +dictionary containing the generate response +</dd> +</dl> +<a NAME="OllamaClient.__processModelsList" ID="OllamaClient.__processModelsList"></a> +<h4>OllamaClient.__processModelsList</h4> +<b>__processModelsList</b>(<i>response</i>) +<p> + Private method to process the tags response of the 'ollama' server. +</p> + +<dl> + +<dt><i>response</i> (dict)</dt> +<dd> +dictionary containing the tags response +</dd> +</dl> +<a NAME="OllamaClient.__processPullResponse" ID="OllamaClient.__processPullResponse"></a> +<h4>OllamaClient.__processPullResponse</h4> +<b>__processPullResponse</b>(<i>response</i>) +<p> + Private method to process a pull response of the 'ollama' server. +</p> + +<dl> + +<dt><i>response</i> (dict)</dt> +<dd> +dictionary containing the pull response +</dd> +</dl> +<a NAME="OllamaClient.__processVersion" ID="OllamaClient.__processVersion"></a> +<h4>OllamaClient.__processVersion</h4> +<b>__processVersion</b>(<i>response</i>) +<p> + Private method to process the version response of the 'ollama' server. +</p> + +<dl> + +<dt><i>response</i> (dict)</dt> +<dd> +dictionary containing the version response +</dd> +</dl> +<a NAME="OllamaClient.__replyFinished" ID="OllamaClient.__replyFinished"></a> +<h4>OllamaClient.__replyFinished</h4> +<b>__replyFinished</b>(<i>reply</i>) +<p> + Private method to handle the finished signal of the reply. +</p> + +<dl> + +<dt><i>reply</i> (QNetworkReply)</dt> +<dd> +reference to the finished network reply object +</dd> +</dl> +<a NAME="OllamaClient.__sendRequest" ID="OllamaClient.__sendRequest"></a> +<h4>OllamaClient.__sendRequest</h4> +<b>__sendRequest</b>(<i>endpoint, data=None, processResponse=None</i>) +<p> + Private method to send a request to the 'ollama' server and handle its + responses. +</p> + +<dl> + +<dt><i>endpoint</i> (str)</dt> +<dd> +'ollama' API endpoint to be contacted +</dd> +<dt><i>data</i> (dict (optional))</dt> +<dd> +dictionary containing the data to send to the server + (defaults to None) +</dd> +<dt><i>processResponse</i> (function (optional))</dt> +<dd> +function handling the received data (defaults to None) +</dd> +</dl> +<a NAME="OllamaClient.__sendSyncRequest" ID="OllamaClient.__sendSyncRequest"></a> +<h4>OllamaClient.__sendSyncRequest</h4> +<b>__sendSyncRequest</b>(<i>endpoint, data=None, delete=False</i>) +<p> + Private method to send a request to the 'ollama' server and handle its + responses. +</p> + +<dl> + +<dt><i>endpoint</i> (str)</dt> +<dd> +'ollama' API endpoint to be contacted +</dd> +<dt><i>data</i> (dict (optional))</dt> +<dd> +dictionary containing the data to send to the server + (defaults to None) +</dd> +<dt><i>delete</i> (bool (optional))</dt> +<dd> +flag indicating to send a delete request (defaults to False) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +tuple containing the data sent by the 'ollama' server and the HTTP + status code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (Any, int) +</dd> +</dl> +<a NAME="OllamaClient.__serverNotRespondingMessage" ID="OllamaClient.__serverNotRespondingMessage"></a> +<h4>OllamaClient.__serverNotRespondingMessage</h4> +<b>__serverNotRespondingMessage</b>(<i></i>) +<p> + Private method to assemble and return a message for a non-responsive server. +</p> + +<dl> +<dt>Return:</dt> +<dd> +error message +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<a NAME="OllamaClient.__setHeartbeatTimer" ID="OllamaClient.__setHeartbeatTimer"></a> +<h4>OllamaClient.__setHeartbeatTimer</h4> +<b>__setHeartbeatTimer</b>(<i></i>) +<p> + Private slot to configure the heartbeat timer. +</p> + +<a NAME="OllamaClient.abortPull" ID="OllamaClient.abortPull"></a> +<h4>OllamaClient.abortPull</h4> +<b>abortPull</b>(<i></i>) +<p> + Public method to abort an ongoing pull operation. +</p> + +<a NAME="OllamaClient.chat" ID="OllamaClient.chat"></a> +<h4>OllamaClient.chat</h4> +<b>chat</b>(<i>model, messages, streaming=True</i>) +<p> + Public method to request a chat completion from the 'ollama' server. +</p> + +<dl> + +<dt><i>model</i> (str)</dt> +<dd> +name of the model to be used +</dd> +<dt><i>messages</i> (list of dict)</dt> +<dd> +list of message objects +</dd> +<dt><i>streaming</i> (bool)</dt> +<dd> +flag indicating to receive a streaming response +</dd> +</dl> +<a NAME="OllamaClient.generate" ID="OllamaClient.generate"></a> +<h4>OllamaClient.generate</h4> +<b>generate</b>(<i>model, prompt, suffix=None</i>) +<p> + Public method to request to generate a completion from the 'ollama' server. +</p> + +<dl> + +<dt><i>model</i> (str)</dt> +<dd> +name of the model to be used +</dd> +<dt><i>prompt</i> (str)</dt> +<dd> +prompt to generate a response for +</dd> +<dt><i>suffix</i> (str (optional))</dt> +<dd> +text after the model response (defaults to None) +</dd> +</dl> +<a NAME="OllamaClient.heartbeat" ID="OllamaClient.heartbeat"></a> +<h4>OllamaClient.heartbeat</h4> +<b>heartbeat</b>(<i></i>) +<p> + Public method to check, if the 'ollama' server has started and is responsive. +</p> + +<dl> +<dt>Return:</dt> +<dd> +flag indicating a responsive 'ollama' server +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="OllamaClient.list" ID="OllamaClient.list"></a> +<h4>OllamaClient.list</h4> +<b>list</b>(<i></i>) +<p> + Public method to request a list of models available locally from the 'ollama' + server. +</p> + +<a NAME="OllamaClient.listDetails" ID="OllamaClient.listDetails"></a> +<h4>OllamaClient.listDetails</h4> +<b>listDetails</b>(<i></i>) +<p> + Public method to request a list of models available locally from the 'ollama' + server with some model details. +</p> + +<dl> +<dt>Return:</dt> +<dd> +list of dictionaries containing the available models and related data +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list[dict[str, Any]] +</dd> +</dl> +<a NAME="OllamaClient.listRunning" ID="OllamaClient.listRunning"></a> +<h4>OllamaClient.listRunning</h4> +<b>listRunning</b>(<i></i>) +<p> + Public method to request a list of running models from the 'ollama' server. +</p> + +<dl> +<dt>Return:</dt> +<dd> +list of dictionaries containing the running models and related data +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list[dict[str, Any]] +</dd> +</dl> +<a NAME="OllamaClient.pull" ID="OllamaClient.pull"></a> +<h4>OllamaClient.pull</h4> +<b>pull</b>(<i>model</i>) +<p> + Public method to ask the 'ollama' server to pull the given model. +</p> + +<dl> + +<dt><i>model</i> (str)</dt> +<dd> +name of the model +</dd> +</dl> +<a NAME="OllamaClient.remove" ID="OllamaClient.remove"></a> +<h4>OllamaClient.remove</h4> +<b>remove</b>(<i>model</i>) +<p> + Public method to ask the 'ollama' server to delete the given model. +</p> + +<dl> + +<dt><i>model</i> (str)</dt> +<dd> +name of the model +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating success +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="OllamaClient.setMode" ID="OllamaClient.setMode"></a> +<h4>OllamaClient.setMode</h4> +<b>setMode</b>(<i>local</i>) +<p> + Public method to set the client mode to local. +</p> + +<dl> + +<dt><i>local</i> (bool)</dt> +<dd> +flag indicating to connect to a locally started ollama server +</dd> +</dl> +<a NAME="OllamaClient.state" ID="OllamaClient.state"></a> +<h4>OllamaClient.state</h4> +<b>state</b>(<i></i>) +<p> + Public method to get the current client state. +</p> + +<dl> +<dt>Return:</dt> +<dd> +current client state +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +OllamaClientState +</dd> +</dl> +<a NAME="OllamaClient.version" ID="OllamaClient.version"></a> +<h4>OllamaClient.version</h4> +<b>version</b>(<i></i>) +<p> + Public method to request the version from the 'ollama' server. +</p> + +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="OllamaClientState" ID="OllamaClientState"></a> +<h2>OllamaClientState</h2> +<p> + Class defining the various client states. +</p> + +<h3>Derived from</h3> +enum.Enum +<h3>Class Attributes</h3> +<table> +<tr><td>Finished</td></tr> +<tr><td>Receiving</td></tr> +<tr><td>Requesting</td></tr> +<tr><td>Waiting</td></tr> +</table> + +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + +<h3>Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + + +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/OllamaInterface/Documentation/Source/Plugin_AI_Ollama.OllamaInterface.OllamaDetailedModelsDialog.html Thu Aug 29 13:15:36 2024 +0200 @@ -0,0 +1,86 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_AI_Ollama.OllamaInterface.OllamaDetailedModelsDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>Plugin_AI_Ollama.OllamaInterface.OllamaDetailedModelsDialog</h1> +<p> +Module implementing a dialog to show details of the available models. +</p> + +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> + +<h3>Classes</h3> +<table> +<tr> +<td><a href="#OllamaDetailedModelsDialog">OllamaDetailedModelsDialog</a></td> +<td>Class implementing a dialog to show details of the available models.</td> +</tr> +</table> + +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> + +<hr /> +<hr /> +<a NAME="OllamaDetailedModelsDialog" ID="OllamaDetailedModelsDialog"></a> +<h2>OllamaDetailedModelsDialog</h2> +<p> + Class implementing a dialog to show details of the available models. +</p> + +<h3>Derived from</h3> +QDialog, Ui_OllamaDetailedModelsDialog +<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="#OllamaDetailedModelsDialog.__init__">OllamaDetailedModelsDialog</a></td> +<td>Constructor</td> +</tr> +</table> + +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + + +<a NAME="OllamaDetailedModelsDialog.__init__" ID="OllamaDetailedModelsDialog.__init__"></a> +<h4>OllamaDetailedModelsDialog (Constructor)</h4> +<b>OllamaDetailedModelsDialog</b>(<i>models, parent=None</i>) +<p> + Constructor +</p> + +<dl> + +<dt><i>models</i> (list[dict[str: Any]])</dt> +<dd> +list of available models with details +</dd> +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/OllamaInterface/Documentation/Source/Plugin_AI_Ollama.OllamaInterface.OllamaHistoryWidget.html Thu Aug 29 13:15:36 2024 +0200 @@ -0,0 +1,319 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_AI_Ollama.OllamaInterface.OllamaHistoryWidget</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>Plugin_AI_Ollama.OllamaInterface.OllamaHistoryWidget</h1> +<p> +Module implementing a widget showing a chat title and store a chat contents. +</p> + +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> + +<h3>Classes</h3> +<table> +<tr> +<td><a href="#OllamaHistoryWidget">OllamaHistoryWidget</a></td> +<td>Class implementing a widget showing a chat title and store a chat contents.</td> +</tr> +</table> + +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> + +<hr /> +<hr /> +<a NAME="OllamaHistoryWidget" ID="OllamaHistoryWidget"></a> +<h2>OllamaHistoryWidget</h2> +<p> + Class implementing a widget showing a chat title and store a chat contents. +</p> + +<h3>Signals</h3> +<dl> + +<dt>dataChanged(id:str)</dt> +<dd> +emitted to indicate a change of the chat history data +</dd> +<dt>deleteChatHistory(id:str)</dt> +<dd> +emitted to indicate, that this chat history + should be deleted +</dd> +<dt>newChatWithHistory(id:str)</dt> +<dd> +emitted to indicate, that a new chat using + the saved history should be started +</dd> +</dl> +<h3>Derived from</h3> +QWidget, Ui_OllamaHistoryWidget +<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="#OllamaHistoryWidget.__init__">OllamaHistoryWidget</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#OllamaHistoryWidget.addToMessages">addToMessages</a></td> +<td>Public method to add a chat message to the chat history.</td> +</tr> +<tr> +<td><a href="#OllamaHistoryWidget.checkModelAvailable">checkModelAvailable</a></td> +<td>Public method to set the enabled state depending on available models.</td> +</tr> +<tr> +<td><a href="#OllamaHistoryWidget.getId">getId</a></td> +<td>Public method to get the chat history ID.</td> +</tr> +<tr> +<td><a href="#OllamaHistoryWidget.getMessages">getMessages</a></td> +<td>Public method to get the list of messages.</td> +</tr> +<tr> +<td><a href="#OllamaHistoryWidget.getModel">getModel</a></td> +<td>Public method to get the model used by the chat.</td> +</tr> +<tr> +<td><a href="#OllamaHistoryWidget.getTitle">getTitle</a></td> +<td>Public method to get the chat title.</td> +</tr> +<tr> +<td><a href="#OllamaHistoryWidget.loadFromJson">loadFromJson</a></td> +<td>Public method to load the chat history data from a JSON string.</td> +</tr> +<tr> +<td><a href="#OllamaHistoryWidget.on_deleteButton_clicked">on_deleteButton_clicked</a></td> +<td>Private slot to delet this chat history entry..</td> +</tr> +<tr> +<td><a href="#OllamaHistoryWidget.on_editButton_clicked">on_editButton_clicked</a></td> +<td>Private slot to edit the chat title.</td> +</tr> +<tr> +<td><a href="#OllamaHistoryWidget.on_newChatButton_clicked">on_newChatButton_clicked</a></td> +<td>Private slot to start a new chat using the saved chat history.</td> +</tr> +<tr> +<td><a href="#OllamaHistoryWidget.saveToJson">saveToJson</a></td> +<td>Public method to serialize the chat history data to a JSON string.</td> +</tr> +</table> + +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + + +<a NAME="OllamaHistoryWidget.__init__" ID="OllamaHistoryWidget.__init__"></a> +<h4>OllamaHistoryWidget (Constructor)</h4> +<b>OllamaHistoryWidget</b>(<i>title, model, jsonStr=None, parent=None</i>) +<p> + Constructor +</p> + +<dl> + +<dt><i>title</i> (str)</dt> +<dd> +title of the ollama chat +</dd> +<dt><i>model</i> (str)</dt> +<dd> +name of the model used for the chat +</dd> +<dt><i>jsonStr</i> (str (optional))</dt> +<dd> +string containing JSON serialize chat history data + (defaults to None) +</dd> +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="OllamaHistoryWidget.addToMessages" ID="OllamaHistoryWidget.addToMessages"></a> +<h4>OllamaHistoryWidget.addToMessages</h4> +<b>addToMessages</b>(<i>role, content</i>) +<p> + Public method to add a chat message to the chat history. +</p> + +<dl> + +<dt><i>role</i> (str)</dt> +<dd> +chat role (one of 'system', 'user', 'assistant' or 'tool') +</dd> +<dt><i>content</i> (str)</dt> +<dd> +content of the chat message +</dd> +</dl> +<a NAME="OllamaHistoryWidget.checkModelAvailable" ID="OllamaHistoryWidget.checkModelAvailable"></a> +<h4>OllamaHistoryWidget.checkModelAvailable</h4> +<b>checkModelAvailable</b>(<i>modelNames</i>) +<p> + Public method to set the enabled state depending on available models. +</p> + +<dl> + +<dt><i>modelNames</i> (str)</dt> +<dd> +names of available models +</dd> +</dl> +<a NAME="OllamaHistoryWidget.getId" ID="OllamaHistoryWidget.getId"></a> +<h4>OllamaHistoryWidget.getId</h4> +<b>getId</b>(<i></i>) +<p> + Public method to get the chat history ID. +</p> + +<dl> +<dt>Return:</dt> +<dd> +ID of the history entry +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<a NAME="OllamaHistoryWidget.getMessages" ID="OllamaHistoryWidget.getMessages"></a> +<h4>OllamaHistoryWidget.getMessages</h4> +<b>getMessages</b>(<i></i>) +<p> + Public method to get the list of messages. +</p> + +<dl> +<dt>Return:</dt> +<dd> +list of stored messages +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list[dict[str, str]] +</dd> +</dl> +<a NAME="OllamaHistoryWidget.getModel" ID="OllamaHistoryWidget.getModel"></a> +<h4>OllamaHistoryWidget.getModel</h4> +<b>getModel</b>(<i></i>) +<p> + Public method to get the model used by the chat. +</p> + +<dl> +<dt>Return:</dt> +<dd> +model name +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<a NAME="OllamaHistoryWidget.getTitle" ID="OllamaHistoryWidget.getTitle"></a> +<h4>OllamaHistoryWidget.getTitle</h4> +<b>getTitle</b>(<i></i>) +<p> + Public method to get the chat title. +</p> + +<dl> +<dt>Return:</dt> +<dd> +chat title +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<a NAME="OllamaHistoryWidget.loadFromJson" ID="OllamaHistoryWidget.loadFromJson"></a> +<h4>OllamaHistoryWidget.loadFromJson</h4> +<b>loadFromJson</b>(<i>jsonStr</i>) +<p> + Public method to load the chat history data from a JSON string. +</p> + +<dl> + +<dt><i>jsonStr</i> (str)</dt> +<dd> +JSON serialized chat data +</dd> +</dl> +<a NAME="OllamaHistoryWidget.on_deleteButton_clicked" ID="OllamaHistoryWidget.on_deleteButton_clicked"></a> +<h4>OllamaHistoryWidget.on_deleteButton_clicked</h4> +<b>on_deleteButton_clicked</b>(<i></i>) +<p> + Private slot to delet this chat history entry.. +</p> + +<a NAME="OllamaHistoryWidget.on_editButton_clicked" ID="OllamaHistoryWidget.on_editButton_clicked"></a> +<h4>OllamaHistoryWidget.on_editButton_clicked</h4> +<b>on_editButton_clicked</b>(<i></i>) +<p> + Private slot to edit the chat title. +</p> + +<a NAME="OllamaHistoryWidget.on_newChatButton_clicked" ID="OllamaHistoryWidget.on_newChatButton_clicked"></a> +<h4>OllamaHistoryWidget.on_newChatButton_clicked</h4> +<b>on_newChatButton_clicked</b>(<i></i>) +<p> + Private slot to start a new chat using the saved chat history. +</p> + +<a NAME="OllamaHistoryWidget.saveToJson" ID="OllamaHistoryWidget.saveToJson"></a> +<h4>OllamaHistoryWidget.saveToJson</h4> +<b>saveToJson</b>(<i></i>) +<p> + Public method to serialize the chat history data to a JSON string. +</p> + +<dl> +<dt>Return:</dt> +<dd> +JSON serialized chat data +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/OllamaInterface/Documentation/Source/Plugin_AI_Ollama.OllamaInterface.OllamaPullProgressDialog.html Thu Aug 29 13:15:36 2024 +0200 @@ -0,0 +1,356 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_AI_Ollama.OllamaInterface.OllamaPullProgressDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>Plugin_AI_Ollama.OllamaInterface.OllamaPullProgressDialog</h1> +<p> +Module implementing a dialog showing the progress of a model pull action.. +</p> + +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> + +<h3>Classes</h3> +<table> +<tr> +<td><a href="#OllamaPullProgressBar">OllamaPullProgressBar</a></td> +<td>Class implementing a progress bar allowing values outside the standard range.</td> +</tr> +<tr> +<td><a href="#OllamaPullProgressDialog">OllamaPullProgressDialog</a></td> +<td>Class implementing a dialog showing the progress of a model pull action.</td> +</tr> +</table> + +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> + +<hr /> +<hr /> +<a NAME="OllamaPullProgressBar" ID="OllamaPullProgressBar"></a> +<h2>OllamaPullProgressBar</h2> +<p> + Class implementing a progress bar allowing values outside the standard range. +</p> + +<h3>Derived from</h3> +QProgressBar +<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="#OllamaPullProgressBar.__init__">OllamaPullProgressBar</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#OllamaPullProgressBar.maximum">maximum</a></td> +<td>Public method to get the maximum value.</td> +</tr> +<tr> +<td><a href="#OllamaPullProgressBar.setMaximum">setMaximum</a></td> +<td>Public method to set the maximum value.</td> +</tr> +<tr> +<td><a href="#OllamaPullProgressBar.setValue">setValue</a></td> +<td>Public method to set the current value.</td> +</tr> +<tr> +<td><a href="#OllamaPullProgressBar.value">value</a></td> +<td>Public method to get the current value.</td> +</tr> +</table> + +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + + +<a NAME="OllamaPullProgressBar.__init__" ID="OllamaPullProgressBar.__init__"></a> +<h4>OllamaPullProgressBar (Constructor)</h4> +<b>OllamaPullProgressBar</b>(<i>parent=None</i>) +<p> + Constructor +</p> + +<dl> + +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="OllamaPullProgressBar.maximum" ID="OllamaPullProgressBar.maximum"></a> +<h4>OllamaPullProgressBar.maximum</h4> +<b>maximum</b>(<i></i>) +<p> + Public method to get the maximum value. +</p> + +<dl> +<dt>Return:</dt> +<dd> +maximum value +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int +</dd> +</dl> +<a NAME="OllamaPullProgressBar.setMaximum" ID="OllamaPullProgressBar.setMaximum"></a> +<h4>OllamaPullProgressBar.setMaximum</h4> +<b>setMaximum</b>(<i>value</i>) +<p> + Public method to set the maximum value. +</p> + +<dl> + +<dt><i>value</i> (int)</dt> +<dd> +new maximum value +</dd> +</dl> +<a NAME="OllamaPullProgressBar.setValue" ID="OllamaPullProgressBar.setValue"></a> +<h4>OllamaPullProgressBar.setValue</h4> +<b>setValue</b>(<i>value</i>) +<p> + Public method to set the current value. +</p> + +<dl> + +<dt><i>value</i> (int)</dt> +<dd> +new value +</dd> +</dl> +<a NAME="OllamaPullProgressBar.value" ID="OllamaPullProgressBar.value"></a> +<h4>OllamaPullProgressBar.value</h4> +<b>value</b>(<i></i>) +<p> + Public method to get the current value. +</p> + +<dl> +<dt>Return:</dt> +<dd> +current value +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="OllamaPullProgressDialog" ID="OllamaPullProgressDialog"></a> +<h2>OllamaPullProgressDialog</h2> +<p> + Class implementing a dialog showing the progress of a model pull action. +</p> + +<h3>Signals</h3> +<dl> + +<dt>abortPull()</dt> +<dd> +emitted to abort the current model pull operation +</dd> +</dl> +<h3>Derived from</h3> +QDialog, Ui_OllamaPullProgressDialog +<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="#OllamaPullProgressDialog.__init__">OllamaPullProgressDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#OllamaPullProgressDialog.clear">clear</a></td> +<td>Public method to clear the progress information.</td> +</tr> +<tr> +<td><a href="#OllamaPullProgressDialog.closeEvent">closeEvent</a></td> +<td>Protected method to handle a close event.</td> +</tr> +<tr> +<td><a href="#OllamaPullProgressDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot handling a button of the button box being clicked.</td> +</tr> +<tr> +<td><a href="#OllamaPullProgressDialog.setFinished">setFinished</a></td> +<td>Public method to set the finished state.</td> +</tr> +<tr> +<td><a href="#OllamaPullProgressDialog.setModel">setModel</a></td> +<td>Public method to show the model name in the header.</td> +</tr> +<tr> +<td><a href="#OllamaPullProgressDialog.setStatus">setStatus</a></td> +<td>Public method to show the status update.</td> +</tr> +<tr> +<td><a href="#OllamaPullProgressDialog.showError">showError</a></td> +<td>Public method to show an error message reported by the server.</td> +</tr> +</table> + +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + + +<a NAME="OllamaPullProgressDialog.__init__" ID="OllamaPullProgressDialog.__init__"></a> +<h4>OllamaPullProgressDialog (Constructor)</h4> +<b>OllamaPullProgressDialog</b>(<i>parent=None</i>) +<p> + Constructor +</p> + +<dl> + +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="OllamaPullProgressDialog.clear" ID="OllamaPullProgressDialog.clear"></a> +<h4>OllamaPullProgressDialog.clear</h4> +<b>clear</b>(<i></i>) +<p> + Public method to clear the progress information. +</p> + +<a NAME="OllamaPullProgressDialog.closeEvent" ID="OllamaPullProgressDialog.closeEvent"></a> +<h4>OllamaPullProgressDialog.closeEvent</h4> +<b>closeEvent</b>(<i>evt</i>) +<p> + Protected method to handle a close event. +</p> + +<dl> + +<dt><i>evt</i> (QCloseEvent)</dt> +<dd> +reference to the close event object +</dd> +</dl> +<a NAME="OllamaPullProgressDialog.on_buttonBox_clicked" ID="OllamaPullProgressDialog.on_buttonBox_clicked"></a> +<h4>OllamaPullProgressDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) +<p> + Private slot handling a button of the button box being clicked. +</p> + +<dl> + +<dt><i>button</i> (QAbstractButton)</dt> +<dd> +reference to the clicked button +</dd> +</dl> +<a NAME="OllamaPullProgressDialog.setFinished" ID="OllamaPullProgressDialog.setFinished"></a> +<h4>OllamaPullProgressDialog.setFinished</h4> +<b>setFinished</b>(<i>finished</i>) +<p> + Public method to set the finished state. +</p> + +<dl> + +<dt><i>finished</i> (bool)</dt> +<dd> +flag indicating the finished state +</dd> +</dl> +<a NAME="OllamaPullProgressDialog.setModel" ID="OllamaPullProgressDialog.setModel"></a> +<h4>OllamaPullProgressDialog.setModel</h4> +<b>setModel</b>(<i>model</i>) +<p> + Public method to show the model name in the header. +</p> + +<dl> + +<dt><i>model</i> (str)</dt> +<dd> +model name +</dd> +</dl> +<a NAME="OllamaPullProgressDialog.setStatus" ID="OllamaPullProgressDialog.setStatus"></a> +<h4>OllamaPullProgressDialog.setStatus</h4> +<b>setStatus</b>(<i>status, idStr, total, completed</i>) +<p> + Public method to show the status update. +</p> + +<dl> + +<dt><i>status</i> (str)</dt> +<dd> +status message reported by the 'ollama' server +</dd> +<dt><i>idStr</i> (str)</dt> +<dd> +ID of the file being pulled or empty +</dd> +<dt><i>total</i> (int)</dt> +<dd> +size of the file being pulled or 0 in case of an empty ID +</dd> +<dt><i>completed</i> (int)</dt> +<dd> +downloaded bytes or 0 in case of an empty ID +</dd> +</dl> +<a NAME="OllamaPullProgressDialog.showError" ID="OllamaPullProgressDialog.showError"></a> +<h4>OllamaPullProgressDialog.showError</h4> +<b>showError</b>(<i>errMsg</i>) +<p> + Public method to show an error message reported by the server. +</p> + +<dl> + +<dt><i>errMsg</i> (str)</dt> +<dd> +error message +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/OllamaInterface/Documentation/Source/Plugin_AI_Ollama.OllamaInterface.OllamaRunningModelsDialog.html Thu Aug 29 13:15:36 2024 +0200 @@ -0,0 +1,86 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_AI_Ollama.OllamaInterface.OllamaRunningModelsDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>Plugin_AI_Ollama.OllamaInterface.OllamaRunningModelsDialog</h1> +<p> +Module implementing a dialog to show details of the running models. +</p> + +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> + +<h3>Classes</h3> +<table> +<tr> +<td><a href="#OllamaRunningModelsDialog">OllamaRunningModelsDialog</a></td> +<td>Class implementing a dialog to show details of the running models.</td> +</tr> +</table> + +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> + +<hr /> +<hr /> +<a NAME="OllamaRunningModelsDialog" ID="OllamaRunningModelsDialog"></a> +<h2>OllamaRunningModelsDialog</h2> +<p> + Class implementing a dialog to show details of the running models. +</p> + +<h3>Derived from</h3> +QDialog, Ui_OllamaRunningModelsDialog +<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="#OllamaRunningModelsDialog.__init__">OllamaRunningModelsDialog</a></td> +<td>Constructor</td> +</tr> +</table> + +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + + +<a NAME="OllamaRunningModelsDialog.__init__" ID="OllamaRunningModelsDialog.__init__"></a> +<h4>OllamaRunningModelsDialog (Constructor)</h4> +<b>OllamaRunningModelsDialog</b>(<i>models, parent=None</i>) +<p> + Constructor +</p> + +<dl> + +<dt><i>models</i> (list[dict[str: Any]])</dt> +<dd> +list of available models with details +</dd> +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/OllamaInterface/Documentation/Source/Plugin_AI_Ollama.OllamaInterface.OllamaWidget.html Thu Aug 29 13:15:36 2024 +0200 @@ -0,0 +1,916 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_AI_Ollama.OllamaInterface.OllamaWidget</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>Plugin_AI_Ollama.OllamaInterface.OllamaWidget</h1> +<p> +Module implementing the main ollama interface widget. +</p> + +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> + +<h3>Classes</h3> +<table> +<tr> +<td><a href="#OllamaWidget">OllamaWidget</a></td> +<td>Class implementing the main ollama interface widget.</td> +</tr> +</table> + +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> + +<hr /> +<hr /> +<a NAME="OllamaWidget" ID="OllamaWidget"></a> +<h2>OllamaWidget</h2> +<p> + Class implementing the main ollama interface widget. +</p> + +<h3>Derived from</h3> +QWidget, Ui_OllamaWidget +<h3>Class Attributes</h3> +<table> +<tr><td>OllamaHistoryFile</td></tr> +</table> + +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + +<h3>Methods</h3> +<table> +<tr> +<td><a href="#OllamaWidget.__init__">OllamaWidget</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__aboutToShowOllamaMenu">__aboutToShowOllamaMenu</a></td> +<td>Private slot to set the action enabled status.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__checkHistoryModels">__checkHistoryModels</a></td> +<td>Private slot to set the chat history entry states according to available models.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__connectClient">__connectClient</a></td> +<td>Private method to connect the client signals.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__createHistoryWidget">__createHistoryWidget</a></td> +<td>Private method to create a chat history widget and insert it into the respective layout.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__deleteHistory">__deleteHistory</a></td> +<td>Private slot to delete the history with the given ID.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__findChatWidget">__findChatWidget</a></td> +<td>Private method to find a chat widget given a chat history ID.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__findHistoryWidget">__findHistoryWidget</a></td> +<td>Private method to find the widget of a given chat history ID.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__finishSetup">__finishSetup</a></td> +<td>Private slot to finish the UI setup.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__getHistoryIds">__getHistoryIds</a></td> +<td>Private method to get a list of all history IDs.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__handleClientError">__handleClientError</a></td> +<td>Private slot to handle an error message sent by the server.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__handleClientFinished">__handleClientFinished</a></td> +<td>Private slot to handle the end of a client server interaction.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__handlePullError">__handlePullError</a></td> +<td>Private slot to handle an error during a pull operation.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__handlePullStatus">__handlePullStatus</a></td> +<td>Private slot to handle a pull status update.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__handleServerMessage">__handleServerMessage</a></td> +<td>Private slot handling an 'ollama' server chat response.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__handleServerStateChanged">__handleServerStateChanged</a></td> +<td>Private slot handling a change in the 'ollama' server responsiveness.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__historyFilePath">__historyFilePath</a></td> +<td>Private method to get the path name of the chat history file.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__initOllamaMenu">__initOllamaMenu</a></td> +<td>Private method to create the super menu and attach it to the super menu button.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__loadChatHistoriesFile">__loadChatHistoriesFile</a></td> +<td>Private method to load chat history entries from a given file.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__loadHistory">__loadHistory</a></td> +<td>Private method to load a previously saved history file.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__localServerProcessFinished">__localServerProcessFinished</a></td> +<td>Private slot handling the finishing of the local 'ollama' server process.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__menuClearAllHistories">__menuClearAllHistories</a></td> +<td>Private slot to clear all chat history entries.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__menuExportHistories">__menuExportHistories</a></td> +<td>Private slot to export chat history entries to a file.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__menuImportHistories">__menuImportHistories</a></td> +<td>Private slot to import chat history entries from a file.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__newChatWithHistory">__newChatWithHistory</a></td> +<td>Private slot to start a new chat using a previously saved history.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__ollamaConfigure">__ollamaConfigure</a></td> +<td>Private slot to show the ollama configuration page.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__populateModelSelector">__populateModelSelector</a></td> +<td>Private slot to receive the list of available model names and populate the model selector with them.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__pullModel">__pullModel</a></td> +<td>Private slot to download a model from the 'ollama' model library.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__removeChatWidget">__removeChatWidget</a></td> +<td>Private method to remove a chat widget given its chat history ID.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__removeModel">__removeModel</a></td> +<td>Private slot to remove a model from the 'ollama' server.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__saveChatHistoryFile">__saveChatHistoryFile</a></td> +<td>Private method to save the chat history entries to a file.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__saveHistory">__saveHistory</a></td> +<td>Private method to save the current chat history to the history file.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__scrollHistoryToBottom">__scrollHistoryToBottom</a></td> +<td>Private slot to scroll the history widget to the bottom.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__sendMessage">__sendMessage</a></td> +<td>Private method to send the given message of the current chat to the 'ollama' server.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__serverDialogClosed">__serverDialogClosed</a></td> +<td>Private slot handling the closing of the local server dialog.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__serverStarted">__serverStarted</a></td> +<td>Private slot to handle the start of a local server.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__serverStopped">__serverStopped</a></td> +<td>Private slot to handle the stopping of a local server.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__setEnabledState">__setEnabledState</a></td> +<td>Private method to set the enabled state of the main widget.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__setHeaderLabel">__setHeaderLabel</a></td> +<td>Private slot to receive the 'ollama' server version and set the header.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__showModelLibrary">__showModelLibrary</a></td> +<td>Private slot to open the 'ollama' model librayr web site.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__showModels">__showModels</a></td> +<td>Private slot to ask the 'ollama' server for a list of available models with some details.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__showRunningModels">__showRunningModels</a></td> +<td>Private slot to show a dialog with data of the running models.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__startLocalServer">__startLocalServer</a></td> +<td>Private slot to start a local 'ollama' server instance in the background.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__startLocalServerMonitoring">__startLocalServerMonitoring</a></td> +<td>Private slot to open a dialog for running a local 'ollama' server instance and monitor its output.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__stopLocalServer">__stopLocalServer</a></td> +<td>Private slot to stop a running local 'ollama' server instance.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.__updateMessageEditState">__updateMessageEditState</a></td> +<td>Private slot to set the enabled state of the message line edit and the send button.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.clearHistory">clearHistory</a></td> +<td>Public method to clear the history entries and close all chats.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.on_messageEdit_textChanged">on_messageEdit_textChanged</a></td> +<td>Private slot to handle a change of the entered message.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.on_modelComboBox_currentTextChanged">on_modelComboBox_currentTextChanged</a></td> +<td>Private slot handling the selection of a model.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.on_newChatButton_clicked">on_newChatButton_clicked</a></td> +<td>Private slot to start a new chat with the 'ollama' server.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.on_reloadModelsButton_clicked">on_reloadModelsButton_clicked</a></td> +<td>Private slot to reload the list of available models.</td> +</tr> +<tr> +<td><a href="#OllamaWidget.prepareServerRuntimeEnvironment">prepareServerRuntimeEnvironment</a></td> +<td>Public method to prepare a QProcessEnvironment object.</td> +</tr> +</table> + +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + + +<a NAME="OllamaWidget.__init__" ID="OllamaWidget.__init__"></a> +<h4>OllamaWidget (Constructor)</h4> +<b>OllamaWidget</b>(<i>plugin, fromEric=True, parent=None</i>) +<p> + Constructor +</p> + +<dl> + +<dt><i>plugin</i> (PluginOllamaInterface)</dt> +<dd> +reference to the plug-in object +</dd> +<dt><i>fromEric</i> (bool (optional))</dt> +<dd> +flag indicating the eric-ide mode (defaults to True) + (True = eric-ide mode, False = application mode) +</dd> +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="OllamaWidget.__aboutToShowOllamaMenu" ID="OllamaWidget.__aboutToShowOllamaMenu"></a> +<h4>OllamaWidget.__aboutToShowOllamaMenu</h4> +<b>__aboutToShowOllamaMenu</b>(<i></i>) +<p> + Private slot to set the action enabled status. +</p> + +<a NAME="OllamaWidget.__checkHistoryModels" ID="OllamaWidget.__checkHistoryModels"></a> +<h4>OllamaWidget.__checkHistoryModels</h4> +<b>__checkHistoryModels</b>(<i>modelNames</i>) +<p> + Private slot to set the chat history entry states according to available + models. +</p> + +<dl> + +<dt><i>modelNames</i> (list[str])</dt> +<dd> +list of model names +</dd> +</dl> +<a NAME="OllamaWidget.__connectClient" ID="OllamaWidget.__connectClient"></a> +<h4>OllamaWidget.__connectClient</h4> +<b>__connectClient</b>(<i></i>) +<p> + Private method to connect the client signals. +</p> + +<a NAME="OllamaWidget.__createHistoryWidget" ID="OllamaWidget.__createHistoryWidget"></a> +<h4>OllamaWidget.__createHistoryWidget</h4> +<b>__createHistoryWidget</b>(<i>title, model, jsonStr=None</i>) +<p> + Private method to create a chat history widget and insert it into the + respective layout. +</p> + +<dl> + +<dt><i>title</i> (str)</dt> +<dd> +title of the chat +</dd> +<dt><i>model</i> (str)</dt> +<dd> +name of the model +</dd> +<dt><i>jsonStr</i> (str (optional))</dt> +<dd> +string containing JSON serialize chat history data (defaults + to None) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the created history widget +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +OllamaHistoryWidget +</dd> +</dl> +<a NAME="OllamaWidget.__deleteHistory" ID="OllamaWidget.__deleteHistory"></a> +<h4>OllamaWidget.__deleteHistory</h4> +<b>__deleteHistory</b>(<i>hid</i>) +<p> + Private slot to delete the history with the given ID. +</p> + +<dl> + +<dt><i>hid</i> (str)</dt> +<dd> +ID of the history to be deleted +</dd> +</dl> +<a NAME="OllamaWidget.__findChatWidget" ID="OllamaWidget.__findChatWidget"></a> +<h4>OllamaWidget.__findChatWidget</h4> +<b>__findChatWidget</b>(<i>hid</i>) +<p> + Private method to find a chat widget given a chat history ID. +</p> + +<dl> + +<dt><i>hid</i> (str)</dt> +<dd> +chat history ID +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the chat widget related to the given ID +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +OllamaChatWidget +</dd> +</dl> +<a NAME="OllamaWidget.__findHistoryWidget" ID="OllamaWidget.__findHistoryWidget"></a> +<h4>OllamaWidget.__findHistoryWidget</h4> +<b>__findHistoryWidget</b>(<i>hid</i>) +<p> + Private method to find the widget of a given chat history ID. +</p> + +<dl> + +<dt><i>hid</i> (str)</dt> +<dd> +ID of the chat history +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the chat history widget +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +OllamaHistoryWidget +</dd> +</dl> +<a NAME="OllamaWidget.__finishSetup" ID="OllamaWidget.__finishSetup"></a> +<h4>OllamaWidget.__finishSetup</h4> +<b>__finishSetup</b>(<i></i>) +<p> + Private slot to finish the UI setup. +</p> + +<a NAME="OllamaWidget.__getHistoryIds" ID="OllamaWidget.__getHistoryIds"></a> +<h4>OllamaWidget.__getHistoryIds</h4> +<b>__getHistoryIds</b>(<i></i>) +<p> + Private method to get a list of all history IDs. +</p> + +<dl> +<dt>Return:</dt> +<dd> +list of history IDs +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list[str] +</dd> +</dl> +<a NAME="OllamaWidget.__handleClientError" ID="OllamaWidget.__handleClientError"></a> +<h4>OllamaWidget.__handleClientError</h4> +<b>__handleClientError</b>(<i>errMsg</i>) +<p> + Private slot to handle an error message sent by the server. +</p> + +<dl> + +<dt><i>errMsg</i> (str)</dt> +<dd> +error message +</dd> +</dl> +<a NAME="OllamaWidget.__handleClientFinished" ID="OllamaWidget.__handleClientFinished"></a> +<h4>OllamaWidget.__handleClientFinished</h4> +<b>__handleClientFinished</b>(<i></i>) +<p> + Private slot to handle the end of a client server interaction. +</p> + +<a NAME="OllamaWidget.__handlePullError" ID="OllamaWidget.__handlePullError"></a> +<h4>OllamaWidget.__handlePullError</h4> +<b>__handlePullError</b>(<i>errMsg</i>) +<p> + Private slot to handle an error during a pull operation. +</p> + +<dl> + +<dt><i>errMsg</i> (str)</dt> +<dd> +error message +</dd> +</dl> +<a NAME="OllamaWidget.__handlePullStatus" ID="OllamaWidget.__handlePullStatus"></a> +<h4>OllamaWidget.__handlePullStatus</h4> +<b>__handlePullStatus</b>(<i>status, idStr, total, completed</i>) +<p> + Private slot to handle a pull status update. +</p> + +<dl> + +<dt><i>status</i> (str)</dt> +<dd> +status message reported by the 'ollama' server +</dd> +<dt><i>idStr</i> (str)</dt> +<dd> +ID of the file being pulled or empty +</dd> +<dt><i>total</i> (int)</dt> +<dd> +size of the file being pulled or 0 in case of an empty ID +</dd> +<dt><i>completed</i> (int)</dt> +<dd> +downloaded bytes or 0 in case of an empty ID +</dd> +</dl> +<a NAME="OllamaWidget.__handleServerMessage" ID="OllamaWidget.__handleServerMessage"></a> +<h4>OllamaWidget.__handleServerMessage</h4> +<b>__handleServerMessage</b>(<i>content, role, done</i>) +<p> + Private slot handling an 'ollama' server chat response. +</p> + +<dl> + +<dt><i>content</i> (str)</dt> +<dd> +message sent by the server +</dd> +<dt><i>role</i> (str)</dt> +<dd> +role name +</dd> +<dt><i>done</i> (bool)</dt> +<dd> +flag indicating the last chat response +</dd> +</dl> +<a NAME="OllamaWidget.__handleServerStateChanged" ID="OllamaWidget.__handleServerStateChanged"></a> +<h4>OllamaWidget.__handleServerStateChanged</h4> +<b>__handleServerStateChanged</b>(<i>ok, msg</i>) +<p> + Private slot handling a change in the 'ollama' server responsiveness. +</p> + +<dl> + +<dt><i>ok</i> (bool)</dt> +<dd> +flag indicating a responsive 'ollama' server +</dd> +<dt><i>msg</i> (str)</dt> +<dd> +status message +</dd> +</dl> +<a NAME="OllamaWidget.__historyFilePath" ID="OllamaWidget.__historyFilePath"></a> +<h4>OllamaWidget.__historyFilePath</h4> +<b>__historyFilePath</b>(<i></i>) +<p> + Private method to get the path name of the chat history file. +</p> + +<dl> +<dt>Return:</dt> +<dd> +file path of the chat history file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<a NAME="OllamaWidget.__initOllamaMenu" ID="OllamaWidget.__initOllamaMenu"></a> +<h4>OllamaWidget.__initOllamaMenu</h4> +<b>__initOllamaMenu</b>(<i></i>) +<p> + Private method to create the super menu and attach it to the super + menu button. +</p> + +<a NAME="OllamaWidget.__loadChatHistoriesFile" ID="OllamaWidget.__loadChatHistoriesFile"></a> +<h4>OllamaWidget.__loadChatHistoriesFile</h4> +<b>__loadChatHistoriesFile</b>(<i>filePath, reportDuplicates=False</i>) +<p> + Private method to load chat history entries from a given file. +</p> + +<dl> + +<dt><i>filePath</i> (str)</dt> +<dd> +path of the chat history file +</dd> +<dt><i>reportDuplicates</i> (bool (optional))</dt> +<dd> +flag indicating to report skipped chat history entries + (defaults to False) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating success +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<a NAME="OllamaWidget.__loadHistory" ID="OllamaWidget.__loadHistory"></a> +<h4>OllamaWidget.__loadHistory</h4> +<b>__loadHistory</b>(<i></i>) +<p> + Private method to load a previously saved history file. +</p> + +<a NAME="OllamaWidget.__localServerProcessFinished" ID="OllamaWidget.__localServerProcessFinished"></a> +<h4>OllamaWidget.__localServerProcessFinished</h4> +<b>__localServerProcessFinished</b>(<i></i>) +<p> + Private slot handling the finishing of the local 'ollama' server process. +</p> + +<a NAME="OllamaWidget.__menuClearAllHistories" ID="OllamaWidget.__menuClearAllHistories"></a> +<h4>OllamaWidget.__menuClearAllHistories</h4> +<b>__menuClearAllHistories</b>(<i></i>) +<p> + Private slot to clear all chat history entries. +</p> + +<a NAME="OllamaWidget.__menuExportHistories" ID="OllamaWidget.__menuExportHistories"></a> +<h4>OllamaWidget.__menuExportHistories</h4> +<b>__menuExportHistories</b>(<i></i>) +<p> + Private slot to export chat history entries to a file. +</p> + +<a NAME="OllamaWidget.__menuImportHistories" ID="OllamaWidget.__menuImportHistories"></a> +<h4>OllamaWidget.__menuImportHistories</h4> +<b>__menuImportHistories</b>(<i></i>) +<p> + Private slot to import chat history entries from a file. +</p> + +<a NAME="OllamaWidget.__newChatWithHistory" ID="OllamaWidget.__newChatWithHistory"></a> +<h4>OllamaWidget.__newChatWithHistory</h4> +<b>__newChatWithHistory</b>(<i>hid</i>) +<p> + Private slot to start a new chat using a previously saved history. +</p> + +<dl> + +<dt><i>hid</i> (str)</dt> +<dd> +ID of the history to be used +</dd> +</dl> +<a NAME="OllamaWidget.__ollamaConfigure" ID="OllamaWidget.__ollamaConfigure"></a> +<h4>OllamaWidget.__ollamaConfigure</h4> +<b>__ollamaConfigure</b>(<i></i>) +<p> + Private slot to show the ollama configuration page. +</p> + +<a NAME="OllamaWidget.__populateModelSelector" ID="OllamaWidget.__populateModelSelector"></a> +<h4>OllamaWidget.__populateModelSelector</h4> +<b>__populateModelSelector</b>(<i>modelNames</i>) +<p> + Private slot to receive the list of available model names and populate + the model selector with them. +</p> + +<dl> + +<dt><i>modelNames</i> (list[str])</dt> +<dd> +list of model names +</dd> +</dl> +<a NAME="OllamaWidget.__pullModel" ID="OllamaWidget.__pullModel"></a> +<h4>OllamaWidget.__pullModel</h4> +<b>__pullModel</b>(<i></i>) +<p> + Private slot to download a model from the 'ollama' model library. +</p> + +<a NAME="OllamaWidget.__removeChatWidget" ID="OllamaWidget.__removeChatWidget"></a> +<h4>OllamaWidget.__removeChatWidget</h4> +<b>__removeChatWidget</b>(<i>hid</i>) +<p> + Private method to remove a chat widget given its chat history ID. +</p> + +<dl> + +<dt><i>hid</i> (str)</dt> +<dd> +chat history ID +</dd> +</dl> +<a NAME="OllamaWidget.__removeModel" ID="OllamaWidget.__removeModel"></a> +<h4>OllamaWidget.__removeModel</h4> +<b>__removeModel</b>(<i></i>) +<p> + Private slot to remove a model from the 'ollama' server. +</p> + +<a NAME="OllamaWidget.__saveChatHistoryFile" ID="OllamaWidget.__saveChatHistoryFile"></a> +<h4>OllamaWidget.__saveChatHistoryFile</h4> +<b>__saveChatHistoryFile</b>(<i>filePath, entries</i>) +<p> + Private method to save the chat history entries to a file. +</p> + +<dl> + +<dt><i>filePath</i> (str)</dt> +<dd> +file name to save to +</dd> +<dt><i>entries</i> (dict[str, str])</dt> +<dd> +dictionary containing the chat history entries as a + JSON serialized string indexed by their ID +</dd> +</dl> +<a NAME="OllamaWidget.__saveHistory" ID="OllamaWidget.__saveHistory"></a> +<h4>OllamaWidget.__saveHistory</h4> +<b>__saveHistory</b>(<i></i>) +<p> + Private method to save the current chat history to the history file. +</p> + +<a NAME="OllamaWidget.__scrollHistoryToBottom" ID="OllamaWidget.__scrollHistoryToBottom"></a> +<h4>OllamaWidget.__scrollHistoryToBottom</h4> +<b>__scrollHistoryToBottom</b>(<i></i>) +<p> + Private slot to scroll the history widget to the bottom. +</p> + +<a NAME="OllamaWidget.__sendMessage" ID="OllamaWidget.__sendMessage"></a> +<h4>OllamaWidget.__sendMessage</h4> +<b>__sendMessage</b>(<i></i>) +<p> + Private method to send the given message of the current chat to the + 'ollama' server. +</p> +<p> + This sends the message with context (i.e. the history of the current chat). +</p> + +<a NAME="OllamaWidget.__serverDialogClosed" ID="OllamaWidget.__serverDialogClosed"></a> +<h4>OllamaWidget.__serverDialogClosed</h4> +<b>__serverDialogClosed</b>(<i></i>) +<p> + Private slot handling the closing of the local server dialog. +</p> + +<a NAME="OllamaWidget.__serverStarted" ID="OllamaWidget.__serverStarted"></a> +<h4>OllamaWidget.__serverStarted</h4> +<b>__serverStarted</b>(<i></i>) +<p> + Private slot to handle the start of a local server. +</p> + +<a NAME="OllamaWidget.__serverStopped" ID="OllamaWidget.__serverStopped"></a> +<h4>OllamaWidget.__serverStopped</h4> +<b>__serverStopped</b>(<i></i>) +<p> + Private slot to handle the stopping of a local server. +</p> + +<a NAME="OllamaWidget.__setEnabledState" ID="OllamaWidget.__setEnabledState"></a> +<h4>OllamaWidget.__setEnabledState</h4> +<b>__setEnabledState</b>(<i>enable</i>) +<p> + Private method to set the enabled state of the main widget. +</p> + +<dl> + +<dt><i>enable</i> (bool)</dt> +<dd> +enabled state +</dd> +</dl> +<a NAME="OllamaWidget.__setHeaderLabel" ID="OllamaWidget.__setHeaderLabel"></a> +<h4>OllamaWidget.__setHeaderLabel</h4> +<b>__setHeaderLabel</b>(<i>version</i>) +<p> + Private slot to receive the 'ollama' server version and set the header. +</p> + +<dl> + +<dt><i>version</i> (str)</dt> +<dd> +'ollama' server version' +</dd> +</dl> +<a NAME="OllamaWidget.__showModelLibrary" ID="OllamaWidget.__showModelLibrary"></a> +<h4>OllamaWidget.__showModelLibrary</h4> +<b>__showModelLibrary</b>(<i></i>) +<p> + Private slot to open the 'ollama' model librayr web site. +</p> + +<a NAME="OllamaWidget.__showModels" ID="OllamaWidget.__showModels"></a> +<h4>OllamaWidget.__showModels</h4> +<b>__showModels</b>(<i></i>) +<p> + Private slot to ask the 'ollama' server for a list of available models with + some details. +</p> + +<a NAME="OllamaWidget.__showRunningModels" ID="OllamaWidget.__showRunningModels"></a> +<h4>OllamaWidget.__showRunningModels</h4> +<b>__showRunningModels</b>(<i></i>) +<p> + Private slot to show a dialog with data of the running models. +</p> + +<a NAME="OllamaWidget.__startLocalServer" ID="OllamaWidget.__startLocalServer"></a> +<h4>OllamaWidget.__startLocalServer</h4> +<b>__startLocalServer</b>(<i></i>) +<p> + Private slot to start a local 'ollama' server instance in the background. +</p> + +<a NAME="OllamaWidget.__startLocalServerMonitoring" ID="OllamaWidget.__startLocalServerMonitoring"></a> +<h4>OllamaWidget.__startLocalServerMonitoring</h4> +<b>__startLocalServerMonitoring</b>(<i></i>) +<p> + Private slot to open a dialog for running a local 'ollama' server instance + and monitor its output. +</p> + +<a NAME="OllamaWidget.__stopLocalServer" ID="OllamaWidget.__stopLocalServer"></a> +<h4>OllamaWidget.__stopLocalServer</h4> +<b>__stopLocalServer</b>(<i></i>) +<p> + Private slot to stop a running local 'ollama' server instance. +</p> + +<a NAME="OllamaWidget.__updateMessageEditState" ID="OllamaWidget.__updateMessageEditState"></a> +<h4>OllamaWidget.__updateMessageEditState</h4> +<b>__updateMessageEditState</b>(<i></i>) +<p> + Private slot to set the enabled state of the message line edit and the send + button. +</p> + +<a NAME="OllamaWidget.clearHistory" ID="OllamaWidget.clearHistory"></a> +<h4>OllamaWidget.clearHistory</h4> +<b>clearHistory</b>(<i></i>) +<p> + Public method to clear the history entries and close all chats. +</p> + +<a NAME="OllamaWidget.on_messageEdit_textChanged" ID="OllamaWidget.on_messageEdit_textChanged"></a> +<h4>OllamaWidget.on_messageEdit_textChanged</h4> +<b>on_messageEdit_textChanged</b>(<i></i>) +<p> + Private slot to handle a change of the entered message. +</p> + +<a NAME="OllamaWidget.on_modelComboBox_currentTextChanged" ID="OllamaWidget.on_modelComboBox_currentTextChanged"></a> +<h4>OllamaWidget.on_modelComboBox_currentTextChanged</h4> +<b>on_modelComboBox_currentTextChanged</b>(<i>model</i>) +<p> + Private slot handling the selection of a model. +</p> + +<dl> + +<dt><i>model</i> (str)</dt> +<dd> +name of the selected model +</dd> +</dl> +<a NAME="OllamaWidget.on_newChatButton_clicked" ID="OllamaWidget.on_newChatButton_clicked"></a> +<h4>OllamaWidget.on_newChatButton_clicked</h4> +<b>on_newChatButton_clicked</b>(<i></i>) +<p> + Private slot to start a new chat with the 'ollama' server. +</p> + +<a NAME="OllamaWidget.on_reloadModelsButton_clicked" ID="OllamaWidget.on_reloadModelsButton_clicked"></a> +<h4>OllamaWidget.on_reloadModelsButton_clicked</h4> +<b>on_reloadModelsButton_clicked</b>(<i></i>) +<p> + Private slot to reload the list of available models. +</p> + +<a NAME="OllamaWidget.prepareServerRuntimeEnvironment" ID="OllamaWidget.prepareServerRuntimeEnvironment"></a> +<h4>OllamaWidget.prepareServerRuntimeEnvironment</h4> +<b>prepareServerRuntimeEnvironment</b>(<i></i>) +<p> + Public method to prepare a QProcessEnvironment object. +</p> + +<dl> +<dt>Return:</dt> +<dd> +prepared environment object to be used with QProcess +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QProcessEnvironment +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/OllamaInterface/Documentation/Source/Plugin_AI_Ollama.OllamaInterface.RunOllamaServerDialog.html Thu Aug 29 13:15:36 2024 +0200 @@ -0,0 +1,187 @@ +<!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>
--- a/OllamaInterface/Documentation/Source/Plugin_AI_Ollama.PluginAiOllama.html Thu Aug 29 13:13:53 2024 +0200 +++ b/OllamaInterface/Documentation/Source/Plugin_AI_Ollama.PluginAiOllama.html Thu Aug 29 13:15:36 2024 +0200 @@ -7,21 +7,335 @@ <body> <a NAME="top" ID="top"></a> <h1>Plugin_AI_Ollama.PluginAiOllama</h1> +<p> +Module implementing the ollama Interface plug-in. +</p> <h3>Global Attributes</h3> <table> -<tr><td>None</td></tr> +<tr><td>_Side</td></tr> +<tr><td>__header__</td></tr> +<tr><td>error</td></tr> +<tr><td>ollamaInterfacePluginObject</td></tr> </table> <h3>Classes</h3> <table> -<tr><td>None</td></tr> +<tr> +<td><a href="#PluginOllamaInterface">PluginOllamaInterface</a></td> +<td>Class implementing the ollama Interface plug-in.</td> +</tr> </table> <h3>Functions</h3> <table> +<tr> +<td><a href="#clearPrivateData">clearPrivateData</a></td> +<td>Function to clear the private data of the plug-in.</td> +</tr> +<tr> +<td><a href="#createOllamaPage">createOllamaPage</a></td> +<td>Function to create the 'ollama' interface' configuration page.</td> +</tr> +<tr> +<td><a href="#getConfigData">getConfigData</a></td> +<td>Function returning data as required by the configuration dialog.</td> +</tr> +<tr> +<td><a href="#prepareUninstall">prepareUninstall</a></td> +<td>Function to prepare for an un-installation.</td> +</tr> +</table> + +<hr /> +<hr /> +<a NAME="PluginOllamaInterface" ID="PluginOllamaInterface"></a> +<h2>PluginOllamaInterface</h2> +<p> + Class implementing the ollama Interface plug-in. +</p> + +<h3>Signals</h3> +<dl> + +<dt>preferencesChanged()</dt> +<dd> +emitted to signal a change of preferences. This + signal is simply relayed from the main UI. +</dd> +</dl> +<h3>Derived from</h3> +QObject +<h3>Class Attributes</h3> +<table> +<tr><td>PreferencesKey</td></tr> +</table> + +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + +<h3>Methods</h3> +<table> +<tr> +<td><a href="#PluginOllamaInterface.__init__">PluginOllamaInterface</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#PluginOllamaInterface.__activateLeftRightSidebarWidget">__activateLeftRightSidebarWidget</a></td> +<td>Private method to activate the given widget in the left or right sidebar.</td> +</tr> +<tr> +<td><a href="#PluginOllamaInterface.__activateWidget">__activateWidget</a></td> +<td>Private slot to handle the activation of the pipx interface.</td> +</tr> +<tr> +<td><a href="#PluginOllamaInterface.__initialize">__initialize</a></td> +<td>Private slot to (re)initialize the plugin.</td> +</tr> +<tr> +<td><a href="#PluginOllamaInterface.__loadTranslator">__loadTranslator</a></td> +<td>Private method to load the translation file.</td> +</tr> +<tr> +<td><a href="#PluginOllamaInterface.activate">activate</a></td> +<td>Public method to activate this plug-in.</td> +</tr> +<tr> +<td><a href="#PluginOllamaInterface.deactivate">deactivate</a></td> +<td>Public method to deactivate this plug-in.</td> +</tr> +<tr> +<td><a href="#PluginOllamaInterface.getPreferences">getPreferences</a></td> +<td>Public method to retrieve the various settings values.</td> +</tr> +<tr> +<td><a href="#PluginOllamaInterface.getWidget">getWidget</a></td> +<td>Public method to get a reference to the 'ollama' widget.</td> +</tr> +<tr> +<td><a href="#PluginOllamaInterface.setPreferences">setPreferences</a></td> +<td>Public method to store the various settings values.</td> +</tr> +</table> + +<h3>Static Methods</h3> +<table> <tr><td>None</td></tr> </table> + +<a NAME="PluginOllamaInterface.__init__" ID="PluginOllamaInterface.__init__"></a> +<h4>PluginOllamaInterface (Constructor)</h4> +<b>PluginOllamaInterface</b>(<i>ui</i>) +<p> + Constructor +</p> + +<dl> + +<dt><i>ui</i> (UI.UserInterface)</dt> +<dd> +reference to the user interface object +</dd> +</dl> +<a NAME="PluginOllamaInterface.__activateLeftRightSidebarWidget" ID="PluginOllamaInterface.__activateLeftRightSidebarWidget"></a> +<h4>PluginOllamaInterface.__activateLeftRightSidebarWidget</h4> +<b>__activateLeftRightSidebarWidget</b>(<i>widget</i>) +<p> + Private method to activate the given widget in the left or right + sidebar. +</p> + +<dl> + +<dt><i>widget</i> (QWidget)</dt> +<dd> +reference to the widget to be activated +</dd> +</dl> +<a NAME="PluginOllamaInterface.__activateWidget" ID="PluginOllamaInterface.__activateWidget"></a> +<h4>PluginOllamaInterface.__activateWidget</h4> +<b>__activateWidget</b>(<i></i>) +<p> + Private slot to handle the activation of the pipx interface. +</p> + +<a NAME="PluginOllamaInterface.__initialize" ID="PluginOllamaInterface.__initialize"></a> +<h4>PluginOllamaInterface.__initialize</h4> +<b>__initialize</b>(<i></i>) +<p> + Private slot to (re)initialize the plugin. +</p> + +<a NAME="PluginOllamaInterface.__loadTranslator" ID="PluginOllamaInterface.__loadTranslator"></a> +<h4>PluginOllamaInterface.__loadTranslator</h4> +<b>__loadTranslator</b>(<i></i>) +<p> + Private method to load the translation file. +</p> + +<a NAME="PluginOllamaInterface.activate" ID="PluginOllamaInterface.activate"></a> +<h4>PluginOllamaInterface.activate</h4> +<b>activate</b>(<i></i>) +<p> + Public method to activate this plug-in. +</p> + +<dl> +<dt>Return:</dt> +<dd> +tuple of None and activation status +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="PluginOllamaInterface.deactivate" ID="PluginOllamaInterface.deactivate"></a> +<h4>PluginOllamaInterface.deactivate</h4> +<b>deactivate</b>(<i></i>) +<p> + Public method to deactivate this plug-in. +</p> + +<a NAME="PluginOllamaInterface.getPreferences" ID="PluginOllamaInterface.getPreferences"></a> +<h4>PluginOllamaInterface.getPreferences</h4> +<b>getPreferences</b>(<i>key</i>) +<p> + Public method to retrieve the various settings values. +</p> + +<dl> + +<dt><i>key</i> (str)</dt> +<dd> +the key of the value to get +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +the requested setting value +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +Any +</dd> +</dl> +<a NAME="PluginOllamaInterface.getWidget" ID="PluginOllamaInterface.getWidget"></a> +<h4>PluginOllamaInterface.getWidget</h4> +<b>getWidget</b>(<i></i>) +<p> + Public method to get a reference to the 'ollama' widget. +</p> + +<dl> +<dt>Return:</dt> +<dd> +reference to the 'ollama' widget +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +OllamaWidget +</dd> +</dl> +<a NAME="PluginOllamaInterface.setPreferences" ID="PluginOllamaInterface.setPreferences"></a> +<h4>PluginOllamaInterface.setPreferences</h4> +<b>setPreferences</b>(<i>key, value</i>) +<p> + Public method to store the various settings values. +</p> + +<dl> + +<dt><i>key</i> (str)</dt> +<dd> +the key of the setting to be set +</dd> +<dt><i>value</i> (Any)</dt> +<dd> +the value to be set +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="clearPrivateData" ID="clearPrivateData"></a> +<h2>clearPrivateData</h2> +<b>clearPrivateData</b>(<i></i>) +<p> + Function to clear the private data of the plug-in. +</p> + +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="createOllamaPage" ID="createOllamaPage"></a> +<h2>createOllamaPage</h2> +<b>createOllamaPage</b>(<i>_configDlg</i>) +<p> + Function to create the 'ollama' interface' configuration page. +</p> + +<dl> + +<dt><i>_configDlg</i> (ConfigurationWidget)</dt> +<dd> +reference to the configuration dialog +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the configuration page +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +OllamaPage +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="getConfigData" ID="getConfigData"></a> +<h2>getConfigData</h2> +<b>getConfigData</b>(<i></i>) +<p> + Function returning data as required by the configuration dialog. +</p> + +<dl> +<dt>Return:</dt> +<dd> +dictionary containing the relevant data +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="prepareUninstall" ID="prepareUninstall"></a> +<h2>prepareUninstall</h2> +<b>prepareUninstall</b>(<i></i>) +<p> + Function to prepare for an un-installation. +</p> + +<div align="right"><a href="#top">Up</a></div> <hr /> </body></html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/OllamaInterface/Documentation/Source/index-Plugin_AI_Ollama.OllamaInterface.ConfigurationPage.html Thu Aug 29 13:15:36 2024 +0200 @@ -0,0 +1,23 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_AI_Ollama.OllamaInterface.ConfigurationPage</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<h1>Plugin_AI_Ollama.OllamaInterface.ConfigurationPage</h1> +<p> +Package implementing the configuration page. +</p> + + + +<h3>Modules</h3> +<table> + +<tr> +<td><a href="Plugin_AI_Ollama.OllamaInterface.ConfigurationPage.OllamaPage.html">OllamaPage</a></td> +<td>Module implementing the 'ollama' interface configuration page.</td> +</tr> +</table> +</body></html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/OllamaInterface/Documentation/Source/index-Plugin_AI_Ollama.OllamaInterface.html Thu Aug 29 13:15:36 2024 +0200 @@ -0,0 +1,67 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_AI_Ollama.OllamaInterface</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<h1>Plugin_AI_Ollama.OllamaInterface</h1> +<p> +Package implementing the various 'ollama' modules and data. +</p> + + +<h3>Packages</h3> +<table> + +<tr> +<td><a href="index-Plugin_AI_Ollama.OllamaInterface.ConfigurationPage.html">ConfigurationPage</a></td> +<td>Package implementing the configuration page.</td> +</tr> +</table> + +<h3>Modules</h3> +<table> + +<tr> +<td><a href="Plugin_AI_Ollama.OllamaInterface.AutoResizeTextBrowser.html">AutoResizeTextBrowser</a></td> +<td>Module implementing a QTextBrowser widget that resizes automatically.</td> +</tr> +<tr> +<td><a href="Plugin_AI_Ollama.OllamaInterface.OllamaChatMessageBox.html">OllamaChatMessageBox</a></td> +<td>Module implementing a message box widget showing the role and content of a message.</td> +</tr> +<tr> +<td><a href="Plugin_AI_Ollama.OllamaInterface.OllamaChatWidget.html">OllamaChatWidget</a></td> +<td>Module implementing a widget showing the chat with the 'ollama' server.</td> +</tr> +<tr> +<td><a href="Plugin_AI_Ollama.OllamaInterface.OllamaClient.html">OllamaClient</a></td> +<td>Module implementing the 'ollama' client.</td> +</tr> +<tr> +<td><a href="Plugin_AI_Ollama.OllamaInterface.OllamaDetailedModelsDialog.html">OllamaDetailedModelsDialog</a></td> +<td>Module implementing a dialog to show details of the available models.</td> +</tr> +<tr> +<td><a href="Plugin_AI_Ollama.OllamaInterface.OllamaHistoryWidget.html">OllamaHistoryWidget</a></td> +<td>Module implementing a widget showing a chat title and store a chat contents.</td> +</tr> +<tr> +<td><a href="Plugin_AI_Ollama.OllamaInterface.OllamaPullProgressDialog.html">OllamaPullProgressDialog</a></td> +<td>Module implementing a dialog showing the progress of a model pull action..</td> +</tr> +<tr> +<td><a href="Plugin_AI_Ollama.OllamaInterface.OllamaRunningModelsDialog.html">OllamaRunningModelsDialog</a></td> +<td>Module implementing a dialog to show details of the running models.</td> +</tr> +<tr> +<td><a href="Plugin_AI_Ollama.OllamaInterface.OllamaWidget.html">OllamaWidget</a></td> +<td>Module implementing the main ollama interface widget.</td> +</tr> +<tr> +<td><a href="Plugin_AI_Ollama.OllamaInterface.RunOllamaServerDialog.html">RunOllamaServerDialog</a></td> +<td>Module implementing a dialog to run the ollama server locally.</td> +</tr> +</table> +</body></html>
--- a/OllamaInterface/Documentation/Source/index-Plugin_AI_Ollama.html Thu Aug 29 13:13:53 2024 +0200 +++ b/OllamaInterface/Documentation/Source/index-Plugin_AI_Ollama.html Thu Aug 29 13:15:36 2024 +0200 @@ -6,15 +6,26 @@ </head> <body> <h1>Plugin_AI_Ollama</h1> +<p> +Package implementing the 'ollama' interface plug-in. +</p> +<h3>Packages</h3> +<table> + +<tr> +<td><a href="index-Plugin_AI_Ollama.OllamaInterface.html">OllamaInterface</a></td> +<td>Package implementing the various 'ollama' modules and data.</td> +</tr> +</table> <h3>Modules</h3> <table> <tr> <td><a href="Plugin_AI_Ollama.PluginAiOllama.html">PluginAiOllama</a></td> -<td></td> +<td>Module implementing the ollama Interface plug-in.</td> </tr> </table> </body></html>
--- a/OllamaInterface/Documentation/Source/index.html Thu Aug 29 13:13:53 2024 +0200 +++ b/OllamaInterface/Documentation/Source/index.html Thu Aug 29 13:15:36 2024 +0200 @@ -13,7 +13,7 @@ <tr> <td><a href="index-Plugin_AI_Ollama.html">Plugin_AI_Ollama</a></td> -<td></td> +<td>Package implementing the 'ollama' interface plug-in.</td> </tr> </table>