com.textkernel.tx.models.api.matching.response.MatchResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tx-java Show documentation

The official Java SDK for the Textkernel Tx v10 API.

The newest version!

// Copyright © 2023 Textkernel BV. All rights reserved.
// This file is provided for use by, or on behalf of, Textkernel licensees
// within the terms of their license of Textkernel products or Textkernel customers
// within the Terms of Service pertaining to the Textkernel SaaS products.

package com.textkernel.tx.models.api.matching.response;

import com.textkernel.tx.models.api.matching.BaseScoredResponseValue;

/**
* A single result containing information about the bimetric score between a target and source document
*/
public class MatchResult extends SearchResult {
    
    /**
     * An integer score representing the overall fit of the match.
     * This is the result of a proprietary algorithm that combines the
     * {@link #WeightedScore} and the {@link #ReverseCompatibilityScore} 
     * into one overall score. Results are sorted by this parameter in descending order.
    */
    public int SovScore;
    
    /**
     * 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:

     * {@link CategoryScoreData#UnweightedScore}
     *  {@link BaseScoredResponseValue#AppliedCategoryWeights}
     * 
    */
    public int WeightedScore;
    
    /**
     * An integer score from 0-100 which represents how well the target document matched to the source document.
     * This is equivalent to the {@link #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.
    */
    public int ReverseCompatibilityScore;
    
    /** Detailed information/evidence about the {@link #WeightedScore}*/
    public EnrichedScoreData EnrichedScoreData;
    
    /** Detailed information/evidence about the {@link #ReverseCompatibilityScore} */
    public EnrichedScoreData EnrichedRCSScoreData;
}