If the API changes in an incompatible manner this is listed explicitly in the "important release notes" section of each releases changelog.
URL: | /editor/plugins_matchanalysis_matchanalysis/ | |||||||||
Available Methods: | GET listing only | |||||||||
| Parameters: |
| |||||||||
Specialities: | Returns a list of words count in a matchrate group for each associated language resource. Each segment can only appear in one matchrate and language resources group. | |||||||||
| Availability: | public |
Match analysis Export URLs
URL to get the match analysis results exported: | export |
| Parameter types | "excel", xml |
Response Layout
Name | Type | Info |
resourceName | string | GET only |
| resourceColor | string | GET only |
| created | date | GET only |
| internalFuzzy | boolean | GET only |
| 104 | number | GET only, match from term collection |
| 103 | number | GET only, context match |
| 102 | number | GET only, repetition |
| 101 | number | GET only, exact-exact match |
| 100 | number | GET only |
| 90 | number | GET only, matches with matchrate between 90 and 99 |
| 80 | number | GET only, GET only, matches with matchrate between 80 and 89 |
| 70 | number | GET only, matches with matchrate between 70 and 79 |
| 60 | number | GET only, matches with matchrate between 60 and 69 |
| noMatch | number | GET only, matches with matchrate between 0 and 59 |
Injected task operation to start the analysis and or pre-translation
The analysis / pre-translation of a task is started via the following two operations on a specific task.
URL: | /editor/task/TASK_ID/analysis/operation | |
Available Methods: | PUT only | |
| Purpose: | Starts the analysis of a task | |
Parameters: | internalFuzzy | 0 or 1 if internal fuzzies should be used or not |
| Availability: | public |
URL: | /editor/task/TASK_ID/pretranslation/operation | |
Available Methods: | PUT only | |
| Purpose: | Starts the analysis and pre-translation of a task | |
Parameters: | internalFuzzy | 0 or 1 if internal fuzzies should be used. To define default preset, use runtimeOptions.plugins.MatchAnalysis.internalFuzzyDefault |
| pretranslateMatchrate | number between 0 and 100, the minimum matchrate of a found TM match to be considered as a valid pre-translation | |
| pretranslateTmAndTerm | 0 or 1, defines if TMs and Term Collections should be used for pre-translation. To define default preset, use runtimeOptions.plugins.MatchAnalysis.pretranslateTmAndTermDefault | |
| pretranslateMt | 0 or 1, only usable if above pretranslateTmAndTerm is used, defines if MTs should be used also for pre-translation if no usable TM / Term was found. To define default preset, use runtimeOptions.plugins.MatchAnalysis.pretranslateMtDefault | |
| termtaggerSegment | 0 or 1 if terminology should be marked if a term collection is assigned as well, currently only usable on import | |
| isTaskImport | 0 or 1 defines if call is in import or not, will be removed in the future, since can be loaded from the task as well, only needed when using termtaggerSegment | |
| Availability: | public |
Important note: When starting a match analysis an intermediate pause worker (PauseMatchAnalysisWorker) is started. This worker was designed to pause analysis until language resources used for analysis and pretranslation are available for querying. Details about PauseWorker conception can be found in the following doc page https://confluence.translate5.net/x/BAET