Ft_score – Kofax DM API User Manual

Page 399

Advertising
background image

DM API T

OKENS

379

%FT_SCORE

%FT_SCORE

This token is used when a full text search is performed. It expresses the
relevance of the search criteria to the document. The relevance score is
expressed as a percentage.

Syntax

PCDSearch.AddReturnProperty(“%FT_SCORE”)

Parameters

Example

'Create a search object.

Set pClient = CreateObject("PCDClient.PCDSearch.1")


'Return a percentage-based relevance score.

pClient.AddReturnProperty("%FT_SCORE")


Execute the search.

pClient.Execute()


'Create a variable to hold the retrieved search value.

Dim vValue As Variant


'Retrieve the data.

vValue = pClient.GetPropertyValue(“%FT_SCORE”)


'Process the data.

Related Items

See the

PCDSearch

object.

See the

AddReturnProperty

method.

See the following tokens:

%FT_CONFIDENCE

%FT_FORMAT

%FT_SCORE

This token returns the relevance score
of the search results as a percentage
value.

Advertising