The endpoint that is responsible for decorating a segment (translating a segment) in TermWeb Web Services is the Stemmer Endpoint. You can use two methods in order to get a response, segmentSearch and segmentSearchTemplate. The first one returns a translation by using default configuration and by searching in the user's currently or lastly viewed dictionary. The second one returns a translation by using configuration from a specific template defined in TermWeb.
Until Since TermWeb version 3.17.8 not all target concept /and term fields are included in the decoration , but specifically the following:
...
Source Term Id
...
Source Concept Id
...
Source Term (name)
...
Target Term Id
...
Target Concept Id
...
Target Term (name)
...
Modified By
...
Modified Date
...
Client Name
...
Domain Name
...
Term Definition
...
Term Usage Status
...
Term Process Status
...
Term Context
...
Since TermWeb version 3.17.8 all concept and term fields are included in the decorationas long as they have a value. Source term name, term ID and concept ID are also being sent for reference purposes.
Segment Decoration Details
...
| Code Block | ||
|---|---|---|
| ||
Example Segment: <g id=123>Terminology Management</g> Software Example Term: Management Software Decoration: <g id=123>Terminology </g><mrk><g id=123>Management<\g> Software</mrk> |
Conflicting terms (sharing common words) matching 100%
There are cases where multiple terms sharing common words are eligible to be included in the decoration. In this case not all of them can be included. Since TermWeb version 3.18.0.7 the longest one in characters is prioritized. However, terms matched 100% with the segment have a priority over terms matched through stemming, even if the are shorter in characters, except if api.stem.comparison.margin property is used. Terms with case differences (capitals and small case) are not considered 100% matched.
| Code Block | ||
|---|---|---|
| ||
Example Segment: Terminology Management Software
Example Terms: Terminology Management (22 characters), Management Software (19 characters)
Decoration: <mrk>Terminology Management</mrk> Software ('Terminology Management' is used instead of 'Management Software', because it is longer in characters) |
Conflicting terms (sharing common words) matching through stemming
There are cases where conflicting terms do not match 100% with the segment. In this case since version 3.18.0.12 the first criterium that selects the term for the decoration is the length of the term in number of stems and the second criterium is the resemblance of the stems according to the Levenshtein distance.
| Code Block | ||
|---|---|---|
| ||
Example Segment: Les conseillers RH ainsi que les autres. Example Terms: conseiller RH (1 character difference from 'conseillers RH'), conseil RH (4 characters difference from 'conseillers RH') Decoration: Les <mrk term:sourceTerm="conseiller RH">conseillers RH</mrk> ainsi que les autres. |
Stem comparison margin option
Since TermWeb version 3.18.0.11 a new property has been introduced that allows a margin of characters when comparing between stems in cases of non-100% matching cases.
In the following example we are setting the property to 1 character → api.stem.comparison.margin=1
| Code Block | ||
|---|---|---|
| ||
Example Segment: Schwerpunktthemen sind die Reduktionen bei den Listenpreisen. (Stem is Schwerpunktthem) Example Terms: Schwerpunktthema (Stem is Schwerpunktthema) Decoration: <mrk term:sourceTerm="Schwerpunktthema">Schwerpunktthemen</mrk> sind die Reduktionen bei den Listenpreisen. Explanation: Even though stems 'Schwerpunktthem' and 'Schwerpunktthema' do not match, comparison margin of 1 character allows the term to be included in decoration. |
Homonyms
Homonyms are terms with exactly the same name, but different meaning. Homonyms are usually being created in different concepts. All homonyms are included in the decoration.
...
| Code Block | ||
|---|---|---|
| ||
api.search.limit=<limit> |
Note
Until TermWeb version 3.17.8 not all concept/term fields are included in the decoration, but specifically the following:
| Source | Field | Returns As | Comments | Date Implemented |
|---|---|---|---|---|
| Source Term | Source Term Id | sourceTermId | Initial version | |
| Source Term | Source Concept Id | sourceConceptId | Initial version | |
| Source Term | Source Term (name) | sourceTerm | Initial version | |
| Target Term | Target Term Id | id | Initial version | |
| Target Term | Target Concept Id | conceptId | It should be the same as Source Concept Id | Initial version |
| Target Term | Target Term (name) | tgt | Initial version | |
| Target Term | Modified By | modifiedBy | Initial version | |
| Target Term | Modified Date | modifiedDate | Initial version | |
| Target Term | Client Name | customer | Initial version | |
| Target Term | Domain Name | domain | Initial version | |
| Target Term | Term Definition | definition | Initial version | |
| Target Term | Term Usage Status | status | Initial version | |
| Target Term | Term Process Status | processStatus | Initial version | |
| Target Term | Term Context | context | Initial version | |
| Target Term | Term Reference | reference | Initial version | |
| Target Term | Term Remarks | remarks | Initial version | |
| Target Term | Indication whether Term is an abbreviation | abbreviation | Initial version | |
| Target Term | Indication whether Term is deprecated | deprecated | According to TBX standards and custom template configuration of deprecated field/value | 20-10-2016 (3.17.3) |
| Target Term | Indication whether Term is accepted | accepted | According to custom template configuration of accepted field/value | 15-2-2017 (3.17.4) |