Score a Set of Documents🔗︎

HTTP Verb	Path
POST	/v9/scorer/bimetric

Score a parsed resume/job to a group of resumes/jobs that aren't indexed. It's highly recommended to index all of your documents and leverage the speed and power of the Search & Match Engine and use one of the Search & Match endpoints. This will also reduce your overall cost as the bimetric scoring is a higher charge per transaction.

Info

You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center | AU Data Center )

Request Body🔗︎

SourceDocument 🔗︎ object required

SourceDocument🔗︎

Parsed document to match against each of the target documents.

SourceDocument properties

Id 🔗︎ string required

Id🔗︎

Id of the source document. This isn't used in any calculation, only to assist in displaying output.

FileText 🔗︎ string required

FileText🔗︎

Parsed JSON from the Textkernel Resume or Job Parser.

TargetDocuments 🔗︎ object[] required

TargetDocuments🔗︎

Array of parsed documents to be matched against the source document.

TargetDocuments properties

Id 🔗︎ string required

Id🔗︎

Id of the target document. This isn't used in any calculation, only to assist in displaying output.

FileText 🔗︎ string required

FileText🔗︎

Parsed JSON from the Textkernel Resume or Job Parser

Settings 🔗︎ object

Settings🔗︎

Options to control variations of job titles.

Settings properties

PositionTitlesMustHaveAnExactMatch 🔗︎ bool

PositionTitlesMustHaveAnExactMatch🔗︎

Set to true to turn off variation matches in job titles.

PositionTitlesIgnoreSingleWordVariations 🔗︎ bool

PositionTitlesIgnoreSingleWordVariations🔗︎

Set to true to ignore single-word variations of multi-word job titles.

CategoryWeights 🔗︎ object[]

CategoryWeights🔗︎

List of categories with weights that determine how the WeightedScore is calculated. It's important to specify these before the match so the query returns the top results using these weights. Only the categories included in this list will be used to calculate the WeightedScore.

CategoryWeights properties

Category 🔗︎ string

Category🔗︎

The name of the category. One of:

EDUCATION
JOB_TITLES
SKILLS
INDUSTRIES
LANGUAGES
CERTIFICATIONS
EXECUTIVE_TYPE
MANAGEMENT_LEVEL

Weight 🔗︎ decimal

Weight🔗︎

The weight of the category relative to other categories. It's recommended for the specified categories to add up to 1, so it's obvious how the percentages are applied.

Sample JSON

{
  "SourceDocument": {
    "Id": "",
    "FileText": ""
  },
  "TargetDocuments": [
    {
      "Id": "",
      "FileText": ""
    }
  ],
  "Settings": {
    "PositionTitlesMustHaveAnExactMatch": false,
    "PositionTitlesIgnoreSingleWordVariations": false
  },
  "CategoryWeights": [
    {
      "Category": "",
      "Weight": 0
    }
  ]
}

Response Body🔗︎

Info 🔗︎ object

Info🔗︎

Information explaining the outcome of the transaction.

Info properties

Code 🔗︎ object[]

Code🔗︎

Code	Description
`Success`	Successful transaction
`MissingParameter`	A required parameter wasn't provided
`InvalidParameter`	A parameter was incorrectly specified
`AuthenticationError`	An error occurred with the credentials provided

Message 🔗︎ object[]

Message🔗︎

This message further describes the code providing additional detail.

Value 🔗︎ object

Value🔗︎

Contains response data for the transaction.

Value properties

Matches 🔗︎ object[]

Matches🔗︎

An object[] containing the results for each match result.

Matches properties

Id 🔗︎ string

Id🔗︎

Id of the matched document in the index.

SovScore 🔗︎ integer

SovScore🔗︎

An integer score from 0-100 representing the overall fit of the match. Results are sorted by this parameter in descending order.

EnrichedScoreData 🔗︎ object

EnrichedScoreData🔗︎

Detailed information about the source to target match.

EnrichedScoreData properties

Languages 🔗︎ object

Languages🔗︎

Detailed match information for the Languages category.

Languages properties

UnweightedScore 🔗︎ double

UnweightedScore🔗︎

An unweighted score from 0-100. This is the percentage match of the specified category.

Evidence 🔗︎ object[]

Evidence🔗︎

Detailed written explanation about each data point found or not found.

Evidence properties

Fact 🔗︎ string

Fact🔗︎

Information regarding the outcome of one or more of the data points in the query.

Type 🔗︎ string

Type🔗︎

Type of evidence message. Possible values include:

Negative
Mixed
Positive

Found 🔗︎ string[]

Found🔗︎

Array of terms found in both documents.

NotFound 🔗︎ string[]

NotFound🔗︎

Array of terms requested, but not found.

Certifications 🔗︎ object

Certifications🔗︎

Detailed match information for the Certifications category.

Certifications properties

UnweightedScore 🔗︎ double

UnweightedScore🔗︎

An unweighted score from 0-100. This is the percentage match of the specified category.

Evidence 🔗︎ object[]

Evidence🔗︎

Detailed written explanation about each data point found or not found.

Evidence properties

Fact 🔗︎ string

Fact🔗︎

Information regarding the outcome of one or more of the data points in the query.

Type 🔗︎ string

Type🔗︎

Type of evidence message. Possible values include:

Negative
Mixed
Positive

Found 🔗︎ string[]

Found🔗︎

Array of terms found in both documents.

NotFound 🔗︎ string[]

NotFound🔗︎

Array of terms requested, but not found.

ExecutiveType 🔗︎ object

ExecutiveType🔗︎

Detailed match information for the ExecutiveType category.

ExecutiveType properties

UnweightedScore 🔗︎ double

UnweightedScore🔗︎

An unweighted score from 0-100. This is the percentage match of the specified category.

Evidence 🔗︎ object[]

Evidence🔗︎

Detailed written explanation about each data point found or not found.

Evidence properties

Fact 🔗︎ string

Fact🔗︎

Information regarding the outcome of one or more of the data points in the query.

Type 🔗︎ string

Type🔗︎

Type of evidence message. Possible values include:

Negative
Mixed
Positive

Found 🔗︎ string[]

Found🔗︎

Array of terms found in both documents.

NotFound 🔗︎ string[]

NotFound🔗︎

Array of terms requested, but not found.

Education 🔗︎ object

Education🔗︎

Detailed match information for the Eduction category.

Education properties

UnweightedScore 🔗︎ double

UnweightedScore🔗︎

An unweighted score from 0-100. This is the percentage match of the specified category.

Evidence 🔗︎ object[]

Evidence🔗︎

Detailed written explanation about each data point found or not found.

Evidence properties

Fact 🔗︎ string

Fact🔗︎

Information regarding the outcome of one or more of the data points in the query.

Type 🔗︎ string

Type🔗︎

Type of evidence message. Possible values include:

Negative
Mixed
Positive

ExpectedEducation 🔗︎ string

ExpectedEducation🔗︎

Requested level of education.

ActualEducation 🔗︎ string

ActualEducation🔗︎

Actual level of education found.

Comparison 🔗︎ string

Comparison🔗︎

Description of the relationship of ExpectedEducation and ActualEducation. This provides an easier value to key off of. Possible values are:

DoesNotMeetExpected
MeetsExpected
ExceedsExpected

Taxonomies 🔗︎ object

Taxonomies🔗︎

Detailed match information for the Taxonomies category.

Taxonomies properties

UnweightedScore 🔗︎ double

UnweightedScore🔗︎

An unweighted score from 0-100. This is the percentage match of the specified category.

Evidence 🔗︎ object[]

Evidence🔗︎

Detailed written explanation about each data point found or not found.

Evidence properties

Fact 🔗︎ string

Fact🔗︎

Information regarding the outcome of one or more of the data points in the query.

Type 🔗︎ string

Type🔗︎

Type of evidence message. Possible values include:

Negative
Mixed
Positive

ActualTaxonomies 🔗︎ object

ActualTaxonomies🔗︎

Taxonomies found.

ActualTaxonomies properties

Primary 🔗︎ object

Primary🔗︎

Best fit taxonomy evidence.

Primary properties

Taxonomy 🔗︎ object

Taxonomy🔗︎

Best fit parent taxonomy.

Taxonomy properties

Name 🔗︎ string

Name🔗︎

Taxonomy name.

Id 🔗︎ string

Id🔗︎

Taxonomy id.

Matched 🔗︎ bool

Matched🔗︎

True when this parent taxonomy value is found in both documents.

Subtaxonomy 🔗︎ object

Subtaxonomy🔗︎

Best fit sub-taxonomy

Subtaxonomy properties

Name 🔗︎ string

Name🔗︎

Taxonomy name.

Id 🔗︎ string

Id🔗︎

Taxonomy id.

Matched 🔗︎ bool

Matched🔗︎

True when this sub taxonomy value is found in both documents.

Secondary 🔗︎ object

Secondary🔗︎

Second best fit taxonomy evidence.

Secondary properties

Taxonomy 🔗︎ object

Taxonomy🔗︎

Second best fit parent taxonomy.

Taxonomy properties

Name 🔗︎ string

Name🔗︎

Taxonomy name.

Id 🔗︎ string

Id🔗︎

Taxonomy id.

Matched 🔗︎ bool

Matched🔗︎

True when this parent taxonomy value is found in both documents.

Subtaxonomy 🔗︎ object

Subtaxonomy🔗︎

Second best fit sub-taxonomy.

Subtaxonomy properties

Name 🔗︎ string

Name🔗︎

Taxonomy name.

Id 🔗︎ string

Id🔗︎

Taxonomy id.

Matched 🔗︎ bool

Matched🔗︎

True when this sub taxonomy value is found in both documents.

DesiredTaxonomies 🔗︎ object

DesiredTaxonomies🔗︎

Taxonomies requested.

DesiredTaxonomies properties

Primary 🔗︎ object

Primary🔗︎

Best fit taxonomy evidence.

Primary properties

Taxonomy 🔗︎ object

Taxonomy🔗︎

Best fit parent taxonomy.

Taxonomy properties

Name 🔗︎ string

Name🔗︎

Taxonomy name.

Id 🔗︎ string

Id🔗︎

Taxonomy id.

Matched 🔗︎ bool

Matched🔗︎

True when this parent taxonomy value is found in both documents.

Subtaxonomy 🔗︎ object

Subtaxonomy🔗︎

Best fit sub-taxonomy

Subtaxonomy properties

Name 🔗︎ string

Name🔗︎

Taxonomy name.

Id 🔗︎ string

Id🔗︎

Taxonomy id.

Matched 🔗︎ bool

Matched🔗︎

True when this sub taxonomy value is found in both documents.

Secondary 🔗︎ object

Secondary🔗︎

Second best fit taxonomy evidence.

Secondary properties

Taxonomy 🔗︎ object

Taxonomy🔗︎

Second best fit parent taxonomy.

Taxonomy properties

Name 🔗︎ string

Name🔗︎

Taxonomy name.

Id 🔗︎ string

Id🔗︎

Taxonomy id.

Matched 🔗︎ bool

Matched🔗︎

True when this parent taxonomy value is found in both documents.

Subtaxonomy 🔗︎ object

Subtaxonomy🔗︎

Second best fit sub-taxonomy.

Subtaxonomy properties

Name 🔗︎ string

Name🔗︎

Taxonomy name.

Id 🔗︎ string

Id🔗︎

Taxonomy id.

Matched 🔗︎ bool

Matched🔗︎

True when this sub taxonomy value is found in both documents.

JobTitles 🔗︎ object

JobTitles🔗︎

Detailed match information for the JobTitles category.

JobTitles properties

UnweightedScore 🔗︎ double

UnweightedScore🔗︎

An unweighted score from 0-100. This is the percentage match of the specified category.

Evidence 🔗︎ object[]

Evidence🔗︎

Detailed written explanation about each data point found or not found.

Evidence properties

Fact 🔗︎ string

Fact🔗︎

Information regarding the outcome of one or more of the data points in the query.

Type 🔗︎ string

Type🔗︎

Type of evidence message. Possible values include:

Negative
Mixed
Positive

Found 🔗︎ string[]

Found🔗︎

Array of Job Titles found in both documents.

Found properties

RawTerm 🔗︎ string

RawTerm🔗︎

Exact term found.

VariationOf 🔗︎ string

VariationOf🔗︎

Original term that the variation was derived from.

IsCurrent 🔗︎ bool

IsCurrent🔗︎

True when the Job Title found is in the current time-frame.

NotFound 🔗︎ string[]

NotFound🔗︎

Array of terms requested, but not found.

Skills 🔗︎ object

Skills🔗︎

Detailed match information for the Skills category.

Skills properties

UnweightedScore 🔗︎ double

UnweightedScore🔗︎

An unweighted score from 0-100. This is the percentage match of the specified category.

Evidence 🔗︎ object[]

Evidence🔗︎

Detailed written explanation about each data point found or not found.

Evidence properties

Fact 🔗︎ string

Fact🔗︎

Information regarding the outcome of one or more of the data points in the query.

Type 🔗︎ string

Type🔗︎

Type of evidence message. Possible values include:

Negative
Mixed
Positive

Found 🔗︎ string[]

Found🔗︎

Array of Skills found in both documents.

Found properties

Skill 🔗︎ string

Skill🔗︎

Name of the skill.

IsCurrent 🔗︎ bool

IsCurrent🔗︎

True when the skill is found in the current time-frame.

NotFound 🔗︎ string[]

NotFound🔗︎

Array of terms requested, but not found.

ManagementLevel 🔗︎ object

ManagementLevel🔗︎

Detailed match information for the ManagementLevel category.

ManagementLevel properties

UnweightedScore 🔗︎ double

UnweightedScore🔗︎

An unweighted score from 0-100. This is the percentage match of the specified category.

Evidence 🔗︎ object[]

Evidence🔗︎

Detailed written explanation about each data point found or not found.

Evidence properties

Fact 🔗︎ string

Fact🔗︎

Information regarding the outcome of one or more of the data points in the query.

Type 🔗︎ string

Type🔗︎

Type of evidence message. Possible values include:

Negative
Mixed
Positive

Actual 🔗︎ string

Actual🔗︎

Actual management level found.

Desired 🔗︎ string

Desired🔗︎

Requested management level.

AmountOfExperienceMatches 🔗︎ bool

AmountOfExperienceMatches🔗︎

True when the duration of management level matches in the two documents.

EnrichedRCSScoreData 🔗︎ object

EnrichedRCSScoreData🔗︎

Detailed information about the target to source match.

EnrichedRCSScoreData properties

Languages 🔗︎ object

Languages🔗︎

Detailed match information for the Languages category.

Languages properties

UnweightedScore 🔗︎ double

UnweightedScore🔗︎

An unweighted score from 0-100. This is the percentage match of the specified category.

Evidence 🔗︎ object[]

Evidence🔗︎

Detailed written explanation about each data point found or not found.

Evidence properties

Fact 🔗︎ string

Fact🔗︎

Information regarding the outcome of one or more of the data points in the query.

Type 🔗︎ string

Type🔗︎

Type of evidence message. Possible values include:

Negative
Mixed
Positive

Found 🔗︎ string[]

Found🔗︎

Array of terms found in both documents.

NotFound 🔗︎ string[]

NotFound🔗︎

Array of terms requested, but not found.

Certifications 🔗︎ object

Certifications🔗︎

Detailed match information for the Certifications category.

Certifications properties

UnweightedScore 🔗︎ double

UnweightedScore🔗︎

An unweighted score from 0-100. This is the percentage match of the specified category.

Evidence 🔗︎ object[]

Evidence🔗︎

Detailed written explanation about each data point found or not found.

Evidence properties

Fact 🔗︎ string

Fact🔗︎

Information regarding the outcome of one or more of the data points in the query.

Type 🔗︎ string

Type🔗︎

Type of evidence message. Possible values include:

Negative
Mixed
Positive

Found 🔗︎ string[]

Found🔗︎

Array of terms found in both documents.

NotFound 🔗︎ string[]

NotFound🔗︎

Array of terms requested, but not found.

ExecutiveType 🔗︎ object

ExecutiveType🔗︎

Detailed match information for the ExecutiveType category.

ExecutiveType properties

UnweightedScore 🔗︎ double

UnweightedScore🔗︎

An unweighted score from 0-100. This is the percentage match of the specified category.

Evidence 🔗︎ object[]

Evidence🔗︎

Detailed written explanation about each data point found or not found.

Evidence properties

Fact 🔗︎ string

Fact🔗︎

Information regarding the outcome of one or more of the data points in the query.

Type 🔗︎ string

Type🔗︎

Type of evidence message. Possible values include:

Negative
Mixed
Positive

Found 🔗︎ string[]

Found🔗︎

Array of terms found in both documents.

NotFound 🔗︎ string[]

NotFound🔗︎

Array of terms requested, but not found.

Education 🔗︎ object

Education🔗︎

Detailed match information for the Eduction category.

Education properties

UnweightedScore 🔗︎ double

UnweightedScore🔗︎

An unweighted score from 0-100. This is the percentage match of the specified category.

Evidence 🔗︎ object[]

Evidence🔗︎

Detailed written explanation about each data point found or not found.

Evidence properties

Fact 🔗︎ string

Fact🔗︎

Information regarding the outcome of one or more of the data points in the query.

Type 🔗︎ string

Type🔗︎

Type of evidence message. Possible values include:

Negative
Mixed
Positive

ExpectedEducation 🔗︎ string

ExpectedEducation🔗︎

Requested level of education.

ActualEducation 🔗︎ string

ActualEducation🔗︎

Actual level of education found.

Comparison 🔗︎ string

Comparison🔗︎

Description of the relationship of ExpectedEducation and ActualEducation. This provides an easier value to key off of. Possible values are:

DoesNotMeetExpected
MeetsExpected
ExceedsExpected

Taxonomies 🔗︎ object

Taxonomies🔗︎

Detailed match information for the Taxonomies category.

Taxonomies properties

UnweightedScore 🔗︎ double

UnweightedScore🔗︎

An unweighted score from 0-100. This is the percentage match of the specified category.

Evidence 🔗︎ object[]

Evidence🔗︎

Detailed written explanation about each data point found or not found.

Evidence properties

Fact 🔗︎ string

Fact🔗︎

Information regarding the outcome of one or more of the data points in the query.

Type 🔗︎ string

Type🔗︎

Type of evidence message. Possible values include:

Negative
Mixed
Positive

ActualTaxonomies 🔗︎ object

ActualTaxonomies🔗︎

Taxonomies found.

ActualTaxonomies properties

Primary 🔗︎ object

Primary🔗︎

Best fit taxonomy evidence.

Primary properties

Taxonomy 🔗︎ object

Taxonomy🔗︎

Best fit parent taxonomy.

Taxonomy properties

Name 🔗︎ string

Name🔗︎

Taxonomy name.

Id 🔗︎ string

Id🔗︎

Taxonomy id.

Matched 🔗︎ bool

Matched🔗︎

True when this parent taxonomy value is found in both documents.

Subtaxonomy 🔗︎ object

Subtaxonomy🔗︎

Best fit sub-taxonomy

Subtaxonomy properties

Name 🔗︎ string

Name🔗︎

Taxonomy name.

Id 🔗︎ string

Id🔗︎

Taxonomy id.

Matched 🔗︎ bool

Matched🔗︎

True when this sub taxonomy value is found in both documents.

Secondary 🔗︎ object

Secondary🔗︎

Second best fit taxonomy evidence.

Secondary properties

Taxonomy 🔗︎ object

Taxonomy🔗︎

Second best fit parent taxonomy.

Taxonomy properties

Name 🔗︎ string

Name🔗︎

Taxonomy name.

Id 🔗︎ string

Id🔗︎

Taxonomy id.

Matched 🔗︎ bool

Matched🔗︎

True when this parent taxonomy value is found in both documents.

Subtaxonomy 🔗︎ object

Subtaxonomy🔗︎

Second best fit sub-taxonomy.

Subtaxonomy properties

Name 🔗︎ string

Name🔗︎

Taxonomy name.

Id 🔗︎ string

Id🔗︎

Taxonomy id.

Matched 🔗︎ bool

Matched🔗︎

True when this sub taxonomy value is found in both documents.

DesiredTaxonomies 🔗︎ object

DesiredTaxonomies🔗︎

Taxonomies requested.

DesiredTaxonomies properties

Primary 🔗︎ object

Primary🔗︎

Best fit taxonomy evidence.

Primary properties

Taxonomy 🔗︎ object

Taxonomy🔗︎

Best fit parent taxonomy.

Taxonomy properties

Name 🔗︎ string

Name🔗︎

Taxonomy name.

Id 🔗︎ string

Id🔗︎

Taxonomy id.

Matched 🔗︎ bool

Matched🔗︎

True when this parent taxonomy value is found in both documents.

Subtaxonomy 🔗︎ object

Subtaxonomy🔗︎

Best fit sub-taxonomy

Subtaxonomy properties

Name 🔗︎ string

Name🔗︎

Taxonomy name.

Id 🔗︎ string

Id🔗︎

Taxonomy id.

Matched 🔗︎ bool

Matched🔗︎

True when this sub taxonomy value is found in both documents.

Secondary 🔗︎ object

Secondary🔗︎

Second best fit taxonomy evidence.

Secondary properties

Taxonomy 🔗︎ object

Taxonomy🔗︎

Second best fit parent taxonomy.

Taxonomy properties

Name 🔗︎ string

Name🔗︎

Taxonomy name.

Id 🔗︎ string

Id🔗︎

Taxonomy id.

Matched 🔗︎ bool

Matched🔗︎

True when this parent taxonomy value is found in both documents.

Subtaxonomy 🔗︎ object

Subtaxonomy🔗︎

Second best fit sub-taxonomy.

Subtaxonomy properties

Name 🔗︎ string

Name🔗︎

Taxonomy name.

Id 🔗︎ string

Id🔗︎

Taxonomy id.

Matched 🔗︎ bool

Matched🔗︎

True when this sub taxonomy value is found in both documents.

JobTitles 🔗︎ object

JobTitles🔗︎

Detailed match information for the JobTitles category.

JobTitles properties

UnweightedScore 🔗︎ double

UnweightedScore🔗︎

An unweighted score from 0-100. This is the percentage match of the specified category.

Evidence 🔗︎ object[]

Evidence🔗︎

Detailed written explanation about each data point found or not found.

Evidence properties

Fact 🔗︎ string

Fact🔗︎

Information regarding the outcome of one or more of the data points in the query.

Type 🔗︎ string

Type🔗︎

Type of evidence message. Possible values include:

Negative
Mixed
Positive

Found 🔗︎ string[]

Found🔗︎

Array of Job Titles found in both documents.

Found properties

RawTerm 🔗︎ string

RawTerm🔗︎

Exact term found.

VariationOf 🔗︎ string

VariationOf🔗︎

Original term that the variation was derived from.

IsCurrent 🔗︎ bool

IsCurrent🔗︎

True when the Job Title found is in the current time-frame.

NotFound 🔗︎ string[]

NotFound🔗︎

Array of terms requested, but not found.

Skills 🔗︎ object

Skills🔗︎

Detailed match information for the Skills category.

Skills properties

UnweightedScore 🔗︎ double

UnweightedScore🔗︎

An unweighted score from 0-100. This is the percentage match of the specified category.

Evidence 🔗︎ object[]

Evidence🔗︎

Detailed written explanation about each data point found or not found.

Evidence properties

Fact 🔗︎ string

Fact🔗︎

Information regarding the outcome of one or more of the data points in the query.

Type 🔗︎ string

Type🔗︎

Type of evidence message. Possible values include:

Negative
Mixed
Positive

Found 🔗︎ string[]

Found🔗︎

Array of Skills found in both documents.

Found properties

Skill 🔗︎ string

Skill🔗︎

Name of the skill.

IsCurrent 🔗︎ bool

IsCurrent🔗︎

True when the skill is found in the current time-frame.

NotFound 🔗︎ string[]

NotFound🔗︎

Array of terms requested, but not found.

ManagementLevel 🔗︎ object

ManagementLevel🔗︎

Detailed match information for the ManagementLevel category.

ManagementLevel properties

UnweightedScore 🔗︎ double

UnweightedScore🔗︎

An unweighted score from 0-100. This is the percentage match of the specified category.

Evidence 🔗︎ object[]

Evidence🔗︎

Detailed written explanation about each data point found or not found.

Evidence properties

Fact 🔗︎ string

Fact🔗︎

Information regarding the outcome of one or more of the data points in the query.

Type 🔗︎ string

Type🔗︎

Type of evidence message. Possible values include:

Negative
Mixed
Positive

Actual 🔗︎ string

Actual🔗︎

Actual management level found.

Desired 🔗︎ string

Desired🔗︎

Requested management level.

AmountOfExperienceMatches 🔗︎ bool

AmountOfExperienceMatches🔗︎

True when the duration of management level matches in the two documents.

WeightedScore 🔗︎ integer

WeightedScore🔗︎

An integer score from 0-100 representing how well the source document matched the current document. This calculation is the sum of the unweighted category scores multiplied by their respective suggested weight.

UnweightedCategoryScores 🔗︎ object[] Deprecated

UnweightedCategoryScores🔗︎

Deprecated

UnweightedCategoryScores properties

Category 🔗︎ string Deprecated

Category🔗︎

Deprecated

UnweightedScore 🔗︎ decimal Deprecated

UnweightedScore🔗︎

Deprecated

TermsFound 🔗︎ string[] Deprecated

TermsFound🔗︎

Deprecated

ReverseCompatibilityScore 🔗︎ integer

ReverseCompatibilityScore🔗︎

An integer score from 0-100 which represents how well the target document matched to the source document. This isn't the same as WeightedScore because when doing the reverse calculation we are analyzing for all of the data from the target document to be found in the source document.

SuggestedCategoryWeights 🔗︎ object[]

SuggestedCategoryWeights🔗︎

An object[] containing our suggested weights for each category based on the source document.

SuggestedCategoryWeights properties

Category 🔗︎ string

Category🔗︎

Name of the category.

Weight 🔗︎ decimal

Weight🔗︎

A 0-100 weight of suggested importance for the speficied category. This is calculated from the data in the source document. A sum of all of the SuggestedCategoryWeights will equal 100.

AppliedCategoryWeights 🔗︎ object[]

AppliedCategoryWeights🔗︎

An object[] containing the weights that were used for each category based on a combination of the data in the source document and any desired weights passed in the request.

AppliedCategoryWeights properties

Category 🔗︎ string

Category🔗︎

Name of the category.

Weight 🔗︎ decimal

Weight🔗︎

A 0-100 weight of suggested importance for the speficied category. This is calculated from the data in the source document combined with any desired weights passed in the request. A sum of all of the AppliedCategoryWeights will equal 100.

CreditsRemaining 🔗︎ decimal

CreditsRemaining🔗︎

The number of remaining credits is returned with every response. Please ensure that you set up monitoring of this value to ensure that you don't experience an outage by letting your credits reach 0.

Sample JSON

{
  "Info": {
    "Code": "",
    "Message": ""
  },
  "Value": {
    "Matches": [
      {
        "Id": "",
        "SovScore": 0,
        "EnrichedScoreData": {
          "Languages": {
            "UnweightedScore": 0,
            "Found": [
              ""
            ],
            "NotFound": [
              ""
            ],
            "Evidence": [
              {
                "Fact": "",
                "Type": ""
              }
            ]
          },
          "Certifications": {
            "UnweightedScore": 0,
            "Found": [
              ""
            ],
            "NotFound": [
              ""
            ],
            "Evidence": [
              {
                "Fact": "",
                "Type": ""
              }
            ]
          },
          "ExecutiveType": {
            "UnweightedScore": 0,
            "Found": [
              ""
            ],
            "NotFound": [
              ""
            ],
            "Evidence": [
              {
                "Fact": "",
                "Type": ""
              }
            ]
          },
          "Education": {
            "UnweightedScore": 0,
            "ExpectedEducation": "",
            "ActualEducation": "",
            "Comparison": "",
            "Evidence": [
              {
                "Fact": "",
                "Type": ""
              }
            ]
          },
          "Taxonomies": {
            "UnweightedScore": 0,
            "Evidence": [
              {
                "Fact": "",
                "Type": ""
              }
            ],
            "ActualTaxonomies": {
              "Primary": {
                "Taxonomy": {
                  "Name": "",
                  "Id": "",
                  "Matched": false
                },
                "SubTaxnomy": {
                  "Name": "",
                  "Id": "",
                  "Matched": false
                }
              },
              "Secondary": {
                "Taxonomy": {
                  "Name": "",
                  "Id": "",
                  "Matched": false
                },
                "SubTaxnomy": {
                  "Name": "",
                  "Id": "",
                  "Matched": false
                }
              }
            },
            "DesiredTaxonomies": {
              "Primary": {
                "Taxonomy": {
                  "Name": "",
                  "Id": "",
                  "Matched": false
                },
                "SubTaxnomy": {
                  "Name": "",
                  "Id": "",
                  "Matched": false
                }
              },
              "Secondary": {
                "Taxonomy": {
                  "Name": "",
                  "Id": "",
                  "Matched": false
                },
                "SubTaxnomy": {
                  "Name": "",
                  "Id": "",
                  "Matched": false
                }
              }
            }
          },
          "JobTitles": {
            "UnweightedScore": 0,
            "Evidence": [
              {
                "Fact": "",
                "Type": ""
              }
            ],
            "Found": [
              {
                "RawTerm": "",
                "VariationOf": "",
                "IsCurrent": false
              }
            ],
            "NotFound": [
              ""
            ]
          },
          "Skills": {
            "UnweightedScore": 0,
            "Evidence": [
              {
                "Fact": "",
                "Type": ""
              }
            ],
            "Found": [
              {
                "Skill": "",
                "IsCurrent": false
              }
            ],
            "NotFound": [
              ""
            ]
          },
          "ManagementLevel": {
            "UnweightedScore": 0,
            "Evidence": [
              {
                "Fact": "",
                "Type": ""
              }
            ],
            "Actual": "",
            "Desired": "",
            "AmountOfExperienceMatches": false
          }
        },
        "EnrichedRCSScoreData": {
          "Languages": {
            "UnweightedScore": 0,
            "Found": [
              ""
            ],
            "NotFound": [
              ""
            ],
            "Evidence": [
              {
                "Fact": "",
                "Type": ""
              }
            ]
          },
          "Certifications": {
            "UnweightedScore": 0,
            "Found": [
              ""
            ],
            "NotFound": [
              ""
            ],
            "Evidence": [
              {
                "Fact": "",
                "Type": ""
              }
            ]
          },
          "ExecutiveType": {
            "UnweightedScore": 0,
            "Found": [
              ""
            ],
            "NotFound": [
              ""
            ],
            "Evidence": [
              {
                "Fact": "",
                "Type": ""
              }
            ]
          },
          "Education": {
            "UnweightedScore": 0,
            "ExpectedEducation": "",
            "ActualEducation": "",
            "Comparison": "",
            "Evidence": [
              {
                "Fact": "",
                "Type": ""
              }
            ]
          },
          "Taxonomies": {
            "UnweightedScore": 0,
            "Evidence": [
              {
                "Fact": "",
                "Type": ""
              }
            ],
            "ActualTaxonomies": {
              "Primary": {
                "Taxonomy": {
                  "Name": "",
                  "Id": "",
                  "Matched": false
                },
                "SubTaxnomy": {
                  "Name": "",
                  "Id": "",
                  "Matched": false
                }
              },
              "Secondary": {
                "Taxonomy": {
                  "Name": "",
                  "Id": "",
                  "Matched": false
                },
                "SubTaxnomy": {
                  "Name": "",
                  "Id": "",
                  "Matched": false
                }
              }
            },
            "DesiredTaxonomies": {
              "Primary": {
                "Taxonomy": {
                  "Name": "",
                  "Id": "",
                  "Matched": false
                },
                "SubTaxnomy": {
                  "Name": "",
                  "Id": "",
                  "Matched": false
                }
              },
              "Secondary": {
                "Taxonomy": {
                  "Name": "",
                  "Id": "",
                  "Matched": false
                },
                "SubTaxnomy": {
                  "Name": "",
                  "Id": "",
                  "Matched": false
                }
              }
            }
          },
          "JobTitles": {
            "UnweightedScore": 0,
            "Evidence": [
              {
                "Fact": "",
                "Type": ""
              }
            ],
            "Found": [
              {
                "RawTerm": "",
                "VariationOf": "",
                "IsCurrent": false
              }
            ],
            "NotFound": [
              ""
            ]
          },
          "Skills": {
            "UnweightedScore": 0,
            "Evidence": [
              {
                "Fact": "",
                "Type": ""
              }
            ],
            "Found": [
              {
                "Skill": "",
                "IsCurrent": false
              }
            ],
            "NotFound": [
              ""
            ]
          },
          "ManagementLevel": {
            "UnweightedScore": 0,
            "Evidence": [
              {
                "Fact": "",
                "Type": ""
              }
            ],
            "Actual": "",
            "Desired": "",
            "AmountOfExperienceMatches": false
          }
        },
        "WeightedScore": 0,
        "UnweightedCategoryScores": [
          {
            "Category": "",
            "UnweightedScore": 0,
            "TermsFound": [
              ""
            ]
          }
        ],
        "ReverseCompatibilityScore": 0
      }
    ],
    "SuggestedCategoryWeights": [
      {
        "Category": "",
        "Weight": 0
      }
    ],
    "AppliedCategoryWeights": [
      {
        "Category": "",
        "Weight": 0
      }
    ],
    "CreditsRemaining": 0
  }
}