Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.IbmWatsonEngine.html
src/eric7/Documentation/Source/eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.IbmWatsonEngine.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 9503
- ae9232bf4854
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.IbmWatsonEngine</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.IbmWatsonEngine</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the IBM Watson translation engine. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#IbmWatsonEngine">IbmWatsonEngine</a></td> | |
| 25 <td>Class implementing the translation engine for the IBM Watson Language Translator service.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="IbmWatsonEngine" ID="IbmWatsonEngine"></a> | |
| 36 <h2>IbmWatsonEngine</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the translation engine for the IBM Watson Language | |
| 40 Translator service. | |
| 41 </p> | |
| 42 <h3>Derived from</h3> | |
| 43 TranslationEngine | |
| 44 <h3>Class Attributes</h3> | |
| 45 | |
| 46 <table> | |
| 47 <tr><td>None</td></tr> | |
| 48 </table> | |
| 49 <h3>Class Methods</h3> | |
| 50 | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 | |
| 56 <table> | |
| 57 | |
| 58 <tr> | |
| 59 <td><a href="#IbmWatsonEngine.__init__">IbmWatsonEngine</a></td> | |
| 60 <td>Constructor</td> | |
| 61 </tr> | |
| 62 <tr> | |
| 63 <td><a href="#IbmWatsonEngine.__adjustLanguageCode">__adjustLanguageCode</a></td> | |
| 64 <td>Private method to adjust a given language code.</td> | |
| 65 </tr> | |
| 66 <tr> | |
| 67 <td><a href="#IbmWatsonEngine.__getTranslationModels">__getTranslationModels</a></td> | |
| 68 <td>Private method to get the translation models supported by IBM Watson Language Translator.</td> | |
| 69 </tr> | |
| 70 <tr> | |
| 71 <td><a href="#IbmWatsonEngine.__getTranslationModelsReplyFinished">__getTranslationModelsReplyFinished</a></td> | |
| 72 <td>Private slot handling the receipt of the available translations.</td> | |
| 73 </tr> | |
| 74 <tr> | |
| 75 <td><a href="#IbmWatsonEngine.engineName">engineName</a></td> | |
| 76 <td>Public method to return the name of the engine.</td> | |
| 77 </tr> | |
| 78 <tr> | |
| 79 <td><a href="#IbmWatsonEngine.getTranslation">getTranslation</a></td> | |
| 80 <td>Public method to translate the given text.</td> | |
| 81 </tr> | |
| 82 <tr> | |
| 83 <td><a href="#IbmWatsonEngine.hasTTS">hasTTS</a></td> | |
| 84 <td>Public method indicating the Text-to-Speech capability.</td> | |
| 85 </tr> | |
| 86 <tr> | |
| 87 <td><a href="#IbmWatsonEngine.supportedLanguages">supportedLanguages</a></td> | |
| 88 <td>Public method to get the supported languages.</td> | |
| 89 </tr> | |
| 90 <tr> | |
| 91 <td><a href="#IbmWatsonEngine.supportedTargetLanguages">supportedTargetLanguages</a></td> | |
| 92 <td>Public method to get a list of supported target languages for an original language.</td> | |
| 93 </tr> | |
| 94 </table> | |
| 95 <h3>Static Methods</h3> | |
| 96 | |
| 97 <table> | |
| 98 <tr><td>None</td></tr> | |
| 99 </table> | |
| 100 | |
| 101 <a NAME="IbmWatsonEngine.__init__" ID="IbmWatsonEngine.__init__"></a> | |
| 102 <h4>IbmWatsonEngine (Constructor)</h4> | |
| 103 <b>IbmWatsonEngine</b>(<i>plugin, parent=None</i>) | |
| 104 | |
| 105 <p> | |
| 106 Constructor | |
| 107 </p> | |
| 108 <dl> | |
| 109 | |
| 110 <dt><i>plugin</i> (TranslatorPlugin)</dt> | |
| 111 <dd> | |
| 112 reference to the plugin object | |
| 113 </dd> | |
| 114 <dt><i>parent</i> (QObject)</dt> | |
| 115 <dd> | |
| 116 reference to the parent object | |
| 117 </dd> | |
| 118 </dl> | |
| 119 <a NAME="IbmWatsonEngine.__adjustLanguageCode" ID="IbmWatsonEngine.__adjustLanguageCode"></a> | |
| 120 <h4>IbmWatsonEngine.__adjustLanguageCode</h4> | |
| 121 <b>__adjustLanguageCode</b>(<i>code</i>) | |
| 122 | |
| 123 <p> | |
| 124 Private method to adjust a given language code. | |
| 125 </p> | |
| 126 <dl> | |
| 127 | |
| 128 <dt><i>code</i> (str)</dt> | |
| 129 <dd> | |
| 130 code to be adjusted | |
| 131 </dd> | |
| 132 </dl> | |
| 133 <dl> | |
| 134 <dt>Return:</dt> | |
| 135 <dd> | |
| 136 adjusted language code | |
| 137 </dd> | |
| 138 </dl> | |
| 139 <dl> | |
| 140 <dt>Return Type:</dt> | |
| 141 <dd> | |
| 142 str | |
| 143 </dd> | |
| 144 </dl> | |
| 145 <a NAME="IbmWatsonEngine.__getTranslationModels" ID="IbmWatsonEngine.__getTranslationModels"></a> | |
| 146 <h4>IbmWatsonEngine.__getTranslationModels</h4> | |
| 147 <b>__getTranslationModels</b>(<i></i>) | |
| 148 | |
| 149 <p> | |
| 150 Private method to get the translation models supported by IBM Watson | |
| 151 Language Translator. | |
| 152 </p> | |
| 153 <a NAME="IbmWatsonEngine.__getTranslationModelsReplyFinished" ID="IbmWatsonEngine.__getTranslationModelsReplyFinished"></a> | |
| 154 <h4>IbmWatsonEngine.__getTranslationModelsReplyFinished</h4> | |
| 155 <b>__getTranslationModelsReplyFinished</b>(<i>reply</i>) | |
| 156 | |
| 157 <p> | |
| 158 Private slot handling the receipt of the available translations. | |
| 159 </p> | |
| 160 <dl> | |
| 161 | |
| 162 <dt><i>reply</i> (QNetworkReply)</dt> | |
| 163 <dd> | |
| 164 reference to the network reply object | |
| 165 </dd> | |
| 166 </dl> | |
| 167 <a NAME="IbmWatsonEngine.engineName" ID="IbmWatsonEngine.engineName"></a> | |
| 168 <h4>IbmWatsonEngine.engineName</h4> | |
| 169 <b>engineName</b>(<i></i>) | |
| 170 | |
| 171 <p> | |
| 172 Public method to return the name of the engine. | |
| 173 </p> | |
| 174 <dl> | |
| 175 <dt>Return:</dt> | |
| 176 <dd> | |
| 177 engine name | |
| 178 </dd> | |
| 179 </dl> | |
| 180 <dl> | |
| 181 <dt>Return Type:</dt> | |
| 182 <dd> | |
| 183 str | |
| 184 </dd> | |
| 185 </dl> | |
| 186 <a NAME="IbmWatsonEngine.getTranslation" ID="IbmWatsonEngine.getTranslation"></a> | |
| 187 <h4>IbmWatsonEngine.getTranslation</h4> | |
| 188 <b>getTranslation</b>(<i>requestObject, text, originalLanguage, translationLanguage</i>) | |
| 189 | |
| 190 <p> | |
| 191 Public method to translate the given text. | |
| 192 </p> | |
| 193 <dl> | |
| 194 | |
| 195 <dt><i>requestObject</i> (TranslatorRequest)</dt> | |
| 196 <dd> | |
| 197 reference to the request object | |
| 198 </dd> | |
| 199 <dt><i>text</i> (str)</dt> | |
| 200 <dd> | |
| 201 text to be translated | |
| 202 </dd> | |
| 203 <dt><i>originalLanguage</i> (str)</dt> | |
| 204 <dd> | |
| 205 language code of the original | |
| 206 </dd> | |
| 207 <dt><i>translationLanguage</i> (str)</dt> | |
| 208 <dd> | |
| 209 language code of the translation | |
| 210 </dd> | |
| 211 </dl> | |
| 212 <dl> | |
| 213 <dt>Return:</dt> | |
| 214 <dd> | |
| 215 tuple of translated text and flag indicating success | |
| 216 </dd> | |
| 217 </dl> | |
| 218 <dl> | |
| 219 <dt>Return Type:</dt> | |
| 220 <dd> | |
| 221 tuple of (str, bool) | |
| 222 </dd> | |
| 223 </dl> | |
| 224 <a NAME="IbmWatsonEngine.hasTTS" ID="IbmWatsonEngine.hasTTS"></a> | |
| 225 <h4>IbmWatsonEngine.hasTTS</h4> | |
| 226 <b>hasTTS</b>(<i></i>) | |
| 227 | |
| 228 <p> | |
| 229 Public method indicating the Text-to-Speech capability. | |
| 230 </p> | |
| 231 <dl> | |
| 232 <dt>Return:</dt> | |
| 233 <dd> | |
| 234 flag indicating the Text-to-Speech capability | |
| 235 </dd> | |
| 236 </dl> | |
| 237 <dl> | |
| 238 <dt>Return Type:</dt> | |
| 239 <dd> | |
| 240 bool | |
| 241 </dd> | |
| 242 </dl> | |
| 243 <a NAME="IbmWatsonEngine.supportedLanguages" ID="IbmWatsonEngine.supportedLanguages"></a> | |
| 244 <h4>IbmWatsonEngine.supportedLanguages</h4> | |
| 245 <b>supportedLanguages</b>(<i></i>) | |
| 246 | |
| 247 <p> | |
| 248 Public method to get the supported languages. | |
| 249 </p> | |
| 250 <dl> | |
| 251 <dt>Return:</dt> | |
| 252 <dd> | |
| 253 list of supported language codes | |
| 254 </dd> | |
| 255 </dl> | |
| 256 <dl> | |
| 257 <dt>Return Type:</dt> | |
| 258 <dd> | |
| 259 list of str | |
| 260 </dd> | |
| 261 </dl> | |
| 262 <a NAME="IbmWatsonEngine.supportedTargetLanguages" ID="IbmWatsonEngine.supportedTargetLanguages"></a> | |
| 263 <h4>IbmWatsonEngine.supportedTargetLanguages</h4> | |
| 264 <b>supportedTargetLanguages</b>(<i>original</i>) | |
| 265 | |
| 266 <p> | |
| 267 Public method to get a list of supported target languages for an | |
| 268 original language. | |
| 269 </p> | |
| 270 <dl> | |
| 271 | |
| 272 <dt><i>original</i> (str)</dt> | |
| 273 <dd> | |
| 274 original language | |
| 275 </dd> | |
| 276 </dl> | |
| 277 <dl> | |
| 278 <dt>Return:</dt> | |
| 279 <dd> | |
| 280 list of supported target languages for the given original | |
| 281 </dd> | |
| 282 </dl> | |
| 283 <dl> | |
| 284 <dt>Return Type:</dt> | |
| 285 <dd> | |
| 286 list of str | |
| 287 </dd> | |
| 288 </dl> | |
| 289 <div align="right"><a href="#top">Up</a></div> | |
| 290 <hr /> | |
| 291 </body></html> |
