com.textkernel.tx.models.api.bimetricscoring

Class BimetricScoreRequest

java.lang.Object

com.textkernel.tx.models.api.bimetricscoring.BimetricScoreRequest

Direct Known Subclasses:

BimetricScoreJobRequest, BimetricScoreResumeRequest

public class BimetricScoreRequest
extends Object

Request body for a 'BimetricScore' request

Field Summary

Fields

Modifier and Type	Field and Description
CategoryWeights	PreferredCategoryWeights The weights you want to use for scoring.
SearchMatchSettings	Settings The settings to use during scoring calculations
List<ParsedJobWithId>	TargetJobs A list of parsed jobs containing the document name/identifier and the parsed job data.
List<ParsedResumeWithId>	TargetResumes A list of parsed resumes containing the document name/identifier and the parsed resume data.

Constructor Summary

Constructors

Constructor and Description
BimetricScoreRequest()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

Settings

public SearchMatchSettings Settings

The settings to use during scoring calculations

PreferredCategoryWeights

public CategoryWeights PreferredCategoryWeights

The weights you want to use for scoring. It is important to specify these, otherwise default values will be used.

These weights will be used except in the case that you provided a non-zero weight for a category that is irrelevant in the source document. For example, this can happen when the source document contains no languages.

See also: BaseScoredResponseValue.AppliedCategoryWeights

TargetResumes

public List<ParsedResumeWithId> TargetResumes

A list of parsed resumes containing the document name/identifier and the parsed resume data. NOTE: you can only use either this property to score resumes, or TargetJobs to score jobs, but not both

TargetJobs

public List<ParsedJobWithId> TargetJobs

A list of parsed jobs containing the document name/identifier and the parsed job data. NOTE: you can only use either this property to score jobs, or TargetResumes to score resumes, but not both

Constructor Detail

BimetricScoreRequest

public BimetricScoreRequest()