Mercurial Repositories > eric / file comparison

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

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

changeset 6411
7fd9b7ecbcfe
child 6412
d71b094845e7
equal deleted inserted replaced
6410:98a5d0cd72f5 6411:7fd9b7ecbcfe
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.engineName">engineName</a></td>
71 <td>Public method to return the name of the engine.</td>
72 </tr><tr>
73 <td><a href="#IbmWatsonEngine.getTranslation">getTranslation</a></td>
74 <td>Public method to translate the given text.</td>
75 </tr><tr>
76 <td><a href="#IbmWatsonEngine.hasTTS">hasTTS</a></td>
77 <td>Public method indicating the Text-to-Speech capability.</td>
78 </tr><tr>
79 <td><a href="#IbmWatsonEngine.supportedLanguages">supportedLanguages</a></td>
80 <td>Public method to get the supported languages.</td>
81 </tr><tr>
82 <td><a href="#IbmWatsonEngine.supportedTargetLanguages">supportedTargetLanguages</a></td>
83 <td>Public method to get a list of supported target languages for an original language.</td>
84 </tr>
85 </table>
86 <h3>Static Methods</h3>
87 <table>
88 <tr><td>None</td></tr>
89 </table>
90 <a NAME="IbmWatsonEngine.__init__" ID="IbmWatsonEngine.__init__"></a>
91 <h4>IbmWatsonEngine (Constructor)</h4>
92 <b>IbmWatsonEngine</b>(<i>plugin, parent=None</i>)
93 <p>
94 Constructor
95 </p><dl>
96 <dt><i>plugin</i> (TranslatorPlugin)</dt>
97 <dd>
98 reference to the plugin object
99 </dd><dt><i>parent</i> (QObject)</dt>
100 <dd>
101 reference to the parent object
102 </dd>
103 </dl><a NAME="IbmWatsonEngine.__adjustLanguageCode" ID="IbmWatsonEngine.__adjustLanguageCode"></a>
104 <h4>IbmWatsonEngine.__adjustLanguageCode</h4>
105 <b>__adjustLanguageCode</b>(<i>code</i>)
106 <p>
107 Private method to adjust a given language code.
108 </p><dl>
109 <dt><i>code</i> (str)</dt>
110 <dd>
111 code to be adjusted
112 </dd>
113 </dl><dl>
114 <dt>Returns:</dt>
115 <dd>
116 adjusted language code
117 </dd>
118 </dl><dl>
119 <dt>Return Type:</dt>
120 <dd>
121 str
122 </dd>
123 </dl><a NAME="IbmWatsonEngine.__getTranslationModels" ID="IbmWatsonEngine.__getTranslationModels"></a>
124 <h4>IbmWatsonEngine.__getTranslationModels</h4>
125 <b>__getTranslationModels</b>(<i></i>)
126 <p>
127 Private method to get the translation models supported by IBM Watson
128 Language Translator.
129 </p><a NAME="IbmWatsonEngine.engineName" ID="IbmWatsonEngine.engineName"></a>
130 <h4>IbmWatsonEngine.engineName</h4>
131 <b>engineName</b>(<i></i>)
132 <p>
133 Public method to return the name of the engine.
134 </p><dl>
135 <dt>Returns:</dt>
136 <dd>
137 engine name
138 </dd>
139 </dl><dl>
140 <dt>Return Type:</dt>
141 <dd>
142 str
143 </dd>
144 </dl><a NAME="IbmWatsonEngine.getTranslation" ID="IbmWatsonEngine.getTranslation"></a>
145 <h4>IbmWatsonEngine.getTranslation</h4>
146 <b>getTranslation</b>(<i>requestObject, text, originalLanguage, translationLanguage</i>)
147 <p>
148 Public method to translate the given text.
149 </p><dl>
150 <dt><i>requestObject</i> (TranslatorRequest)</dt>
151 <dd>
152 reference to the request object
153 </dd><dt><i>text</i> (str)</dt>
154 <dd>
155 text to be translated
156 </dd><dt><i>originalLanguage</i> (str)</dt>
157 <dd>
158 language code of the original
159 </dd><dt><i>translationLanguage</i> (str)</dt>
160 <dd>
161 language code of the translation
162 </dd>
163 </dl><dl>
164 <dt>Returns:</dt>
165 <dd>
166 tuple of translated text and flag indicating success
167 </dd>
168 </dl><dl>
169 <dt>Return Type:</dt>
170 <dd>
171 tuple of (str, bool)
172 </dd>
173 </dl><a NAME="IbmWatsonEngine.hasTTS" ID="IbmWatsonEngine.hasTTS"></a>
174 <h4>IbmWatsonEngine.hasTTS</h4>
175 <b>hasTTS</b>(<i></i>)
176 <p>
177 Public method indicating the Text-to-Speech capability.
178 </p><dl>
179 <dt>Returns:</dt>
180 <dd>
181 flag indicating the Text-to-Speech capability
182 </dd>
183 </dl><dl>
184 <dt>Return Type:</dt>
185 <dd>
186 bool
187 </dd>
188 </dl><a NAME="IbmWatsonEngine.supportedLanguages" ID="IbmWatsonEngine.supportedLanguages"></a>
189 <h4>IbmWatsonEngine.supportedLanguages</h4>
190 <b>supportedLanguages</b>(<i></i>)
191 <p>
192 Public method to get the supported languages.
193 </p><dl>
194 <dt>Returns:</dt>
195 <dd>
196 list of supported language codes
197 </dd>
198 </dl><dl>
199 <dt>Return Type:</dt>
200 <dd>
201 list of str
202 </dd>
203 </dl><a NAME="IbmWatsonEngine.supportedTargetLanguages" ID="IbmWatsonEngine.supportedTargetLanguages"></a>
204 <h4>IbmWatsonEngine.supportedTargetLanguages</h4>
205 <b>supportedTargetLanguages</b>(<i>original</i>)
206 <p>
207 Public method to get a list of supported target languages for an
208 original language.
209 </p><dl>
210 <dt><i>original</i> (str)</dt>
211 <dd>
212 original language
213 </dd>
214 </dl><dl>
215 <dt>Returns:</dt>
216 <dd>
217 list of supported target languages for the given original
218 </dd>
219 </dl><dl>
220 <dt>Return Type:</dt>
221 <dd>
222 list of str
223 </dd>
224 </dl>
225 <div align="right"><a href="#top">Up</a></div>
226 <hr />
227 </body></html>

Mercurial Repository: eric

eric ide

mercurial