Ft_confidence – Kofax DM API User Manual

Page 393

Advertising
background image

DM API T

OKENS

373

%FT_CONFIDENCE

%FT_CONFIDENCE

This token is used when a full text search is performed. It expresses the
relevance of a document returned by the search to the search criteria.
The relevance value is expressed as a value from 1 to 5, with 1
representing greater relevance and 5 representing lesser relevance.

Syntax

PCDSearch.AddReturnProperty(“%FT_CONFIDENCE”)

Parameters

Example

'Create a search object.

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


'Add the confidence.

pClient.AddReturnProperty("%FT_CONFIDENCE")


'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_CONFIDENCE”)


'Process the data.

Related Items

See the

PCDSearch

object.

See the

AddReturnProperty

method.

See the following tokens:

%FT_FORMAT

%FT_CONFIDENCE

The token identifier that indicates that a
relevance value is to be returned as part
of the search process.

Advertising