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 10479
856476537696
parent 9503
ae9232bf4854
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
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>eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.IbmWatsonEngine</h1> 9 <h1>eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.IbmWatsonEngine</h1>
10
11 <p> 10 <p>
12 Module implementing the IBM Watson translation engine. 11 Module implementing the IBM Watson translation engine.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#IbmWatsonEngine">IbmWatsonEngine</a></td> 22 <td><a href="#IbmWatsonEngine">IbmWatsonEngine</a></td>
25 <td>Class implementing the translation engine for the IBM Watson Language Translator service.</td> 23 <td>Class implementing the translation engine for the IBM Watson Language Translator service.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table>
31
32 <tr> 29 <tr>
33 <td><a href="#createEngine">createEngine</a></td> 30 <td><a href="#createEngine">createEngine</a></td>
34 <td>Function to instantiate a translator engine object.</td> 31 <td>Function to instantiate a translator engine object.</td>
35 </tr> 32 </tr>
36 </table> 33 </table>
34
37 <hr /> 35 <hr />
38 <hr /> 36 <hr />
39 <a NAME="IbmWatsonEngine" ID="IbmWatsonEngine"></a> 37 <a NAME="IbmWatsonEngine" ID="IbmWatsonEngine"></a>
40 <h2>IbmWatsonEngine</h2> 38 <h2>IbmWatsonEngine</h2>
41
42 <p> 39 <p>
43 Class implementing the translation engine for the IBM Watson Language 40 Class implementing the translation engine for the IBM Watson Language
44 Translator service. 41 Translator service.
45 </p> 42 </p>
43
46 <h3>Derived from</h3> 44 <h3>Derived from</h3>
47 TranslationEngine 45 TranslationEngine
48 <h3>Class Attributes</h3> 46 <h3>Class Attributes</h3>
49
50 <table> 47 <table>
51 <tr><td>None</td></tr> 48 <tr><td>None</td></tr>
52 </table> 49 </table>
50
53 <h3>Class Methods</h3> 51 <h3>Class Methods</h3>
54
55 <table> 52 <table>
56 <tr><td>None</td></tr> 53 <tr><td>None</td></tr>
57 </table> 54 </table>
55
58 <h3>Methods</h3> 56 <h3>Methods</h3>
59 57 <table>
60 <table>
61
62 <tr> 58 <tr>
63 <td><a href="#IbmWatsonEngine.__init__">IbmWatsonEngine</a></td> 59 <td><a href="#IbmWatsonEngine.__init__">IbmWatsonEngine</a></td>
64 <td>Constructor</td> 60 <td>Constructor</td>
65 </tr> 61 </tr>
66 <tr> 62 <tr>
94 <tr> 90 <tr>
95 <td><a href="#IbmWatsonEngine.supportedTargetLanguages">supportedTargetLanguages</a></td> 91 <td><a href="#IbmWatsonEngine.supportedTargetLanguages">supportedTargetLanguages</a></td>
96 <td>Public method to get a list of supported target languages for an original language.</td> 92 <td>Public method to get a list of supported target languages for an original language.</td>
97 </tr> 93 </tr>
98 </table> 94 </table>
95
99 <h3>Static Methods</h3> 96 <h3>Static Methods</h3>
100
101 <table> 97 <table>
102 <tr><td>None</td></tr> 98 <tr><td>None</td></tr>
103 </table> 99 </table>
100
104 101
105 <a NAME="IbmWatsonEngine.__init__" ID="IbmWatsonEngine.__init__"></a> 102 <a NAME="IbmWatsonEngine.__init__" ID="IbmWatsonEngine.__init__"></a>
106 <h4>IbmWatsonEngine (Constructor)</h4> 103 <h4>IbmWatsonEngine (Constructor)</h4>
107 <b>IbmWatsonEngine</b>(<i>plugin, parent=None</i>) 104 <b>IbmWatsonEngine</b>(<i>plugin, parent=None</i>)
108
109 <p> 105 <p>
110 Constructor 106 Constructor
111 </p> 107 </p>
108
112 <dl> 109 <dl>
113 110
114 <dt><i>plugin</i> (TranslatorPlugin)</dt> 111 <dt><i>plugin</i> (TranslatorPlugin)</dt>
115 <dd> 112 <dd>
116 reference to the plugin object 113 reference to the plugin object
121 </dd> 118 </dd>
122 </dl> 119 </dl>
123 <a NAME="IbmWatsonEngine.__adjustLanguageCode" ID="IbmWatsonEngine.__adjustLanguageCode"></a> 120 <a NAME="IbmWatsonEngine.__adjustLanguageCode" ID="IbmWatsonEngine.__adjustLanguageCode"></a>
124 <h4>IbmWatsonEngine.__adjustLanguageCode</h4> 121 <h4>IbmWatsonEngine.__adjustLanguageCode</h4>
125 <b>__adjustLanguageCode</b>(<i>code</i>) 122 <b>__adjustLanguageCode</b>(<i>code</i>)
126
127 <p> 123 <p>
128 Private method to adjust a given language code. 124 Private method to adjust a given language code.
129 </p> 125 </p>
126
130 <dl> 127 <dl>
131 128
132 <dt><i>code</i> (str)</dt> 129 <dt><i>code</i> (str)</dt>
133 <dd> 130 <dd>
134 code to be adjusted 131 code to be adjusted
147 </dd> 144 </dd>
148 </dl> 145 </dl>
149 <a NAME="IbmWatsonEngine.__getTranslationModels" ID="IbmWatsonEngine.__getTranslationModels"></a> 146 <a NAME="IbmWatsonEngine.__getTranslationModels" ID="IbmWatsonEngine.__getTranslationModels"></a>
150 <h4>IbmWatsonEngine.__getTranslationModels</h4> 147 <h4>IbmWatsonEngine.__getTranslationModels</h4>
151 <b>__getTranslationModels</b>(<i></i>) 148 <b>__getTranslationModels</b>(<i></i>)
152
153 <p> 149 <p>
154 Private method to get the translation models supported by IBM Watson 150 Private method to get the translation models supported by IBM Watson
155 Language Translator. 151 Language Translator.
156 </p> 152 </p>
153
157 <a NAME="IbmWatsonEngine.__getTranslationModelsReplyFinished" ID="IbmWatsonEngine.__getTranslationModelsReplyFinished"></a> 154 <a NAME="IbmWatsonEngine.__getTranslationModelsReplyFinished" ID="IbmWatsonEngine.__getTranslationModelsReplyFinished"></a>
158 <h4>IbmWatsonEngine.__getTranslationModelsReplyFinished</h4> 155 <h4>IbmWatsonEngine.__getTranslationModelsReplyFinished</h4>
159 <b>__getTranslationModelsReplyFinished</b>(<i>reply</i>) 156 <b>__getTranslationModelsReplyFinished</b>(<i>reply</i>)
160
161 <p> 157 <p>
162 Private slot handling the receipt of the available translations. 158 Private slot handling the receipt of the available translations.
163 </p> 159 </p>
160
164 <dl> 161 <dl>
165 162
166 <dt><i>reply</i> (QNetworkReply)</dt> 163 <dt><i>reply</i> (QNetworkReply)</dt>
167 <dd> 164 <dd>
168 reference to the network reply object 165 reference to the network reply object
169 </dd> 166 </dd>
170 </dl> 167 </dl>
171 <a NAME="IbmWatsonEngine.engineName" ID="IbmWatsonEngine.engineName"></a> 168 <a NAME="IbmWatsonEngine.engineName" ID="IbmWatsonEngine.engineName"></a>
172 <h4>IbmWatsonEngine.engineName</h4> 169 <h4>IbmWatsonEngine.engineName</h4>
173 <b>engineName</b>(<i></i>) 170 <b>engineName</b>(<i></i>)
174
175 <p> 171 <p>
176 Public method to return the name of the engine. 172 Public method to return the name of the engine.
177 </p> 173 </p>
174
178 <dl> 175 <dl>
179 <dt>Return:</dt> 176 <dt>Return:</dt>
180 <dd> 177 <dd>
181 engine name 178 engine name
182 </dd> 179 </dd>
188 </dd> 185 </dd>
189 </dl> 186 </dl>
190 <a NAME="IbmWatsonEngine.getTranslation" ID="IbmWatsonEngine.getTranslation"></a> 187 <a NAME="IbmWatsonEngine.getTranslation" ID="IbmWatsonEngine.getTranslation"></a>
191 <h4>IbmWatsonEngine.getTranslation</h4> 188 <h4>IbmWatsonEngine.getTranslation</h4>
192 <b>getTranslation</b>(<i>requestObject, text, originalLanguage, translationLanguage</i>) 189 <b>getTranslation</b>(<i>requestObject, text, originalLanguage, translationLanguage</i>)
193
194 <p> 190 <p>
195 Public method to translate the given text. 191 Public method to translate the given text.
196 </p> 192 </p>
193
197 <dl> 194 <dl>
198 195
199 <dt><i>requestObject</i> (TranslatorRequest)</dt> 196 <dt><i>requestObject</i> (TranslatorRequest)</dt>
200 <dd> 197 <dd>
201 reference to the request object 198 reference to the request object
226 </dd> 223 </dd>
227 </dl> 224 </dl>
228 <a NAME="IbmWatsonEngine.hasTTS" ID="IbmWatsonEngine.hasTTS"></a> 225 <a NAME="IbmWatsonEngine.hasTTS" ID="IbmWatsonEngine.hasTTS"></a>
229 <h4>IbmWatsonEngine.hasTTS</h4> 226 <h4>IbmWatsonEngine.hasTTS</h4>
230 <b>hasTTS</b>(<i></i>) 227 <b>hasTTS</b>(<i></i>)
231
232 <p> 228 <p>
233 Public method indicating the Text-to-Speech capability. 229 Public method indicating the Text-to-Speech capability.
234 </p> 230 </p>
231
235 <dl> 232 <dl>
236 <dt>Return:</dt> 233 <dt>Return:</dt>
237 <dd> 234 <dd>
238 flag indicating the Text-to-Speech capability 235 flag indicating the Text-to-Speech capability
239 </dd> 236 </dd>
245 </dd> 242 </dd>
246 </dl> 243 </dl>
247 <a NAME="IbmWatsonEngine.supportedLanguages" ID="IbmWatsonEngine.supportedLanguages"></a> 244 <a NAME="IbmWatsonEngine.supportedLanguages" ID="IbmWatsonEngine.supportedLanguages"></a>
248 <h4>IbmWatsonEngine.supportedLanguages</h4> 245 <h4>IbmWatsonEngine.supportedLanguages</h4>
249 <b>supportedLanguages</b>(<i></i>) 246 <b>supportedLanguages</b>(<i></i>)
250
251 <p> 247 <p>
252 Public method to get the supported languages. 248 Public method to get the supported languages.
253 </p> 249 </p>
250
254 <dl> 251 <dl>
255 <dt>Return:</dt> 252 <dt>Return:</dt>
256 <dd> 253 <dd>
257 list of supported language codes 254 list of supported language codes
258 </dd> 255 </dd>
264 </dd> 261 </dd>
265 </dl> 262 </dl>
266 <a NAME="IbmWatsonEngine.supportedTargetLanguages" ID="IbmWatsonEngine.supportedTargetLanguages"></a> 263 <a NAME="IbmWatsonEngine.supportedTargetLanguages" ID="IbmWatsonEngine.supportedTargetLanguages"></a>
267 <h4>IbmWatsonEngine.supportedTargetLanguages</h4> 264 <h4>IbmWatsonEngine.supportedTargetLanguages</h4>
268 <b>supportedTargetLanguages</b>(<i>original</i>) 265 <b>supportedTargetLanguages</b>(<i>original</i>)
269
270 <p> 266 <p>
271 Public method to get a list of supported target languages for an 267 Public method to get a list of supported target languages for an
272 original language. 268 original language.
273 </p> 269 </p>
270
274 <dl> 271 <dl>
275 272
276 <dt><i>original</i> (str)</dt> 273 <dt><i>original</i> (str)</dt>
277 <dd> 274 <dd>
278 original language 275 original language
294 <hr /> 291 <hr />
295 <hr /> 292 <hr />
296 <a NAME="createEngine" ID="createEngine"></a> 293 <a NAME="createEngine" ID="createEngine"></a>
297 <h2>createEngine</h2> 294 <h2>createEngine</h2>
298 <b>createEngine</b>(<i>plugin, parent=None</i>) 295 <b>createEngine</b>(<i>plugin, parent=None</i>)
299
300 <p> 296 <p>
301 Function to instantiate a translator engine object. 297 Function to instantiate a translator engine object.
302 </p> 298 </p>
299
303 <dl> 300 <dl>
304 301
305 <dt><i>plugin</i> (TranslatorPlugin)</dt> 302 <dt><i>plugin</i> (TranslatorPlugin)</dt>
306 <dd> 303 <dd>
307 reference to the plugin object 304 reference to the plugin object

Mercurial Repository: eric

eric ide

mercurial