Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial