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

<!DOCTYPE html>
<html><head>
<title>eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.IbmWatsonEngine</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.IbmWatsonEngine</h1>
<p>
Module implementing the IBM Watson translation engine.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#IbmWatsonEngine">IbmWatsonEngine</a></td>
<td>Class implementing the translation engine for the IBM Watson Language Translator service.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="IbmWatsonEngine" ID="IbmWatsonEngine"></a>
<h2>IbmWatsonEngine</h2>
<p>
    Class implementing the translation engine for the IBM Watson Language
    Translator service.
</p>
<h3>Derived from</h3>
TranslationEngine
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#IbmWatsonEngine.__init__">IbmWatsonEngine</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#IbmWatsonEngine.__adjustLanguageCode">__adjustLanguageCode</a></td>
<td>Private method to adjust a given language code.</td>
</tr><tr>
<td><a href="#IbmWatsonEngine.__getTranslationModels">__getTranslationModels</a></td>
<td>Private method to get the translation models supported by IBM Watson Language Translator.</td>
</tr><tr>
<td><a href="#IbmWatsonEngine.engineName">engineName</a></td>
<td>Public method to return the name of the engine.</td>
</tr><tr>
<td><a href="#IbmWatsonEngine.getTranslation">getTranslation</a></td>
<td>Public method to translate the given text.</td>
</tr><tr>
<td><a href="#IbmWatsonEngine.hasTTS">hasTTS</a></td>
<td>Public method indicating the Text-to-Speech capability.</td>
</tr><tr>
<td><a href="#IbmWatsonEngine.supportedLanguages">supportedLanguages</a></td>
<td>Public method to get the supported languages.</td>
</tr><tr>
<td><a href="#IbmWatsonEngine.supportedTargetLanguages">supportedTargetLanguages</a></td>
<td>Public method to get a list of supported target languages for an original language.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="IbmWatsonEngine.__init__" ID="IbmWatsonEngine.__init__"></a>
<h4>IbmWatsonEngine (Constructor)</h4>
<b>IbmWatsonEngine</b>(<i>plugin, parent=None</i>)
<p>
        Constructor
</p><dl>
<dt><i>plugin</i> (TranslatorPlugin)</dt>
<dd>
reference to the plugin object
</dd><dt><i>parent</i> (QObject)</dt>
<dd>
reference to the parent object
</dd>
</dl><a NAME="IbmWatsonEngine.__adjustLanguageCode" ID="IbmWatsonEngine.__adjustLanguageCode"></a>
<h4>IbmWatsonEngine.__adjustLanguageCode</h4>
<b>__adjustLanguageCode</b>(<i>code</i>)
<p>
        Private method to adjust a given language code.
</p><dl>
<dt><i>code</i> (str)</dt>
<dd>
code to be adjusted
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
adjusted language code
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl><a NAME="IbmWatsonEngine.__getTranslationModels" ID="IbmWatsonEngine.__getTranslationModels"></a>
<h4>IbmWatsonEngine.__getTranslationModels</h4>
<b>__getTranslationModels</b>(<i></i>)
<p>
        Private method to get the translation models supported by IBM Watson
        Language Translator.
</p><a NAME="IbmWatsonEngine.engineName" ID="IbmWatsonEngine.engineName"></a>
<h4>IbmWatsonEngine.engineName</h4>
<b>engineName</b>(<i></i>)
<p>
        Public method to return the name of the engine.
</p><dl>
<dt>Returns:</dt>
<dd>
engine name
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl><a NAME="IbmWatsonEngine.getTranslation" ID="IbmWatsonEngine.getTranslation"></a>
<h4>IbmWatsonEngine.getTranslation</h4>
<b>getTranslation</b>(<i>requestObject, text, originalLanguage, translationLanguage</i>)
<p>
        Public method to translate the given text.
</p><dl>
<dt><i>requestObject</i> (TranslatorRequest)</dt>
<dd>
reference to the request object
</dd><dt><i>text</i> (str)</dt>
<dd>
text to be translated
</dd><dt><i>originalLanguage</i> (str)</dt>
<dd>
language code of the original
</dd><dt><i>translationLanguage</i> (str)</dt>
<dd>
language code of the translation
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
tuple of translated text and flag indicating success
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, bool)
</dd>
</dl><a NAME="IbmWatsonEngine.hasTTS" ID="IbmWatsonEngine.hasTTS"></a>
<h4>IbmWatsonEngine.hasTTS</h4>
<b>hasTTS</b>(<i></i>)
<p>
        Public method indicating the Text-to-Speech capability.
</p><dl>
<dt>Returns:</dt>
<dd>
flag indicating the Text-to-Speech capability
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl><a NAME="IbmWatsonEngine.supportedLanguages" ID="IbmWatsonEngine.supportedLanguages"></a>
<h4>IbmWatsonEngine.supportedLanguages</h4>
<b>supportedLanguages</b>(<i></i>)
<p>
        Public method to get the supported languages.
</p><dl>
<dt>Returns:</dt>
<dd>
list of supported language codes
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
list of str
</dd>
</dl><a NAME="IbmWatsonEngine.supportedTargetLanguages" ID="IbmWatsonEngine.supportedTargetLanguages"></a>
<h4>IbmWatsonEngine.supportedTargetLanguages</h4>
<b>supportedTargetLanguages</b>(<i>original</i>)
<p>
        Public method to get a list of supported target languages for an
        original language.
</p><dl>
<dt><i>original</i> (str)</dt>
<dd>
original language
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
list of supported target languages for the given original
</dd>
</dl><dl>
<dt>Return Type:</dt>
<dd>
list of str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>