Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.IbmWatsonEngine.html

eric7/Documentation/Source/eric7.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.IbmWatsonEngine.html

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

Mercurial Repository: eric

eric ide

mercurial