Returns the translation finder details for a scope. The scope defines which resources are accessible and can be searched.
The message body contains a JSON object:
The scope object. It delimits the total range of segments and related resources that can be operated on.
The text to search.
Optional segment for which we search. If set then the system excludes the segment itself from the search results. Recommended.
|src||The source language code.|
|trg||The target language code.|
Optional. The hash code of the previous segment if available (can be null). If specified then the finder is capable of telling if a hit is an in-context match (110% hit).
Note: Only use the hash codes if the resource is a "Document". With memories or termbases, the segments have no logical order.
Optional. The hash code of the next segment if available (can be null). If specified then the finder is capable of telling if a hit is an in-context match (110% hit).
Optional context of the segment.
In combination with tmhits.ctxboost, setting the context permits to promote hits that match the context of the searched segment.
|sim||Optional. Similarity threshold between 40 and 110. If not specified, the threshold is set to 80.|
Optional. Specifies how top hits are selected and further permits to apply filters on various properties such as status, bookmarks, context, change date and so on.
Read details here:
|token||The finder token. The first time you call a finder method you do not yet have a token. It is included with each call and you can then reuse it for subsequent calls. Doing so substantially optimizes performance of all finder methods.|
The properties are:
An array with the found hits. See below.
Each hit in results has these properties:
An internal score for the hit. This score takes into account the similarity of the text and, if enabled, the similarity of the segment context/key.
For internal use.
|sim||The text similarity of the hit in percent. A value either 0 (not a context match) or 100 (is a context match)||int|
|simctx||The context/key similarity. A percentage between 0 or 100||int|
The type of hit:
The reliability of the hit's translation:
Any penalties applied to the similarity (sim). Value of 5 means we deduced 5% points from original similarity.
Penalties are configured in a resource's Search Settings page.
|dbl||Number of doubles. If the exact same hit was found multiple times it is returned only once. This number indicates the total amount of doubles.||int|
Non overlapping term hit (hty = 2). For a given segment the system may find a large number of terms.
The system then identifies those terms that do not overlap, for example if the hits's words are colored in the original text.
Array of regions in the original text that differ from the hit's source text. Used to color highlight text differences. Optional array:
The character start position and length in the original text that entirely spans the hit source text.
Only populated with term hits.
An object with hit segment level properties:
An object with the hit's source text details:
An object with the hit's translation details: