com.textkernel.tx.models.api.bimetricscoring

Class BimetricScoreResult

java.lang.Object

com.textkernel.tx.models.api.bimetricscoring.BimetricScoreResult

public class BimetricScoreResult
extends Object

And individual result (representing a single document) for a 'BimetricScore' request

Field Summary

Fields

Modifier and Type	Field and Description
EnrichedScoreData	EnrichedRCSScoreData Detailed information/evidence about the ReverseCompatibilityScore
EnrichedScoreData	EnrichedScoreData Detailed information/evidence about the WeightedScore
String	Id The document id of the result
int	ReverseCompatibilityScore An integer score from 0-100 which represents how well the target document matched to the source document.
int	SovScore An integer score representing the overall fit of the match.
int	WeightedScore An integer score from 0-100 representing how well the current document matched the source document.

Constructor Summary

Constructors

Constructor and Description
BimetricScoreResult()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Id

public String Id

The document id of the result

SovScore

public int SovScore

An integer score representing the overall fit of the match. This is the result of a proprietary algorithm that combines the WeightedScore and the ReverseCompatibilityScore into one overall score. Results are sorted by this parameter in descending order.

WeightedScore

public int WeightedScore

An integer score from 0-100 representing how well the current document matched the source document. This calculation is the sum of the unweighted category scores multiplied by their respective applied weight. A score of 100 means that all of the data points in the source document were found in the target document, but the target document may have had many extra data points.

See also:

• CategoryScoreData.UnweightedScore
• BaseScoredResponseValue.AppliedCategoryWeights

ReverseCompatibilityScore

public int ReverseCompatibilityScore

An integer score from 0-100 which represents how well the target document matched to the source document. This is equivalent to the WeightedScore if you ran the match/score with the source and target documents swapped. A score of 100 means that all of the data points in the target document were found in the source document, but the source document may have had many extra data points.

EnrichedScoreData

public EnrichedScoreData EnrichedScoreData

Detailed information/evidence about the WeightedScore

EnrichedRCSScoreData

public EnrichedScoreData EnrichedRCSScoreData

Detailed information/evidence about the ReverseCompatibilityScore

Constructor Detail

BimetricScoreResult

public BimetricScoreResult()