Skip to main content

resources/segments/finder/memories/search/multi

Returns the translation finder details for multiple texts.

URL

(POST) /resources/segments/finder/memories/search/multi

PARAMETERS

The message body contains a JSON object:

scope

The scope object. It delimits the total range of segments and related resources that can be operated on.

Mandatory, object

txts

An array of text records to search. See below for details

You can submit up to 100 texts.

Mandatory, object[]

src

The source language code.

Mandatory, string

trg

The target language code.

Mandatory, string

sim

Optional. Similarity threshold between 60 and 100. If not specified, the threshold is set to 80.

Optional, int?

maxhits

Maximum number of hits to return. The default is 10. Must be a value between 1 and 30.

Optional, int?

tmhits

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.

CODE
"tmhits": {
	"filter": [
   		{ "field": "st", "values": [ 1 ] },
   		{ "field": "bk", "values": [ 1, 2 ] }
	],
	"ctxboost": null
}

Read details here:

TM Filters and Sort (Object)

Optional,

object?

Each text to search has these properties:

txt

The text to search.

Mandatory, string

id

Optional identifier, will be included in the results for your reference.

Optional, string

hprev

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, int?

hnext

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, int?

ctx

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.

Optional, string?

RESULTS

Returns an array with exactly one element per text to search.

Example:

CODE
[
    {
        "id": "100",
        "txt": "The data contained a software string in it",
        "hits": [ ... ]
    },
    {
        "id": "102",
        "txt": "Welcome home.",
        "hits": [ ... ]
    }    
]

Each element contains the id and the text that you had included in your texts to search.

The hits array includes all memory and term base hits. It is documented here: resources/segments/finder/memories/search

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.