Mercurial Repositories > ollama Interface / file comparison
comparison: OllamaInterface/Documentation/Source/Plugin_AI_Ollama.PluginAiOllama.html
OllamaInterface/Documentation/Source/Plugin_AI_Ollama.PluginAiOllama.html
- changeset 18
- 0a5b9c233a6e
- parent 1
- 124e1b8f276b
equal
deleted
inserted
replaced
| 17:43b1396fe72f | 18:0a5b9c233a6e |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>Plugin_AI_Ollama.PluginAiOllama</h1> | 9 <h1>Plugin_AI_Ollama.PluginAiOllama</h1> |
| 10 <p> | |
| 11 Module implementing the ollama Interface plug-in. | |
| 12 </p> | |
| 10 | 13 |
| 11 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 12 <table> | 15 <table> |
| 16 <tr><td>_Side</td></tr> | |
| 17 <tr><td>__header__</td></tr> | |
| 18 <tr><td>error</td></tr> | |
| 19 <tr><td>ollamaInterfacePluginObject</td></tr> | |
| 20 </table> | |
| 21 | |
| 22 <h3>Classes</h3> | |
| 23 <table> | |
| 24 <tr> | |
| 25 <td><a href="#PluginOllamaInterface">PluginOllamaInterface</a></td> | |
| 26 <td>Class implementing the ollama Interface plug-in.</td> | |
| 27 </tr> | |
| 28 </table> | |
| 29 | |
| 30 <h3>Functions</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#clearPrivateData">clearPrivateData</a></td> | |
| 34 <td>Function to clear the private data of the plug-in.</td> | |
| 35 </tr> | |
| 36 <tr> | |
| 37 <td><a href="#createOllamaPage">createOllamaPage</a></td> | |
| 38 <td>Function to create the 'ollama' interface' configuration page.</td> | |
| 39 </tr> | |
| 40 <tr> | |
| 41 <td><a href="#getConfigData">getConfigData</a></td> | |
| 42 <td>Function returning data as required by the configuration dialog.</td> | |
| 43 </tr> | |
| 44 <tr> | |
| 45 <td><a href="#prepareUninstall">prepareUninstall</a></td> | |
| 46 <td>Function to prepare for an un-installation.</td> | |
| 47 </tr> | |
| 48 </table> | |
| 49 | |
| 50 <hr /> | |
| 51 <hr /> | |
| 52 <a NAME="PluginOllamaInterface" ID="PluginOllamaInterface"></a> | |
| 53 <h2>PluginOllamaInterface</h2> | |
| 54 <p> | |
| 55 Class implementing the ollama Interface plug-in. | |
| 56 </p> | |
| 57 | |
| 58 <h3>Signals</h3> | |
| 59 <dl> | |
| 60 | |
| 61 <dt>preferencesChanged()</dt> | |
| 62 <dd> | |
| 63 emitted to signal a change of preferences. This | |
| 64 signal is simply relayed from the main UI. | |
| 65 </dd> | |
| 66 </dl> | |
| 67 <h3>Derived from</h3> | |
| 68 QObject | |
| 69 <h3>Class Attributes</h3> | |
| 70 <table> | |
| 71 <tr><td>PreferencesKey</td></tr> | |
| 72 </table> | |
| 73 | |
| 74 <h3>Class Methods</h3> | |
| 75 <table> | |
| 13 <tr><td>None</td></tr> | 76 <tr><td>None</td></tr> |
| 14 </table> | 77 </table> |
| 15 | 78 |
| 16 <h3>Classes</h3> | 79 <h3>Methods</h3> |
| 80 <table> | |
| 81 <tr> | |
| 82 <td><a href="#PluginOllamaInterface.__init__">PluginOllamaInterface</a></td> | |
| 83 <td>Constructor</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#PluginOllamaInterface.__activateLeftRightSidebarWidget">__activateLeftRightSidebarWidget</a></td> | |
| 87 <td>Private method to activate the given widget in the left or right sidebar.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#PluginOllamaInterface.__activateWidget">__activateWidget</a></td> | |
| 91 <td>Private slot to handle the activation of the pipx interface.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#PluginOllamaInterface.__initialize">__initialize</a></td> | |
| 95 <td>Private slot to (re)initialize the plugin.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#PluginOllamaInterface.__loadTranslator">__loadTranslator</a></td> | |
| 99 <td>Private method to load the translation file.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#PluginOllamaInterface.activate">activate</a></td> | |
| 103 <td>Public method to activate this plug-in.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#PluginOllamaInterface.deactivate">deactivate</a></td> | |
| 107 <td>Public method to deactivate this plug-in.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#PluginOllamaInterface.getPreferences">getPreferences</a></td> | |
| 111 <td>Public method to retrieve the various settings values.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#PluginOllamaInterface.getWidget">getWidget</a></td> | |
| 115 <td>Public method to get a reference to the 'ollama' widget.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#PluginOllamaInterface.setPreferences">setPreferences</a></td> | |
| 119 <td>Public method to store the various settings values.</td> | |
| 120 </tr> | |
| 121 </table> | |
| 122 | |
| 123 <h3>Static Methods</h3> | |
| 17 <table> | 124 <table> |
| 18 <tr><td>None</td></tr> | 125 <tr><td>None</td></tr> |
| 19 </table> | 126 </table> |
| 20 | 127 |
| 21 <h3>Functions</h3> | 128 |
| 22 <table> | 129 <a NAME="PluginOllamaInterface.__init__" ID="PluginOllamaInterface.__init__"></a> |
| 23 <tr><td>None</td></tr> | 130 <h4>PluginOllamaInterface (Constructor)</h4> |
| 24 </table> | 131 <b>PluginOllamaInterface</b>(<i>ui</i>) |
| 25 | 132 <p> |
| 133 Constructor | |
| 134 </p> | |
| 135 | |
| 136 <dl> | |
| 137 | |
| 138 <dt><i>ui</i> (UI.UserInterface)</dt> | |
| 139 <dd> | |
| 140 reference to the user interface object | |
| 141 </dd> | |
| 142 </dl> | |
| 143 <a NAME="PluginOllamaInterface.__activateLeftRightSidebarWidget" ID="PluginOllamaInterface.__activateLeftRightSidebarWidget"></a> | |
| 144 <h4>PluginOllamaInterface.__activateLeftRightSidebarWidget</h4> | |
| 145 <b>__activateLeftRightSidebarWidget</b>(<i>widget</i>) | |
| 146 <p> | |
| 147 Private method to activate the given widget in the left or right | |
| 148 sidebar. | |
| 149 </p> | |
| 150 | |
| 151 <dl> | |
| 152 | |
| 153 <dt><i>widget</i> (QWidget)</dt> | |
| 154 <dd> | |
| 155 reference to the widget to be activated | |
| 156 </dd> | |
| 157 </dl> | |
| 158 <a NAME="PluginOllamaInterface.__activateWidget" ID="PluginOllamaInterface.__activateWidget"></a> | |
| 159 <h4>PluginOllamaInterface.__activateWidget</h4> | |
| 160 <b>__activateWidget</b>(<i></i>) | |
| 161 <p> | |
| 162 Private slot to handle the activation of the pipx interface. | |
| 163 </p> | |
| 164 | |
| 165 <a NAME="PluginOllamaInterface.__initialize" ID="PluginOllamaInterface.__initialize"></a> | |
| 166 <h4>PluginOllamaInterface.__initialize</h4> | |
| 167 <b>__initialize</b>(<i></i>) | |
| 168 <p> | |
| 169 Private slot to (re)initialize the plugin. | |
| 170 </p> | |
| 171 | |
| 172 <a NAME="PluginOllamaInterface.__loadTranslator" ID="PluginOllamaInterface.__loadTranslator"></a> | |
| 173 <h4>PluginOllamaInterface.__loadTranslator</h4> | |
| 174 <b>__loadTranslator</b>(<i></i>) | |
| 175 <p> | |
| 176 Private method to load the translation file. | |
| 177 </p> | |
| 178 | |
| 179 <a NAME="PluginOllamaInterface.activate" ID="PluginOllamaInterface.activate"></a> | |
| 180 <h4>PluginOllamaInterface.activate</h4> | |
| 181 <b>activate</b>(<i></i>) | |
| 182 <p> | |
| 183 Public method to activate this plug-in. | |
| 184 </p> | |
| 185 | |
| 186 <dl> | |
| 187 <dt>Return:</dt> | |
| 188 <dd> | |
| 189 tuple of None and activation status | |
| 190 </dd> | |
| 191 </dl> | |
| 192 <dl> | |
| 193 <dt>Return Type:</dt> | |
| 194 <dd> | |
| 195 bool | |
| 196 </dd> | |
| 197 </dl> | |
| 198 <a NAME="PluginOllamaInterface.deactivate" ID="PluginOllamaInterface.deactivate"></a> | |
| 199 <h4>PluginOllamaInterface.deactivate</h4> | |
| 200 <b>deactivate</b>(<i></i>) | |
| 201 <p> | |
| 202 Public method to deactivate this plug-in. | |
| 203 </p> | |
| 204 | |
| 205 <a NAME="PluginOllamaInterface.getPreferences" ID="PluginOllamaInterface.getPreferences"></a> | |
| 206 <h4>PluginOllamaInterface.getPreferences</h4> | |
| 207 <b>getPreferences</b>(<i>key</i>) | |
| 208 <p> | |
| 209 Public method to retrieve the various settings values. | |
| 210 </p> | |
| 211 | |
| 212 <dl> | |
| 213 | |
| 214 <dt><i>key</i> (str)</dt> | |
| 215 <dd> | |
| 216 the key of the value to get | |
| 217 </dd> | |
| 218 </dl> | |
| 219 <dl> | |
| 220 <dt>Return:</dt> | |
| 221 <dd> | |
| 222 the requested setting value | |
| 223 </dd> | |
| 224 </dl> | |
| 225 <dl> | |
| 226 <dt>Return Type:</dt> | |
| 227 <dd> | |
| 228 Any | |
| 229 </dd> | |
| 230 </dl> | |
| 231 <a NAME="PluginOllamaInterface.getWidget" ID="PluginOllamaInterface.getWidget"></a> | |
| 232 <h4>PluginOllamaInterface.getWidget</h4> | |
| 233 <b>getWidget</b>(<i></i>) | |
| 234 <p> | |
| 235 Public method to get a reference to the 'ollama' widget. | |
| 236 </p> | |
| 237 | |
| 238 <dl> | |
| 239 <dt>Return:</dt> | |
| 240 <dd> | |
| 241 reference to the 'ollama' widget | |
| 242 </dd> | |
| 243 </dl> | |
| 244 <dl> | |
| 245 <dt>Return Type:</dt> | |
| 246 <dd> | |
| 247 OllamaWidget | |
| 248 </dd> | |
| 249 </dl> | |
| 250 <a NAME="PluginOllamaInterface.setPreferences" ID="PluginOllamaInterface.setPreferences"></a> | |
| 251 <h4>PluginOllamaInterface.setPreferences</h4> | |
| 252 <b>setPreferences</b>(<i>key, value</i>) | |
| 253 <p> | |
| 254 Public method to store the various settings values. | |
| 255 </p> | |
| 256 | |
| 257 <dl> | |
| 258 | |
| 259 <dt><i>key</i> (str)</dt> | |
| 260 <dd> | |
| 261 the key of the setting to be set | |
| 262 </dd> | |
| 263 <dt><i>value</i> (Any)</dt> | |
| 264 <dd> | |
| 265 the value to be set | |
| 266 </dd> | |
| 267 </dl> | |
| 268 <div align="right"><a href="#top">Up</a></div> | |
| 269 <hr /> | |
| 270 <hr /> | |
| 271 <a NAME="clearPrivateData" ID="clearPrivateData"></a> | |
| 272 <h2>clearPrivateData</h2> | |
| 273 <b>clearPrivateData</b>(<i></i>) | |
| 274 <p> | |
| 275 Function to clear the private data of the plug-in. | |
| 276 </p> | |
| 277 | |
| 278 <div align="right"><a href="#top">Up</a></div> | |
| 279 <hr /> | |
| 280 <hr /> | |
| 281 <a NAME="createOllamaPage" ID="createOllamaPage"></a> | |
| 282 <h2>createOllamaPage</h2> | |
| 283 <b>createOllamaPage</b>(<i>_configDlg</i>) | |
| 284 <p> | |
| 285 Function to create the 'ollama' interface' configuration page. | |
| 286 </p> | |
| 287 | |
| 288 <dl> | |
| 289 | |
| 290 <dt><i>_configDlg</i> (ConfigurationWidget)</dt> | |
| 291 <dd> | |
| 292 reference to the configuration dialog | |
| 293 </dd> | |
| 294 </dl> | |
| 295 <dl> | |
| 296 <dt>Return:</dt> | |
| 297 <dd> | |
| 298 reference to the configuration page | |
| 299 </dd> | |
| 300 </dl> | |
| 301 <dl> | |
| 302 <dt>Return Type:</dt> | |
| 303 <dd> | |
| 304 OllamaPage | |
| 305 </dd> | |
| 306 </dl> | |
| 307 <div align="right"><a href="#top">Up</a></div> | |
| 308 <hr /> | |
| 309 <hr /> | |
| 310 <a NAME="getConfigData" ID="getConfigData"></a> | |
| 311 <h2>getConfigData</h2> | |
| 312 <b>getConfigData</b>(<i></i>) | |
| 313 <p> | |
| 314 Function returning data as required by the configuration dialog. | |
| 315 </p> | |
| 316 | |
| 317 <dl> | |
| 318 <dt>Return:</dt> | |
| 319 <dd> | |
| 320 dictionary containing the relevant data | |
| 321 </dd> | |
| 322 </dl> | |
| 323 <dl> | |
| 324 <dt>Return Type:</dt> | |
| 325 <dd> | |
| 326 dict | |
| 327 </dd> | |
| 328 </dl> | |
| 329 <div align="right"><a href="#top">Up</a></div> | |
| 330 <hr /> | |
| 331 <hr /> | |
| 332 <a NAME="prepareUninstall" ID="prepareUninstall"></a> | |
| 333 <h2>prepareUninstall</h2> | |
| 334 <b>prepareUninstall</b>(<i></i>) | |
| 335 <p> | |
| 336 Function to prepare for an un-installation. | |
| 337 </p> | |
| 338 | |
| 339 <div align="right"><a href="#top">Up</a></div> | |
| 26 <hr /> | 340 <hr /> |
| 27 </body></html> | 341 </body></html> |
