TM Filters and Sort (Object)

Optional. Specifies to what extent a matching context promotes a hit in the search results.

• 0: Disabled. The search results disregard whether the context matches or not.
• 1: Minimal promotion. Makes sure that the top results contain good hits that also match the context
• ...
• 5: Maximal promotion. This will give high importance to hits with the same context, even if text similarity is not so high.

With this setting you can give additional boost to hits that have the same context value as the segment being searched. The context of a segment typically contains formatting information such as "Heading 1", "Hyperlink" etc. or, when localizing software, string IDs or keys. Specifically with software localization this setting should be increased.

"ctxboost": 1

Optional array of filters on various properties such as status, bookmarks, context, change date and so on. Example:

"filters": [
   { "field": "st", "values": [ 1 ] },
   { "field": "bk", "values": [ 1, 2 ] }
]

See below.

To filter by status of the source text or translation.

The mandatory values property is an array of statuses:

• 0: No status (gray)
• 1: Approved (green)
• 2: Contains an error (red)

The optional language property can have these values:

• src: Apply filter on the source language(s)
• trg: Apply filter on the target language(s)
• Other/Empty: Uses trg by default

Example:

{
   "field": "st",
   "values": [ 0, 1 ],
   "language": "trg"
}

To filter by bookmark of the source text or translation.

The mandatory values property is an array of bookmarks:

• 0: No bookmark
• 1: Blue bookmark
• 2: Red bookmark

The optional language property can have these values:

• src: Apply filter on the source language(s)
• trg: Apply filter on the target language(s)
• Other/Empty: Uses trg by default

{
   "field": "bk",
   "values": [ 0, 1 ]
}

To filter by the context of a segment.

The mandatory values property is a list of strings to match. The filter is case sensitive.

The optional mode property permits values infix and prefix. By default prefix is used. Example for matching hits with context containing either "alpha" or "beta".

{
   "field": "ctx",
   "values": [ "alpha", "beta" ],
   "mode": "infix"
}

The optional not filter permits to find all segments that do not have any of the specified contexts:

{
   "field": "ctx",
   "not": true,
   "values": [ "alpha", "beta" ],
   "mode": "prefix"
}

NOT IMPLEMENTED

Optional list of labels to match.

The id is the label's unique ID. The values property contains zero, one or more label values.

If the values array is empty then the search returns hits without any label value set only.

The optional language property can have these values:

• src: Apply filter on the source language(s)
• trg: Apply filter on the target language(s)
• Other/Empty: Uses trg by default

{
   "field": "lbls",
   "language": "src"
   "values": [ { "id": 2, "values": [ 10, 11 ] }, { "id": 3, "values": [ 0 ] } ]
}

To filter by last change date of source text or translation.

The optional gte (edit at or after date) and lt (edit before date) permit to delimit the wanted date of change. Dates must be ISO formatted:

{
   "field": "usdt",
   "language": "src"
   "gte": "2016-10-21T10:00:00Z",
   "lt": "2018-10-21T10:00:00Z"
}

The optional language property can have these values:

• src: Apply filter on the source language(s)
• trg: Apply filter on the target language(s)
• Other/Empty: Uses trg by default

To filter by the last editor of the source text or translation: Human edit, Pre-translation, Machine translation etc.

The mandatory values property is a list of last editor values. See Last Editor (Enumeration)

{
   "field": "ed",
   "values": [ 0, 1, 2 ]
}

The optional language property can have these values:

• src: Apply filter on the source language(s)
• trg: Apply filter on the target language(s)
• Other/Empty: Uses trg by default