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 6942
2602857055c5
parent 6412
d71b094845e7
child 7273
391d6b7b1eff
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.IbmWatsonEngine</h1>
23 <p>
24 Module implementing the IBM Watson translation engine.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#IbmWatsonEngine">IbmWatsonEngine</a></td>
34 <td>Class implementing the translation engine for the IBM Watson Language Translator service.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="IbmWatsonEngine" ID="IbmWatsonEngine"></a>
43 <h2>IbmWatsonEngine</h2>
44 <p>
45 Class implementing the translation engine for the IBM Watson Language
46 Translator service.
47 </p>
48 <h3>Derived from</h3>
49 TranslationEngine
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Class Methods</h3>
55 <table>
56 <tr><td>None</td></tr>
57 </table>
58 <h3>Methods</h3>
59 <table>
60 <tr>
61 <td><a href="#IbmWatsonEngine.__init__">IbmWatsonEngine</a></td>
62 <td>Constructor</td>
63 </tr><tr>
64 <td><a href="#IbmWatsonEngine.__adjustLanguageCode">__adjustLanguageCode</a></td>
65 <td>Private method to adjust a given language code.</td>
66 </tr><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><tr>
70 <td><a href="#IbmWatsonEngine.__getTranslationModelsReplyFinished">__getTranslationModelsReplyFinished</a></td>
71 <td>Private slot handling the receipt of the available translations.</td>
72 </tr><tr>
73 <td><a href="#IbmWatsonEngine.engineName">engineName</a></td>
74 <td>Public method to return the name of the engine.</td>
75 </tr><tr>
76 <td><a href="#IbmWatsonEngine.getTranslation">getTranslation</a></td>
77 <td>Public method to translate the given text.</td>
78 </tr><tr>
79 <td><a href="#IbmWatsonEngine.hasTTS">hasTTS</a></td>
80 <td>Public method indicating the Text-to-Speech capability.</td>
81 </tr><tr>
82 <td><a href="#IbmWatsonEngine.supportedLanguages">supportedLanguages</a></td>
83 <td>Public method to get the supported languages.</td>
84 </tr><tr>
85 <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>
87 </tr>
88 </table>
89 <h3>Static Methods</h3>
90 <table>
91 <tr><td>None</td></tr>
92 </table>
93 <a NAME="IbmWatsonEngine.__init__" ID="IbmWatsonEngine.__init__"></a>
94 <h4>IbmWatsonEngine (Constructor)</h4>
95 <b>IbmWatsonEngine</b>(<i>plugin, parent=None</i>)
96 <p>
97 Constructor
98 </p><dl>
99 <dt><i>plugin</i> (TranslatorPlugin)</dt>
100 <dd>
101 reference to the plugin object
102 </dd><dt><i>parent</i> (QObject)</dt>
103 <dd>
104 reference to the parent object
105 </dd>
106 </dl><a NAME="IbmWatsonEngine.__adjustLanguageCode" ID="IbmWatsonEngine.__adjustLanguageCode"></a>
107 <h4>IbmWatsonEngine.__adjustLanguageCode</h4>
108 <b>__adjustLanguageCode</b>(<i>code</i>)
109 <p>
110 Private method to adjust a given language code.
111 </p><dl>
112 <dt><i>code</i> (str)</dt>
113 <dd>
114 code to be adjusted
115 </dd>
116 </dl><dl>
117 <dt>Returns:</dt>
118 <dd>
119 adjusted language code
120 </dd>
121 </dl><dl>
122 <dt>Return Type:</dt>
123 <dd>
124 str
125 </dd>
126 </dl><a NAME="IbmWatsonEngine.__getTranslationModels" ID="IbmWatsonEngine.__getTranslationModels"></a>
127 <h4>IbmWatsonEngine.__getTranslationModels</h4>
128 <b>__getTranslationModels</b>(<i></i>)
129 <p>
130 Private method to get the translation models supported by IBM Watson
131 Language Translator.
132 </p><a NAME="IbmWatsonEngine.__getTranslationModelsReplyFinished" ID="IbmWatsonEngine.__getTranslationModelsReplyFinished"></a>
133 <h4>IbmWatsonEngine.__getTranslationModelsReplyFinished</h4>
134 <b>__getTranslationModelsReplyFinished</b>(<i>reply</i>)
135 <p>
136 Private slot handling the receipt of the available translations.
137 </p><dl>
138 <dt><i>reply</i> (QNetworkReply)</dt>
139 <dd>
140 reference to the network reply object
141 </dd>
142 </dl><a NAME="IbmWatsonEngine.engineName" ID="IbmWatsonEngine.engineName"></a>
143 <h4>IbmWatsonEngine.engineName</h4>
144 <b>engineName</b>(<i></i>)
145 <p>
146 Public method to return the name of the engine.
147 </p><dl>
148 <dt>Returns:</dt>
149 <dd>
150 engine name
151 </dd>
152 </dl><dl>
153 <dt>Return Type:</dt>
154 <dd>
155 str
156 </dd>
157 </dl><a NAME="IbmWatsonEngine.getTranslation" ID="IbmWatsonEngine.getTranslation"></a>
158 <h4>IbmWatsonEngine.getTranslation</h4>
159 <b>getTranslation</b>(<i>requestObject, text, originalLanguage, translationLanguage</i>)
160 <p>
161 Public method to translate the given text.
162 </p><dl>
163 <dt><i>requestObject</i> (TranslatorRequest)</dt>
164 <dd>
165 reference to the request object
166 </dd><dt><i>text</i> (str)</dt>
167 <dd>
168 text to be translated
169 </dd><dt><i>originalLanguage</i> (str)</dt>
170 <dd>
171 language code of the original
172 </dd><dt><i>translationLanguage</i> (str)</dt>
173 <dd>
174 language code of the translation
175 </dd>
176 </dl><dl>
177 <dt>Returns:</dt>
178 <dd>
179 tuple of translated text and flag indicating success
180 </dd>
181 </dl><dl>
182 <dt>Return Type:</dt>
183 <dd>
184 tuple of (str, bool)
185 </dd>
186 </dl><a NAME="IbmWatsonEngine.hasTTS" ID="IbmWatsonEngine.hasTTS"></a>
187 <h4>IbmWatsonEngine.hasTTS</h4>
188 <b>hasTTS</b>(<i></i>)
189 <p>
190 Public method indicating the Text-to-Speech capability.
191 </p><dl>
192 <dt>Returns:</dt>
193 <dd>
194 flag indicating the Text-to-Speech capability
195 </dd>
196 </dl><dl>
197 <dt>Return Type:</dt>
198 <dd>
199 bool
200 </dd>
201 </dl><a NAME="IbmWatsonEngine.supportedLanguages" ID="IbmWatsonEngine.supportedLanguages"></a>
202 <h4>IbmWatsonEngine.supportedLanguages</h4>
203 <b>supportedLanguages</b>(<i></i>)
204 <p>
205 Public method to get the supported languages.
206 </p><dl>
207 <dt>Returns:</dt>
208 <dd>
209 list of supported language codes
210 </dd>
211 </dl><dl>
212 <dt>Return Type:</dt>
213 <dd>
214 list of str
215 </dd>
216 </dl><a NAME="IbmWatsonEngine.supportedTargetLanguages" ID="IbmWatsonEngine.supportedTargetLanguages"></a>
217 <h4>IbmWatsonEngine.supportedTargetLanguages</h4>
218 <b>supportedTargetLanguages</b>(<i>original</i>)
219 <p>
220 Public method to get a list of supported target languages for an
221 original language.
222 </p><dl>
223 <dt><i>original</i> (str)</dt>
224 <dd>
225 original language
226 </dd>
227 </dl><dl>
228 <dt>Returns:</dt>
229 <dd>
230 list of supported target languages for the given original
231 </dd>
232 </dl><dl>
233 <dt>Return Type:</dt>
234 <dd>
235 list of str
236 </dd>
237 </dl>
238 <div align="right"><a href="#top">Up</a></div>
239 <hr />
240 </body></html>

Mercurial Repository: eric

eric ide

mercurial