Score_percent – Kofax DM API User Manual

Page 487

Advertising
background image

DM API T

OKENS

467

%SCORE_PERCENT

%SCORE_PERCENT

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(“%SCORE_PERCENT”)

Parameters

Example

'Create a search object.

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


'Return the search relevance as a percentage.

pClient.AddReturnProperty("%SCORE_PERCENT")


'Execute the search.

pClient.Execute()


'Create a variable to hold the retrieved search value.

Dim vValue As Variant


'Retrieve the data.

Set vValue = pClient.GetPropertyValue(“%SCORE_PERCENT”)


'Process the data.

Related Items

See the

PCDSearch

object.

See the

AddReturnProperty

method.

See the following tokens:

%FT_CONFIDENCE

%FT_FORMAT

%FT_MARKER_LIST

%SCORE_PERCENT

Express the relevance value returned by
the search process as a percent.

Advertising