Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Note

If the API changes in an incompatible manner this is listed explicitly in the "important release notes" section of each releases changelog.

Description

Enables the usage of third party TM and MT systems in translate5. To support a MT / TM ti must be implement as a service in translate5. This is quite easy and usually a matter of days. Please contact us, if you need help on this.

Moses MT, OpenTM2, Google, Lucy, MS Translator, SdlLanguageCloud, GroupShare , NEC-TM (as Plugin), PangeaMT (as Plugin), and DeepL (as Plugin, only available for companies with a Support- and Development contract) are supported so far. For SDL GroupShare support please ask MittagQI.

TM/MT systems (or in general language resource) can be associated to tasks. In such tasks the user gets automatically found matches to the segments he is editing.

...

Name

Type

Info

attributes

string

Additional meta data of the returned match/search result, empty if not available.

createddateMeta data, creation time stamp of the returned match/search result

creator

string

Meta data, creator of the returned match/search result

lastEditeddateMeta data, last edited time stamp of the returned match/search result
lastEditorstringMeta data, last editor of the returned match/search result

matchrate

integer

matchrate of a found match, 0 for search results.

source

string

The found source text.

state

string

"loaded" wenn all is OK, "servererror" when we got an error in the queried service.

target

string

The found target text.

languageResourceIdstring

The queried Language Resource, just for reference.

 


Langauge-Resource Instance Resource Layout

Name

Type

Info

id

integer

GET only

entityVersionintegerGET only, set by server
langResUuidstringGET only, is ignored on PUT/POST, is an auto generated UUID set on language resource creation. Contains a unique identified for the language resource.

name

string

Custom name of the match resource.

sourceLangintegerGET / POST, non editable after creation; numeric DB id of the language
targetLangintegerGET / POST, non editable after creation; numeric DB id of the language

color

string

Custom color of the match resource in hexadecimal form, used in the GUI.

resourceId

string

POST / GET, non editable after creation

serviceType

string

POST / GET only, only, set by setting a resourceId

serviceName

string

GET only, set by setting a resourceId

fileNamestring

POST / GET, can not be changed

filebasedbooleanGET only, set by setting a resourceId
searchablebooleanGET only, set by setting a resourceId
customerIdsarray of integers

POST, PUT: contains an array with customerIds to be assigned to that language resource

customerUseAsDefaultIdsarray of integers

POST, PUT: contains a subset of customerIds of the above customerIds. The here referenced customers use this language resource by default to read from.

customerWriteAsDefaultIdsarray of integers

POST, PUT: contains a subset of customer ids of the above customerUseAsDefaultIds. The here referenced customers use this language resource by default to write into it.To be able to write by default

the customer must be also set as read as default.

Configuration of the Language Resources

Config name

Values

Default

Description

Anchor
fileExtension
fileExtension
runtimeOptions.LanguageResources.fileExtension

map
Available file types by extension per engine type. The engine type is defined by source rcf5646,target rcf5646. ex: "en-ge,en-us"

runtimeOptions.LanguageResources.preloadedTranslationSegments

integer3Number of segments for which matches are preloaded (cached) in the front-end.
runtimeOptions.LanguageResources.moses.serverjson array[ ]Moses MT related: List of available Moses Server, example: ["http://www.translate5.net:8124/RPC2"]
runtimeOptions.LanguageResources.moses.matchrateinteger, 0 - 10070

Moses MT related: Moses MT penalty value, used as default matchrate since in MT no matchrate is available.