# coding: utf-8
# (C) Copyright IBM Corp. 2019, 2020.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
IBM Watson™ Language Translator translates text from one language to another. The
service offers multiple IBM provided translation models that you can customize based on
your unique terminology and language. Use Language Translator to take news from across the
globe and present it in your language, communicate with your customers in their own
language, and more.
"""
import json
from ibm_cloud_sdk_core.authenticators.authenticator import Authenticator
from .common import get_sdk_headers
from datetime import datetime
from enum import Enum
from ibm_cloud_sdk_core import BaseService
from ibm_cloud_sdk_core import DetailedResponse
from ibm_cloud_sdk_core import datetime_to_string, string_to_datetime
from ibm_cloud_sdk_core.get_authenticator import get_authenticator_from_environment
from os.path import basename
from typing import BinaryIO
from typing import Dict
from typing import List
##############################################################################
# Service
##############################################################################
class LanguageTranslatorV3(BaseService):
"""The Language Translator V3 service."""
DEFAULT_SERVICE_URL = 'https://gateway.watsonplatform.net/language-translator/api'
DEFAULT_SERVICE_NAME = 'language_translator'
def __init__(
self,
version: str,
authenticator: Authenticator = None,
service_name: str = DEFAULT_SERVICE_NAME,
) -> None:
"""
Construct a new client for the Language Translator service.
:param str version: The API version date to use with the service, in
"YYYY-MM-DD" format. Whenever the API is changed in a backwards
incompatible way, a new minor version of the API is released.
The service uses the API version for the date you specify, or
the most recent version before that date. Note that you should
not programmatically specify the current date at runtime, in
case the API has been updated since your application's release.
Instead, specify a version date that is compatible with your
application, and don't change it until your application is
ready for a later version.
:param Authenticator authenticator: The authenticator specifies the authentication mechanism.
Get up to date information from https://github.com/IBM/python-sdk-core/blob/master/README.md
about initializing the authenticator of your choice.
"""
if not authenticator:
authenticator = get_authenticator_from_environment(service_name)
BaseService.__init__(self,
service_url=self.DEFAULT_SERVICE_URL,
authenticator=authenticator,
disable_ssl_verification=False)
self.version = version
self.configure_service(service_name)
#########################
# Translation
#########################
def translate(self,
text: List[str],
*,
model_id: str = None,
source: str = None,
target: str = None,
**kwargs) -> 'DetailedResponse':
"""
Translate.
Translates the input text from the source language to the target language.
:param List[str] text: Input text in UTF-8 encoding. Multiple entries will
result in multiple translations in the response.
:param str model_id: (optional) A globally unique string that identifies
the underlying model that is used for translation.
:param str source: (optional) Translation source language code.
:param str target: (optional) Translation target language code.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
"""
if text is None:
raise ValueError('text must be provided')
headers = {}
if 'headers' in kwargs:
headers.update(kwargs.get('headers'))
sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME,
service_version='V3',
operation_id='translate')
headers.update(sdk_headers)
params = {'version': self.version}
data = {
'text': text,
'model_id': model_id,
'source': source,
'target': target
}
url = '/v3/translate'
request = self.prepare_request(method='POST',
url=url,
headers=headers,
params=params,
data=data)
response = self.send(request)
return response
#########################
# Identification
#########################
def list_identifiable_languages(self, **kwargs) -> 'DetailedResponse':
"""
List identifiable languages.
Lists the languages that the service can identify. Returns the language code (for
example, `en` for English or `es` for Spanish) and name of each language.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
"""
headers = {}
if 'headers' in kwargs:
headers.update(kwargs.get('headers'))
sdk_headers = get_sdk_headers(
service_name=self.DEFAULT_SERVICE_NAME,
service_version='V3',
operation_id='list_identifiable_languages')
headers.update(sdk_headers)
params = {'version': self.version}
url = '/v3/identifiable_languages'
request = self.prepare_request(method='GET',
url=url,
headers=headers,
params=params)
response = self.send(request)
return response
def identify(self, text: str, **kwargs) -> 'DetailedResponse':
"""
Identify language.
Identifies the language of the input text.
:param str text: Input text in UTF-8 format.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
"""
if text is None:
raise ValueError('text must be provided')
headers = {}
if 'headers' in kwargs:
headers.update(kwargs.get('headers'))
sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME,
service_version='V3',
operation_id='identify')
headers.update(sdk_headers)
params = {'version': self.version}
data = text
headers['content-type'] = 'text/plain'
url = '/v3/identify'
request = self.prepare_request(method='POST',
url=url,
headers=headers,
params=params,
data=data)
response = self.send(request)
return response
#########################
# Models
#########################
def list_models(self,
*,
source: str = None,
target: str = None,
default: bool = None,
**kwargs) -> 'DetailedResponse':
"""
List models.
Lists available translation models.
:param str source: (optional) Specify a language code to filter results by
source language.
:param str target: (optional) Specify a language code to filter results by
target language.
:param bool default: (optional) If the default parameter isn't specified,
the service will return all models (default and non-default) for each
language pair. To return only default models, set this to `true`. To return
only non-default models, set this to `false`. There is exactly one default
model per language pair, the IBM provided base model.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
"""
headers = {}
if 'headers' in kwargs:
headers.update(kwargs.get('headers'))
sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME,
service_version='V3',
operation_id='list_models')
headers.update(sdk_headers)
params = {
'version': self.version,
'source': source,
'target': target,
'default': default
}
url = '/v3/models'
request = self.prepare_request(method='GET',
url=url,
headers=headers,
params=params)
response = self.send(request)
return response
def create_model(self,
base_model_id: str,
*,
forced_glossary: BinaryIO = None,
parallel_corpus: BinaryIO = None,
name: str = None,
**kwargs) -> 'DetailedResponse':
"""
Create model.
Uploads Translation Memory eXchange (TMX) files to customize a translation model.
You can either customize a model with a forced glossary or with a corpus that
contains parallel sentences. To create a model that is customized with a parallel
corpus and a forced glossary, proceed in two steps: customize with a
parallel corpus first and then customize the resulting model with a glossary.
Depending on the type of customization and the size of the uploaded corpora,
training can range from minutes for a glossary to several hours for a large
parallel corpus. You can upload a single forced glossary file and this file must
be less than 10 MB. You can upload multiple parallel corpora tmx files. The
cumulative file size of all uploaded files is limited to 250 MB. To
successfully train with a parallel corpus you must have at least 5,000 parallel
sentences in your corpus.
You can have a maximum of 10 custom models per language pair.
:param str base_model_id: The model ID of the model to use as the base for
customization. To see available models, use the `List models` method.
Usually all IBM provided models are customizable. In addition, all your
models that have been created via parallel corpus customization, can be
further customized with a forced glossary.
:param TextIO forced_glossary: (optional) A TMX file with your
customizations. The customizations in the file completely overwrite the
domain translaton data, including high frequency or high confidence phrase
translations. You can upload only one glossary with a file size less than
10 MB per call. A forced glossary should contain single words or short
phrases.
:param TextIO parallel_corpus: (optional) A TMX file with parallel
sentences for source and target language. You can upload multiple
parallel_corpus files in one request. All uploaded parallel_corpus files
combined, your parallel corpus must contain at least 5,000 parallel
sentences to train successfully.
:param str name: (optional) An optional model name that you can use to
identify the model. Valid characters are letters, numbers, dashes,
underscores, spaces and apostrophes. The maximum length is 32 characters.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
"""
if base_model_id is None:
raise ValueError('base_model_id must be provided')
headers = {}
if 'headers' in kwargs:
headers.update(kwargs.get('headers'))
sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME,
service_version='V3',
operation_id='create_model')
headers.update(sdk_headers)
params = {
'version': self.version,
'base_model_id': base_model_id,
'name': name
}
form_data = []
if forced_glossary:
form_data.append(('forced_glossary', (None, forced_glossary,
'application/octet-stream')))
if parallel_corpus:
form_data.append(('parallel_corpus', (None, parallel_corpus,
'application/octet-stream')))
url = '/v3/models'
request = self.prepare_request(method='POST',
url=url,
headers=headers,
params=params,
files=form_data)
response = self.send(request)
return response
def delete_model(self, model_id: str, **kwargs) -> 'DetailedResponse':
"""
Delete model.
Deletes a custom translation model.
:param str model_id: Model ID of the model to delete.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
"""
if model_id is None:
raise ValueError('model_id must be provided')
headers = {}
if 'headers' in kwargs:
headers.update(kwargs.get('headers'))
sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME,
service_version='V3',
operation_id='delete_model')
headers.update(sdk_headers)
params = {'version': self.version}
url = '/v3/models/{0}'.format(*self._encode_path_vars(model_id))
request = self.prepare_request(method='DELETE',
url=url,
headers=headers,
params=params)
response = self.send(request)
return response
def get_model(self, model_id: str, **kwargs) -> 'DetailedResponse':
"""
Get model details.
Gets information about a translation model, including training status for custom
models. Use this API call to poll the status of your customization request. A
successfully completed training will have a status of `available`.
:param str model_id: Model ID of the model to get.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
"""
if model_id is None:
raise ValueError('model_id must be provided')
headers = {}
if 'headers' in kwargs:
headers.update(kwargs.get('headers'))
sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME,
service_version='V3',
operation_id='get_model')
headers.update(sdk_headers)
params = {'version': self.version}
url = '/v3/models/{0}'.format(*self._encode_path_vars(model_id))
request = self.prepare_request(method='GET',
url=url,
headers=headers,
params=params)
response = self.send(request)
return response
#########################
# Document translation
#########################
def list_documents(self, **kwargs) -> 'DetailedResponse':
"""
List documents.
Lists documents that have been submitted for translation.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
"""
headers = {}
if 'headers' in kwargs:
headers.update(kwargs.get('headers'))
sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME,
service_version='V3',
operation_id='list_documents')
headers.update(sdk_headers)
params = {'version': self.version}
url = '/v3/documents'
request = self.prepare_request(method='GET',
url=url,
headers=headers,
params=params)
response = self.send(request)
return response
def translate_document(self,
file: BinaryIO,
*,
filename: str = None,
file_content_type: str = None,
model_id: str = None,
source: str = None,
target: str = None,
document_id: str = None,
**kwargs) -> 'DetailedResponse':
"""
Translate document.
Submit a document for translation. You can submit the document contents in the
`file` parameter, or you can reference a previously submitted document by document
ID.
:param TextIO file: The contents of the source file to translate.
[Supported file
types](https://cloud.ibm.com/docs/services/language-translator?topic=language-translator-document-translator-tutorial#supported-file-formats)
Maximum file size: **20 MB**.
:param str filename: (optional) The filename for file.
:param str file_content_type: (optional) The content type of file.
:param str model_id: (optional) The model to use for translation.
`model_id` or both `source` and `target` are required.
:param str source: (optional) Language code that specifies the language of
the source document.
:param str target: (optional) Language code that specifies the target
language for translation.
:param str document_id: (optional) To use a previously submitted document
as the source for a new translation, enter the `document_id` of the
document.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
"""
if file is None:
raise ValueError('file must be provided')
headers = {}
if 'headers' in kwargs:
headers.update(kwargs.get('headers'))
sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME,
service_version='V3',
operation_id='translate_document')
headers.update(sdk_headers)
params = {'version': self.version}
form_data = []
if not filename and hasattr(file, 'name'):
filename = basename(file.name)
if not filename:
raise ValueError('filename must be provided')
form_data.append(('file', (filename, file, file_content_type or
'application/octet-stream')))
if model_id:
model_id = str(model_id)
form_data.append(('model_id', (None, model_id, 'text/plain')))
if source:
source = str(source)
form_data.append(('source', (None, source, 'text/plain')))
if target:
target = str(target)
form_data.append(('target', (None, target, 'text/plain')))
if document_id:
document_id = str(document_id)
form_data.append(('document_id', (None, document_id, 'text/plain')))
url = '/v3/documents'
request = self.prepare_request(method='POST',
url=url,
headers=headers,
params=params,
files=form_data)
response = self.send(request)
return response
def get_document_status(self, document_id: str,
**kwargs) -> 'DetailedResponse':
"""
Get document status.
Gets the translation status of a document.
:param str document_id: The document ID of the document.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
"""
if document_id is None:
raise ValueError('document_id must be provided')
headers = {}
if 'headers' in kwargs:
headers.update(kwargs.get('headers'))
sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME,
service_version='V3',
operation_id='get_document_status')
headers.update(sdk_headers)
params = {'version': self.version}
url = '/v3/documents/{0}'.format(*self._encode_path_vars(document_id))
request = self.prepare_request(method='GET',
url=url,
headers=headers,
params=params)
response = self.send(request)
return response
def delete_document(self, document_id: str, **kwargs) -> 'DetailedResponse':
"""
Delete document.
Deletes a document.
:param str document_id: Document ID of the document to delete.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
"""
if document_id is None:
raise ValueError('document_id must be provided')
headers = {}
if 'headers' in kwargs:
headers.update(kwargs.get('headers'))
sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME,
service_version='V3',
operation_id='delete_document')
headers.update(sdk_headers)
params = {'version': self.version}
url = '/v3/documents/{0}'.format(*self._encode_path_vars(document_id))
request = self.prepare_request(method='DELETE',
url=url,
headers=headers,
params=params)
response = self.send(request)
return response
def get_translated_document(self,
document_id: str,
*,
accept: str = None,
**kwargs) -> 'DetailedResponse':
"""
Get translated document.
Gets the translated document associated with the given document ID.
:param str document_id: The document ID of the document that was submitted
for translation.
:param str accept: (optional) The type of the response:
application/powerpoint, application/mspowerpoint, application/x-rtf,
application/json, application/xml, application/vnd.ms-excel,
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,
application/vnd.ms-powerpoint,
application/vnd.openxmlformats-officedocument.presentationml.presentation,
application/msword,
application/vnd.openxmlformats-officedocument.wordprocessingml.document,
application/vnd.oasis.opendocument.spreadsheet,
application/vnd.oasis.opendocument.presentation,
application/vnd.oasis.opendocument.text, application/pdf, application/rtf,
text/html, text/json, text/plain, text/richtext, text/rtf, or text/xml. A
character encoding can be specified by including a `charset` parameter. For
example, 'text/html;charset=utf-8'.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
"""
if document_id is None:
raise ValueError('document_id must be provided')
headers = {'Accept': accept}
if 'headers' in kwargs:
headers.update(kwargs.get('headers'))
sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME,
service_version='V3',
operation_id='get_translated_document')
headers.update(sdk_headers)
params = {'version': self.version}
url = '/v3/documents/{0}/translated_document'.format(
*self._encode_path_vars(document_id))
request = self.prepare_request(method='GET',
url=url,
headers=headers,
params=params)
response = self.send(request)
return response
class TranslateDocumentEnums(object):
class FileContentType(Enum):
"""
The content type of file.
"""
APPLICATION_POWERPOINT = 'application/powerpoint'
APPLICATION_MSPOWERPOINT = 'application/mspowerpoint'
APPLICATION_X_RTF = 'application/x-rtf'
APPLICATION_JSON = 'application/json'
APPLICATION_XML = 'application/xml'
APPLICATION_VND_MS_EXCEL = 'application/vnd.ms-excel'
APPLICATION_VND_OPENXMLFORMATS_OFFICEDOCUMENT_SPREADSHEETML_SHEET = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
APPLICATION_VND_MS_POWERPOINT = 'application/vnd.ms-powerpoint'
APPLICATION_VND_OPENXMLFORMATS_OFFICEDOCUMENT_PRESENTATIONML_PRESENTATION = 'application/vnd.openxmlformats-officedocument.presentationml.presentation'
APPLICATION_MSWORD = 'application/msword'
APPLICATION_VND_OPENXMLFORMATS_OFFICEDOCUMENT_WORDPROCESSINGML_DOCUMENT = 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
APPLICATION_VND_OASIS_OPENDOCUMENT_SPREADSHEET = 'application/vnd.oasis.opendocument.spreadsheet'
APPLICATION_VND_OASIS_OPENDOCUMENT_PRESENTATION = 'application/vnd.oasis.opendocument.presentation'
APPLICATION_VND_OASIS_OPENDOCUMENT_TEXT = 'application/vnd.oasis.opendocument.text'
APPLICATION_PDF = 'application/pdf'
APPLICATION_RTF = 'application/rtf'
TEXT_HTML = 'text/html'
TEXT_JSON = 'text/json'
TEXT_PLAIN = 'text/plain'
TEXT_RICHTEXT = 'text/richtext'
TEXT_RTF = 'text/rtf'
TEXT_XML = 'text/xml'
class GetTranslatedDocumentEnums(object):
class Accept(Enum):
"""
The type of the response: application/powerpoint, application/mspowerpoint,
application/x-rtf, application/json, application/xml, application/vnd.ms-excel,
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,
application/vnd.ms-powerpoint,
application/vnd.openxmlformats-officedocument.presentationml.presentation,
application/msword,
application/vnd.openxmlformats-officedocument.wordprocessingml.document,
application/vnd.oasis.opendocument.spreadsheet,
application/vnd.oasis.opendocument.presentation,
application/vnd.oasis.opendocument.text, application/pdf, application/rtf,
text/html, text/json, text/plain, text/richtext, text/rtf, or text/xml. A
character encoding can be specified by including a `charset` parameter. For
example, 'text/html;charset=utf-8'.
"""
APPLICATION_POWERPOINT = 'application/powerpoint'
APPLICATION_MSPOWERPOINT = 'application/mspowerpoint'
APPLICATION_X_RTF = 'application/x-rtf'
APPLICATION_JSON = 'application/json'
APPLICATION_XML = 'application/xml'
APPLICATION_VND_MS_EXCEL = 'application/vnd.ms-excel'
APPLICATION_VND_OPENXMLFORMATS_OFFICEDOCUMENT_SPREADSHEETML_SHEET = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
APPLICATION_VND_MS_POWERPOINT = 'application/vnd.ms-powerpoint'
APPLICATION_VND_OPENXMLFORMATS_OFFICEDOCUMENT_PRESENTATIONML_PRESENTATION = 'application/vnd.openxmlformats-officedocument.presentationml.presentation'
APPLICATION_MSWORD = 'application/msword'
APPLICATION_VND_OPENXMLFORMATS_OFFICEDOCUMENT_WORDPROCESSINGML_DOCUMENT = 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
APPLICATION_VND_OASIS_OPENDOCUMENT_SPREADSHEET = 'application/vnd.oasis.opendocument.spreadsheet'
APPLICATION_VND_OASIS_OPENDOCUMENT_PRESENTATION = 'application/vnd.oasis.opendocument.presentation'
APPLICATION_VND_OASIS_OPENDOCUMENT_TEXT = 'application/vnd.oasis.opendocument.text'
APPLICATION_PDF = 'application/pdf'
APPLICATION_RTF = 'application/rtf'
TEXT_HTML = 'text/html'
TEXT_JSON = 'text/json'
TEXT_PLAIN = 'text/plain'
TEXT_RICHTEXT = 'text/richtext'
TEXT_RTF = 'text/rtf'
TEXT_XML = 'text/xml'
##############################################################################
# Models
##############################################################################
class DeleteModelResult():
"""
DeleteModelResult.
:attr str status: "OK" indicates that the model was successfully deleted.
"""
def __init__(self, status: str) -> None:
"""
Initialize a DeleteModelResult object.
:param str status: "OK" indicates that the model was successfully deleted.
"""
self.status = status
@classmethod
def from_dict(cls, _dict: Dict) -> 'DeleteModelResult':
"""Initialize a DeleteModelResult object from a json dictionary."""
args = {}
valid_keys = ['status']
bad_keys = set(_dict.keys()) - set(valid_keys)
if bad_keys:
raise ValueError(
'Unrecognized keys detected in dictionary for class DeleteModelResult: '
+ ', '.join(bad_keys))
if 'status' in _dict:
args['status'] = _dict.get('status')
else:
raise ValueError(
'Required property \'status\' not present in DeleteModelResult JSON'
)
return cls(**args)
@classmethod
def _from_dict(cls, _dict):
"""Initialize a DeleteModelResult object from a json dictionary."""
return cls.from_dict(_dict)
def to_dict(self) -> Dict:
"""Return a json dictionary representing this model."""
_dict = {}
if hasattr(self, 'status') and self.status is not None:
_dict['status'] = self.status
return _dict
def _to_dict(self):
"""Return a json dictionary representing this model."""
return self.to_dict()
def __str__(self) -> str:
"""Return a `str` version of this DeleteModelResult object."""
return json.dumps(self._to_dict(), indent=2)
def __eq__(self, other: 'DeleteModelResult') -> bool:
"""Return `true` when self and other are equal, false otherwise."""
if not isinstance(other, self.__class__):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other: 'DeleteModelResult') -> bool:
"""Return `true` when self and other are not equal, false otherwise."""
return not self == other
class DocumentList():
"""
DocumentList.
:attr List[DocumentStatus] documents: An array of all previously submitted
documents.
"""
def __init__(self, documents: List['DocumentStatus']) -> None:
"""
Initialize a DocumentList object.
:param List[DocumentStatus] documents: An array of all previously submitted
documents.
"""
self.documents = documents
@classmethod
def from_dict(cls, _dict: Dict) -> 'DocumentList':
"""Initialize a DocumentList object from a json dictionary."""
args = {}
valid_keys = ['documents']
bad_keys = set(_dict.keys()) - set(valid_keys)
if bad_keys:
raise ValueError(
'Unrecognized keys detected in dictionary for class DocumentList: '
+ ', '.join(bad_keys))
if 'documents' in _dict:
args['documents'] = [
DocumentStatus._from_dict(x) for x in (_dict.get('documents'))
]
else:
raise ValueError(
'Required property \'documents\' not present in DocumentList JSON'
)
return cls(**args)
@classmethod
def _from_dict(cls, _dict):
"""Initialize a DocumentList object from a json dictionary."""
return cls.from_dict(_dict)
def to_dict(self) -> Dict:
"""Return a json dictionary representing this model."""
_dict = {}
if hasattr(self, 'documents') and self.documents is not None:
_dict['documents'] = [x._to_dict() for x in self.documents]
return _dict
def _to_dict(self):
"""Return a json dictionary representing this model."""
return self.to_dict()
def __str__(self) -> str:
"""Return a `str` version of this DocumentList object."""
return json.dumps(self._to_dict(), indent=2)
def __eq__(self, other: 'DocumentList') -> bool:
"""Return `true` when self and other are equal, false otherwise."""
if not isinstance(other, self.__class__):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other: 'DocumentList') -> bool:
"""Return `true` when self and other are not equal, false otherwise."""
return not self == other
class DocumentStatus():
"""
Document information, including translation status.
:attr str document_id: System generated ID identifying a document being
translated using one specific translation model.
:attr str filename: filename from the submission (if it was missing in the
multipart-form, 'noname.' is used.
:attr str status: The status of the translation job associated with a submitted
document.
:attr str model_id: A globally unique string that identifies the underlying
model that is used for translation.
:attr str base_model_id: (optional) Model ID of the base model that was used to
customize the model. If the model is not a custom model, this will be absent or
an empty string.
:attr str source: Translation source language code.
:attr str target: Translation target language code.
:attr datetime created: The time when the document was submitted.
:attr datetime completed: (optional) The time when the translation completed.
:attr int word_count: (optional) An estimate of the number of words in the
source document. Returned only if `status` is `available`.
:attr int character_count: (optional) The number of characters in the source
document, present only if status=available.
"""
def __init__(self,
document_id: str,
filename: str,
status: str,
model_id: str,
source: str,
target: str,
created: datetime,
*,
base_model_id: str = None,
completed: datetime = None,
word_count: int = None,
character_count: int = None) -> None:
"""
Initialize a DocumentStatus object.
:param str document_id: System generated ID identifying a document being
translated using one specific translation model.
:param str filename: filename from the submission (if it was missing in the
multipart-form, 'noname.' is used.
:param str status: The status of the translation job associated with a
submitted document.
:param str model_id: A globally unique string that identifies the
underlying model that is used for translation.
:param str source: Translation source language code.
:param str target: Translation target language code.
:param datetime created: The time when the document was submitted.
:param str base_model_id: (optional) Model ID of the base model that was
used to customize the model. If the model is not a custom model, this will
be absent or an empty string.
:param datetime completed: (optional) The time when the translation
completed.
:param int word_count: (optional) An estimate of the number of words in the
source document. Returned only if `status` is `available`.
:param int character_count: (optional) The number of characters in the
source document, present only if status=available.
"""
self.document_id = document_id
self.filename = filename
self.status = status
self.model_id = model_id
self.base_model_id = base_model_id
self.source = source
self.target = target
self.created = created
self.completed = completed
self.word_count = word_count
self.character_count = character_count
@classmethod
def from_dict(cls, _dict: Dict) -> 'DocumentStatus':
"""Initialize a DocumentStatus object from a json dictionary."""
args = {}
valid_keys = [
'document_id', 'filename', 'status', 'model_id', 'base_model_id',
'source', 'target', 'created', 'completed', 'word_count',
'character_count'
]
bad_keys = set(_dict.keys()) - set(valid_keys)
if bad_keys:
raise ValueError(
'Unrecognized keys detected in dictionary for class DocumentStatus: '
+ ', '.join(bad_keys))
if 'document_id' in _dict:
args['document_id'] = _dict.get('document_id')
else:
raise ValueError(
'Required property \'document_id\' not present in DocumentStatus JSON'
)
if 'filename' in _dict:
args['filename'] = _dict.get('filename')
else:
raise ValueError(
'Required property \'filename\' not present in DocumentStatus JSON'
)
if 'status' in _dict:
args['status'] = _dict.get('status')
else:
raise ValueError(
'Required property \'status\' not present in DocumentStatus JSON'
)
if 'model_id' in _dict:
args['model_id'] = _dict.get('model_id')
else:
raise ValueError(
'Required property \'model_id\' not present in DocumentStatus JSON'
)
if 'base_model_id' in _dict:
args['base_model_id'] = _dict.get('base_model_id')
if 'source' in _dict:
args['source'] = _dict.get('source')
else:
raise ValueError(
'Required property \'source\' not present in DocumentStatus JSON'
)
if 'target' in _dict:
args['target'] = _dict.get('target')
else:
raise ValueError(
'Required property \'target\' not present in DocumentStatus JSON'
)
if 'created' in _dict:
args['created'] = string_to_datetime(_dict.get('created'))
else:
raise ValueError(
'Required property \'created\' not present in DocumentStatus JSON'
)
if 'completed' in _dict:
args['completed'] = string_to_datetime(_dict.get('completed'))
if 'word_count' in _dict:
args['word_count'] = _dict.get('word_count')
if 'character_count' in _dict:
args['character_count'] = _dict.get('character_count')
return cls(**args)
@classmethod
def _from_dict(cls, _dict):
"""Initialize a DocumentStatus object from a json dictionary."""
return cls.from_dict(_dict)
def to_dict(self) -> Dict:
"""Return a json dictionary representing this model."""
_dict = {}
if hasattr(self, 'document_id') and self.document_id is not None:
_dict['document_id'] = self.document_id
if hasattr(self, 'filename') and self.filename is not None:
_dict['filename'] = self.filename
if hasattr(self, 'status') and self.status is not None:
_dict['status'] = self.status
if hasattr(self, 'model_id') and self.model_id is not None:
_dict['model_id'] = self.model_id
if hasattr(self, 'base_model_id') and self.base_model_id is not None:
_dict['base_model_id'] = self.base_model_id
if hasattr(self, 'source') and self.source is not None:
_dict['source'] = self.source
if hasattr(self, 'target') and self.target is not None:
_dict['target'] = self.target
if hasattr(self, 'created') and self.created is not None:
_dict['created'] = datetime_to_string(self.created)
if hasattr(self, 'completed') and self.completed is not None:
_dict['completed'] = datetime_to_string(self.completed)
if hasattr(self, 'word_count') and self.word_count is not None:
_dict['word_count'] = self.word_count
if hasattr(self,
'character_count') and self.character_count is not None:
_dict['character_count'] = self.character_count
return _dict
def _to_dict(self):
"""Return a json dictionary representing this model."""
return self.to_dict()
def __str__(self) -> str:
"""Return a `str` version of this DocumentStatus object."""
return json.dumps(self._to_dict(), indent=2)
def __eq__(self, other: 'DocumentStatus') -> bool:
"""Return `true` when self and other are equal, false otherwise."""
if not isinstance(other, self.__class__):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other: 'DocumentStatus') -> bool:
"""Return `true` when self and other are not equal, false otherwise."""
return not self == other
class StatusEnum(Enum):
"""
The status of the translation job associated with a submitted document.
"""
PROCESSING = "processing"
AVAILABLE = "available"
FAILED = "failed"
class IdentifiableLanguage():
"""
IdentifiableLanguage.
:attr str language: The language code for an identifiable language.
:attr str name: The name of the identifiable language.
"""
def __init__(self, language: str, name: str) -> None:
"""
Initialize a IdentifiableLanguage object.
:param str language: The language code for an identifiable language.
:param str name: The name of the identifiable language.
"""
self.language = language
self.name = name
@classmethod
def from_dict(cls, _dict: Dict) -> 'IdentifiableLanguage':
"""Initialize a IdentifiableLanguage object from a json dictionary."""
args = {}
valid_keys = ['language', 'name']
bad_keys = set(_dict.keys()) - set(valid_keys)
if bad_keys:
raise ValueError(
'Unrecognized keys detected in dictionary for class IdentifiableLanguage: '
+ ', '.join(bad_keys))
if 'language' in _dict:
args['language'] = _dict.get('language')
else:
raise ValueError(
'Required property \'language\' not present in IdentifiableLanguage JSON'
)
if 'name' in _dict:
args['name'] = _dict.get('name')
else:
raise ValueError(
'Required property \'name\' not present in IdentifiableLanguage JSON'
)
return cls(**args)
@classmethod
def _from_dict(cls, _dict):
"""Initialize a IdentifiableLanguage object from a json dictionary."""
return cls.from_dict(_dict)
def to_dict(self) -> Dict:
"""Return a json dictionary representing this model."""
_dict = {}
if hasattr(self, 'language') and self.language is not None:
_dict['language'] = self.language
if hasattr(self, 'name') and self.name is not None:
_dict['name'] = self.name
return _dict
def _to_dict(self):
"""Return a json dictionary representing this model."""
return self.to_dict()
def __str__(self) -> str:
"""Return a `str` version of this IdentifiableLanguage object."""
return json.dumps(self._to_dict(), indent=2)
def __eq__(self, other: 'IdentifiableLanguage') -> bool:
"""Return `true` when self and other are equal, false otherwise."""
if not isinstance(other, self.__class__):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other: 'IdentifiableLanguage') -> bool:
"""Return `true` when self and other are not equal, false otherwise."""
return not self == other
class IdentifiableLanguages():
"""
IdentifiableLanguages.
:attr List[IdentifiableLanguage] languages: A list of all languages that the
service can identify.
"""
def __init__(self, languages: List['IdentifiableLanguage']) -> None:
"""
Initialize a IdentifiableLanguages object.
:param List[IdentifiableLanguage] languages: A list of all languages that
the service can identify.
"""
self.languages = languages
@classmethod
def from_dict(cls, _dict: Dict) -> 'IdentifiableLanguages':
"""Initialize a IdentifiableLanguages object from a json dictionary."""
args = {}
valid_keys = ['languages']
bad_keys = set(_dict.keys()) - set(valid_keys)
if bad_keys:
raise ValueError(
'Unrecognized keys detected in dictionary for class IdentifiableLanguages: '
+ ', '.join(bad_keys))
if 'languages' in _dict:
args['languages'] = [
IdentifiableLanguage._from_dict(x)
for x in (_dict.get('languages'))
]
else:
raise ValueError(
'Required property \'languages\' not present in IdentifiableLanguages JSON'
)
return cls(**args)
@classmethod
def _from_dict(cls, _dict):
"""Initialize a IdentifiableLanguages object from a json dictionary."""
return cls.from_dict(_dict)
def to_dict(self) -> Dict:
"""Return a json dictionary representing this model."""
_dict = {}
if hasattr(self, 'languages') and self.languages is not None:
_dict['languages'] = [x._to_dict() for x in self.languages]
return _dict
def _to_dict(self):
"""Return a json dictionary representing this model."""
return self.to_dict()
def __str__(self) -> str:
"""Return a `str` version of this IdentifiableLanguages object."""
return json.dumps(self._to_dict(), indent=2)
def __eq__(self, other: 'IdentifiableLanguages') -> bool:
"""Return `true` when self and other are equal, false otherwise."""
if not isinstance(other, self.__class__):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other: 'IdentifiableLanguages') -> bool:
"""Return `true` when self and other are not equal, false otherwise."""
return not self == other
class IdentifiedLanguage():
"""
IdentifiedLanguage.
:attr str language: The language code for an identified language.
:attr float confidence: The confidence score for the identified language.
"""
def __init__(self, language: str, confidence: float) -> None:
"""
Initialize a IdentifiedLanguage object.
:param str language: The language code for an identified language.
:param float confidence: The confidence score for the identified language.
"""
self.language = language
self.confidence = confidence
@classmethod
def from_dict(cls, _dict: Dict) -> 'IdentifiedLanguage':
"""Initialize a IdentifiedLanguage object from a json dictionary."""
args = {}
valid_keys = ['language', 'confidence']
bad_keys = set(_dict.keys()) - set(valid_keys)
if bad_keys:
raise ValueError(
'Unrecognized keys detected in dictionary for class IdentifiedLanguage: '
+ ', '.join(bad_keys))
if 'language' in _dict:
args['language'] = _dict.get('language')
else:
raise ValueError(
'Required property \'language\' not present in IdentifiedLanguage JSON'
)
if 'confidence' in _dict:
args['confidence'] = _dict.get('confidence')
else:
raise ValueError(
'Required property \'confidence\' not present in IdentifiedLanguage JSON'
)
return cls(**args)
@classmethod
def _from_dict(cls, _dict):
"""Initialize a IdentifiedLanguage object from a json dictionary."""
return cls.from_dict(_dict)
def to_dict(self) -> Dict:
"""Return a json dictionary representing this model."""
_dict = {}
if hasattr(self, 'language') and self.language is not None:
_dict['language'] = self.language
if hasattr(self, 'confidence') and self.confidence is not None:
_dict['confidence'] = self.confidence
return _dict
def _to_dict(self):
"""Return a json dictionary representing this model."""
return self.to_dict()
def __str__(self) -> str:
"""Return a `str` version of this IdentifiedLanguage object."""
return json.dumps(self._to_dict(), indent=2)
def __eq__(self, other: 'IdentifiedLanguage') -> bool:
"""Return `true` when self and other are equal, false otherwise."""
if not isinstance(other, self.__class__):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other: 'IdentifiedLanguage') -> bool:
"""Return `true` when self and other are not equal, false otherwise."""
return not self == other
class IdentifiedLanguages():
"""
IdentifiedLanguages.
:attr List[IdentifiedLanguage] languages: A ranking of identified languages with
confidence scores.
"""
def __init__(self, languages: List['IdentifiedLanguage']) -> None:
"""
Initialize a IdentifiedLanguages object.
:param List[IdentifiedLanguage] languages: A ranking of identified
languages with confidence scores.
"""
self.languages = languages
@classmethod
def from_dict(cls, _dict: Dict) -> 'IdentifiedLanguages':
"""Initialize a IdentifiedLanguages object from a json dictionary."""
args = {}
valid_keys = ['languages']
bad_keys = set(_dict.keys()) - set(valid_keys)
if bad_keys:
raise ValueError(
'Unrecognized keys detected in dictionary for class IdentifiedLanguages: '
+ ', '.join(bad_keys))
if 'languages' in _dict:
args['languages'] = [
IdentifiedLanguage._from_dict(x)
for x in (_dict.get('languages'))
]
else:
raise ValueError(
'Required property \'languages\' not present in IdentifiedLanguages JSON'
)
return cls(**args)
@classmethod
def _from_dict(cls, _dict):
"""Initialize a IdentifiedLanguages object from a json dictionary."""
return cls.from_dict(_dict)
def to_dict(self) -> Dict:
"""Return a json dictionary representing this model."""
_dict = {}
if hasattr(self, 'languages') and self.languages is not None:
_dict['languages'] = [x._to_dict() for x in self.languages]
return _dict
def _to_dict(self):
"""Return a json dictionary representing this model."""
return self.to_dict()
def __str__(self) -> str:
"""Return a `str` version of this IdentifiedLanguages object."""
return json.dumps(self._to_dict(), indent=2)
def __eq__(self, other: 'IdentifiedLanguages') -> bool:
"""Return `true` when self and other are equal, false otherwise."""
if not isinstance(other, self.__class__):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other: 'IdentifiedLanguages') -> bool:
"""Return `true` when self and other are not equal, false otherwise."""
return not self == other
class Translation():
"""
Translation.
:attr str translation: Translation output in UTF-8.
"""
def __init__(self, translation: str) -> None:
"""
Initialize a Translation object.
:param str translation: Translation output in UTF-8.
"""
self.translation = translation
@classmethod
def from_dict(cls, _dict: Dict) -> 'Translation':
"""Initialize a Translation object from a json dictionary."""
args = {}
valid_keys = ['translation']
bad_keys = set(_dict.keys()) - set(valid_keys)
if bad_keys:
raise ValueError(
'Unrecognized keys detected in dictionary for class Translation: '
+ ', '.join(bad_keys))
if 'translation' in _dict:
args['translation'] = _dict.get('translation')
else:
raise ValueError(
'Required property \'translation\' not present in Translation JSON'
)
return cls(**args)
@classmethod
def _from_dict(cls, _dict):
"""Initialize a Translation object from a json dictionary."""
return cls.from_dict(_dict)
def to_dict(self) -> Dict:
"""Return a json dictionary representing this model."""
_dict = {}
if hasattr(self, 'translation') and self.translation is not None:
_dict['translation'] = self.translation
return _dict
def _to_dict(self):
"""Return a json dictionary representing this model."""
return self.to_dict()
def __str__(self) -> str:
"""Return a `str` version of this Translation object."""
return json.dumps(self._to_dict(), indent=2)
def __eq__(self, other: 'Translation') -> bool:
"""Return `true` when self and other are equal, false otherwise."""
if not isinstance(other, self.__class__):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other: 'Translation') -> bool:
"""Return `true` when self and other are not equal, false otherwise."""
return not self == other
class TranslationModel():
"""
Response payload for models.
:attr str model_id: A globally unique string that identifies the underlying
model that is used for translation.
:attr str name: (optional) Optional name that can be specified when the model is
created.
:attr str source: (optional) Translation source language code.
:attr str target: (optional) Translation target language code.
:attr str base_model_id: (optional) Model ID of the base model that was used to
customize the model. If the model is not a custom model, this will be an empty
string.
:attr str domain: (optional) The domain of the translation model.
:attr bool customizable: (optional) Whether this model can be used as a base for
customization. Customized models are not further customizable, and some base
models are not customizable.
:attr bool default_model: (optional) Whether or not the model is a default
model. A default model is the model for a given language pair that will be used
when that language pair is specified in the source and target parameters.
:attr str owner: (optional) Either an empty string, indicating the model is not
a custom model, or the ID of the service instance that created the model.
:attr str status: (optional) Availability of a model.
"""
def __init__(self,
model_id: str,
*,
name: str = None,
source: str = None,
target: str = None,
base_model_id: str = None,
domain: str = None,
customizable: bool = None,
default_model: bool = None,
owner: str = None,
status: str = None) -> None:
"""
Initialize a TranslationModel object.
:param str model_id: A globally unique string that identifies the
underlying model that is used for translation.
:param str name: (optional) Optional name that can be specified when the
model is created.
:param str source: (optional) Translation source language code.
:param str target: (optional) Translation target language code.
:param str base_model_id: (optional) Model ID of the base model that was
used to customize the model. If the model is not a custom model, this will
be an empty string.
:param str domain: (optional) The domain of the translation model.
:param bool customizable: (optional) Whether this model can be used as a
base for customization. Customized models are not further customizable, and
some base models are not customizable.
:param bool default_model: (optional) Whether or not the model is a default
model. A default model is the model for a given language pair that will be
used when that language pair is specified in the source and target
parameters.
:param str owner: (optional) Either an empty string, indicating the model
is not a custom model, or the ID of the service instance that created the
model.
:param str status: (optional) Availability of a model.
"""
self.model_id = model_id
self.name = name
self.source = source
self.target = target
self.base_model_id = base_model_id
self.domain = domain
self.customizable = customizable
self.default_model = default_model
self.owner = owner
self.status = status
@classmethod
def from_dict(cls, _dict: Dict) -> 'TranslationModel':
"""Initialize a TranslationModel object from a json dictionary."""
args = {}
valid_keys = [
'model_id', 'name', 'source', 'target', 'base_model_id', 'domain',
'customizable', 'default_model', 'owner', 'status'
]
bad_keys = set(_dict.keys()) - set(valid_keys)
if bad_keys:
raise ValueError(
'Unrecognized keys detected in dictionary for class TranslationModel: '
+ ', '.join(bad_keys))
if 'model_id' in _dict:
args['model_id'] = _dict.get('model_id')
else:
raise ValueError(
'Required property \'model_id\' not present in TranslationModel JSON'
)
if 'name' in _dict:
args['name'] = _dict.get('name')
if 'source' in _dict:
args['source'] = _dict.get('source')
if 'target' in _dict:
args['target'] = _dict.get('target')
if 'base_model_id' in _dict:
args['base_model_id'] = _dict.get('base_model_id')
if 'domain' in _dict:
args['domain'] = _dict.get('domain')
if 'customizable' in _dict:
args['customizable'] = _dict.get('customizable')
if 'default_model' in _dict:
args['default_model'] = _dict.get('default_model')
if 'owner' in _dict:
args['owner'] = _dict.get('owner')
if 'status' in _dict:
args['status'] = _dict.get('status')
return cls(**args)
@classmethod
def _from_dict(cls, _dict):
"""Initialize a TranslationModel object from a json dictionary."""
return cls.from_dict(_dict)
def to_dict(self) -> Dict:
"""Return a json dictionary representing this model."""
_dict = {}
if hasattr(self, 'model_id') and self.model_id is not None:
_dict['model_id'] = self.model_id
if hasattr(self, 'name') and self.name is not None:
_dict['name'] = self.name
if hasattr(self, 'source') and self.source is not None:
_dict['source'] = self.source
if hasattr(self, 'target') and self.target is not None:
_dict['target'] = self.target
if hasattr(self, 'base_model_id') and self.base_model_id is not None:
_dict['base_model_id'] = self.base_model_id
if hasattr(self, 'domain') and self.domain is not None:
_dict['domain'] = self.domain
if hasattr(self, 'customizable') and self.customizable is not None:
_dict['customizable'] = self.customizable
if hasattr(self, 'default_model') and self.default_model is not None:
_dict['default_model'] = self.default_model
if hasattr(self, 'owner') and self.owner is not None:
_dict['owner'] = self.owner
if hasattr(self, 'status') and self.status is not None:
_dict['status'] = self.status
return _dict
def _to_dict(self):
"""Return a json dictionary representing this model."""
return self.to_dict()
def __str__(self) -> str:
"""Return a `str` version of this TranslationModel object."""
return json.dumps(self._to_dict(), indent=2)
def __eq__(self, other: 'TranslationModel') -> bool:
"""Return `true` when self and other are equal, false otherwise."""
if not isinstance(other, self.__class__):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other: 'TranslationModel') -> bool:
"""Return `true` when self and other are not equal, false otherwise."""
return not self == other
class StatusEnum(Enum):
"""
Availability of a model.
"""
UPLOADING = "uploading"
UPLOADED = "uploaded"
DISPATCHING = "dispatching"
QUEUED = "queued"
TRAINING = "training"
TRAINED = "trained"
PUBLISHING = "publishing"
AVAILABLE = "available"
DELETED = "deleted"
ERROR = "error"
class TranslationModels():
"""
The response type for listing existing translation models.
:attr List[TranslationModel] models: An array of available models.
"""
def __init__(self, models: List['TranslationModel']) -> None:
"""
Initialize a TranslationModels object.
:param List[TranslationModel] models: An array of available models.
"""
self.models = models
@classmethod
def from_dict(cls, _dict: Dict) -> 'TranslationModels':
"""Initialize a TranslationModels object from a json dictionary."""
args = {}
valid_keys = ['models']
bad_keys = set(_dict.keys()) - set(valid_keys)
if bad_keys:
raise ValueError(
'Unrecognized keys detected in dictionary for class TranslationModels: '
+ ', '.join(bad_keys))
if 'models' in _dict:
args['models'] = [
TranslationModel._from_dict(x) for x in (_dict.get('models'))
]
else:
raise ValueError(
'Required property \'models\' not present in TranslationModels JSON'
)
return cls(**args)
@classmethod
def _from_dict(cls, _dict):
"""Initialize a TranslationModels object from a json dictionary."""
return cls.from_dict(_dict)
def to_dict(self) -> Dict:
"""Return a json dictionary representing this model."""
_dict = {}
if hasattr(self, 'models') and self.models is not None:
_dict['models'] = [x._to_dict() for x in self.models]
return _dict
def _to_dict(self):
"""Return a json dictionary representing this model."""
return self.to_dict()
def __str__(self) -> str:
"""Return a `str` version of this TranslationModels object."""
return json.dumps(self._to_dict(), indent=2)
def __eq__(self, other: 'TranslationModels') -> bool:
"""Return `true` when self and other are equal, false otherwise."""
if not isinstance(other, self.__class__):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other: 'TranslationModels') -> bool:
"""Return `true` when self and other are not equal, false otherwise."""
return not self == other
class TranslationResult():
"""
TranslationResult.
:attr int word_count: An estimate of the number of words in the input text.
:attr int character_count: Number of characters in the input text.
:attr List[Translation] translations: List of translation output in UTF-8,
corresponding to the input text entries.
"""
def __init__(self, word_count: int, character_count: int,
translations: List['Translation']) -> None:
"""
Initialize a TranslationResult object.
:param int word_count: An estimate of the number of words in the input
text.
:param int character_count: Number of characters in the input text.
:param List[Translation] translations: List of translation output in UTF-8,
corresponding to the input text entries.
"""
self.word_count = word_count
self.character_count = character_count
self.translations = translations
@classmethod
def from_dict(cls, _dict: Dict) -> 'TranslationResult':
"""Initialize a TranslationResult object from a json dictionary."""
args = {}
valid_keys = ['word_count', 'character_count', 'translations']
bad_keys = set(_dict.keys()) - set(valid_keys)
if bad_keys:
raise ValueError(
'Unrecognized keys detected in dictionary for class TranslationResult: '
+ ', '.join(bad_keys))
if 'word_count' in _dict:
args['word_count'] = _dict.get('word_count')
else:
raise ValueError(
'Required property \'word_count\' not present in TranslationResult JSON'
)
if 'character_count' in _dict:
args['character_count'] = _dict.get('character_count')
else:
raise ValueError(
'Required property \'character_count\' not present in TranslationResult JSON'
)
if 'translations' in _dict:
args['translations'] = [
Translation._from_dict(x) for x in (_dict.get('translations'))
]
else:
raise ValueError(
'Required property \'translations\' not present in TranslationResult JSON'
)
return cls(**args)
@classmethod
def _from_dict(cls, _dict):
"""Initialize a TranslationResult object from a json dictionary."""
return cls.from_dict(_dict)
def to_dict(self) -> Dict:
"""Return a json dictionary representing this model."""
_dict = {}
if hasattr(self, 'word_count') and self.word_count is not None:
_dict['word_count'] = self.word_count
if hasattr(self,
'character_count') and self.character_count is not None:
_dict['character_count'] = self.character_count
if hasattr(self, 'translations') and self.translations is not None:
_dict['translations'] = [x._to_dict() for x in self.translations]
return _dict
def _to_dict(self):
"""Return a json dictionary representing this model."""
return self.to_dict()
def __str__(self) -> str:
"""Return a `str` version of this TranslationResult object."""
return json.dumps(self._to_dict(), indent=2)
def __eq__(self, other: 'TranslationResult') -> bool:
"""Return `true` when self and other are equal, false otherwise."""
if not isinstance(other, self.__class__):
return False
return self.__dict__ == other.__dict__
def __ne__(self, other: 'TranslationResult') -> bool:
"""Return `true` when self and other are not equal, false otherwise."""
return not self == other