com.textkernel.tx.models.api.matching

Class BaseScoredResponseValue<T>

java.lang.Object

com.textkernel.tx.models.api.matching.BaseSearchMatchResponseValue<T>

com.textkernel.tx.models.api.matching.BaseScoredResponseValue<T>

Direct Known Subclasses:

BimetricScoreResponseValue, MatchResponseValue

public class BaseScoredResponseValue<T>
extends BaseSearchMatchResponseValue<T>

A base class for all scored responses

Field Summary

Fields

Modifier and Type	Field and Description
CategoryWeights	AppliedCategoryWeights The weights that were actually used for scoring.
CategoryWeights	SuggestedCategoryWeights The weights suggested based solely on the data in the source document.

Fields inherited from class com.textkernel.tx.models.api.matching.BaseSearchMatchResponseValue

CurrentCount, Matches, TotalCount

Constructor Summary

Constructors

Constructor and Description
BaseScoredResponseValue()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

SuggestedCategoryWeights

public CategoryWeights SuggestedCategoryWeights

The weights suggested based solely on the data in the source document.

NOTE: these should only be used as a fallback or initial value. Your system/users should have the ability to adjust/override these (in the PreferredCategoryWeights in the request)

See also:

• BimetricScoreRequest.PreferredCategoryWeights
• MatchRequest.PreferredCategoryWeights

AppliedCategoryWeights

public CategoryWeights AppliedCategoryWeights

The weights that were actually used for scoring. These are either:

1. if the PreferredCategoryWeights are specified in the request, these are used (with any adjustments for non-applicable categories)
2. otherwise these are simply the SuggestedCategoryWeights

See also:

• BimetricScoreRequest.PreferredCategoryWeights
• MatchRequest.PreferredCategoryWeights

Constructor Detail

BaseScoredResponseValue

public BaseScoredResponseValue()