Score Documents to a Resume🔗︎

HTTP Verb	Path
POST	/v10/scorer/bimetric/resume

Score a group of resumes/jobs (that aren't indexed) to a parsed resume. 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🔗︎

SourceResume 🔗︎ object required

SourceResume🔗︎

Parsed resume to match against each of the target documents.

SourceResume properties

Id 🔗︎ string required

Id🔗︎

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

ResumeData 🔗︎ object required

ResumeData🔗︎

Parsed ResumeData from the Textkernel CV/Resume Parser. See Parse a Resume

TargetJobs 🔗︎ object[]

TargetJobs🔗︎

Array of parsed jobs to be matched against the source resume.

TargetJobs properties

Id 🔗︎ string required

Id🔗︎

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

JobData 🔗︎ object required

JobData🔗︎

The parsed JobData from the Textkernel Job Parser. See Parse a Job

TargetResumes 🔗︎ object[]

TargetResumes🔗︎

Array of parsed resumes to be matched against the source resume.

TargetResumes properties

Id 🔗︎ string required

Id🔗︎

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

ResumeData 🔗︎ object required

ResumeData🔗︎

Parsed ResumeData from the Textkernel CV/Resume Parser. See Parse a Resume

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.

PreferredCategoryWeights 🔗︎ object

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.

PreferredCategoryWeights properties

Education 🔗︎ decimal

Education🔗︎

The weight of the Education category relative to other categories.

JobTitles 🔗︎ decimal

JobTitles🔗︎

The weight of the JobTitles category relative to other categories..

Skills 🔗︎ decimal

Skills🔗︎

The weight of the Skills category relative to other categories.

Industries 🔗︎ decimal

Industries🔗︎

The weight of the Industries/Taxonomies category relative to other categories.

Languages 🔗︎ decimal

Languages🔗︎

The weight of the Languages category relative to other categories.

Certifications 🔗︎ decimal

Certifications🔗︎

The weight of the Certifications category relative to other categories.

ExecutiveType 🔗︎ decimal

ExecutiveType🔗︎

The weight of the ExecutiveType category relative to other categories.

ManagementLevel 🔗︎ decimal

ManagementLevel🔗︎

The weight of the ManagementLevel category relative to other categories..

Sample JSON

{
  "SourceResume": {
    "Id": "",
    "ResumeData": "..."
  },
  "TargetResumes": [
    {
      "Id": "",
      "ResumeData": "..."
    }
  ],
  "TargetJobs": [
    {
      "Id": "",
      "JobData": "..."
    }
  ],
  "Settings": {
    "PositionTitlesMustHaveAnExactMatch": false
  },
  "PreferredCategoryWeights": {
    "Education": 0,
    "JobTitles": 0,
    "Skills": 0,
    "Industries": 0,
    "Languages": 0,
    "Certifications": 0,
    "ExecutiveType": 0,
    "ManagementLevel": 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.

TransactionId 🔗︎ string

TransactionId🔗︎

The (GUID) id for a specific API transaction. Use this when contacting support@textkernel.com about issues.

EngineVersion 🔗︎ string

EngineVersion🔗︎

The version of the parsing/matching engine running under-the-hood.

ApiVersion 🔗︎ string

ApiVersion🔗︎

The version of the API.

TotalElapsedMilliseconds 🔗︎ integer

TotalElapsedMilliseconds🔗︎

How long the transaction took on Textkernel's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.

TransactionCost 🔗︎ decimal

TransactionCost🔗︎

How many credits the transaction costs.How many credits the transaction costs.

CustomerDetails 🔗︎ object

CustomerDetails🔗︎

Information about the customer who made the API call.

CustomerDetails properties

AccountId 🔗︎ string

AccountId🔗︎

The AccountId for the account.

Name 🔗︎ string

Name🔗︎

The customer name on the account.

IPAddress 🔗︎ string

IPAddress🔗︎

The client IP Address where the API call originated.

Region 🔗︎ string

Region🔗︎

The region for the account, also known as the 'Data Center'.

CreditsRemaining 🔗︎ decimal

CreditsRemaining🔗︎

The number of credits remaining to be used by the account.

CreditsUsed 🔗︎ decimal

CreditsUsed🔗︎

The number of credits used by the account.

MaximumConcurrentRequests 🔗︎ integer

MaximumConcurrentRequests🔗︎

The number of requests that can be made at one time. If using sub-accounts, this is the maximum number of concurent requests across all accounts, not just this single sub-account.

ExpirationDate 🔗︎ date

ExpirationDate🔗︎

The date that the current credits expire.

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🔗︎

The weights suggested by Textkernel 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)

SuggestedCategoryWeights properties

Education 🔗︎ decimal

Education🔗︎

The weight of the Education category relative to other categories.

JobTitles 🔗︎ decimal

JobTitles🔗︎

The weight of the JobTitles category relative to other categories..

Skills 🔗︎ decimal

Skills🔗︎

The weight of the Skills category relative to other categories.

Industries 🔗︎ decimal

Industries🔗︎

The weight of the Industries/Taxonomies category relative to other categories.

Languages 🔗︎ decimal

Languages🔗︎

The weight of the Languages category relative to other categories.

Certifications 🔗︎ decimal

Certifications🔗︎

The weight of the Certifications category relative to other categories.

ExecutiveType 🔗︎ decimal

ExecutiveType🔗︎

The weight of the ExecutiveType category relative to other categories.

ManagementLevel 🔗︎ decimal

ManagementLevel🔗︎

The weight of the ManagementLevel category relative to other categories..

EducationHasData 🔗︎ boolean

EducationHasData🔗︎

If false, the Education category has no data and should be ignored/hidden.

JobTitlesHasData 🔗︎ boolean

JobTitlesHasData🔗︎

If false, the JobTitles category has no data and should be ignored/hidden.

SkillsHasData 🔗︎ boolean

SkillsHasData🔗︎

If false, the Skills category has no data and should be ignored/hidden.

IndustriesHasData 🔗︎ boolean

IndustriesHasData🔗︎

If false, the Industries/Taxonomies category has no data and should be ignored/hidden.

LanguagesHasData 🔗︎ boolean

LanguagesHasData🔗︎

If false, the Languages category has no data and should be ignored/hidden.

CertificationsHasData 🔗︎ boolean

CertificationsHasData🔗︎

If false, the Certifications category has no data and should be ignored/hidden.

ExecutiveTypeHasData 🔗︎ boolean

ExecutiveTypeHasData🔗︎

If false, the ExecutiveType category has no data and should be ignored/hidden.

ManagementLevelHasData 🔗︎ boolean

ManagementLevelHasData🔗︎

If false, the ManagementLevel category has no data and should be ignored/hidden.

AppliedCategoryWeights 🔗︎ object

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

AppliedCategoryWeights properties

Education 🔗︎ decimal

Education🔗︎

The weight of the Education category relative to other categories.

JobTitles 🔗︎ decimal

JobTitles🔗︎

The weight of the JobTitles category relative to other categories..

Skills 🔗︎ decimal

Skills🔗︎

The weight of the Skills category relative to other categories.

Industries 🔗︎ decimal

Industries🔗︎

The weight of the Industries/Taxonomies category relative to other categories.

Languages 🔗︎ decimal

Languages🔗︎

The weight of the Languages category relative to other categories.

Certifications 🔗︎ decimal

Certifications🔗︎

The weight of the Certifications category relative to other categories.

ExecutiveType 🔗︎ decimal

ExecutiveType🔗︎

The weight of the ExecutiveType category relative to other categories.

ManagementLevel 🔗︎ decimal

ManagementLevel🔗︎

The weight of the ManagementLevel category relative to other categories..

Sample JSON

{
  "Info": {
    "Code": "string",
    "Message": "string",
    "TransactionId": "string",
    "EngineVersion": "string",
    "ApiVersion": "string",
    "TotalElapsedMilliseconds": 0,
    "TransactionCost": 0,
    "CustomerDetails": {
      "AccountId": "string",
      "Name": "string",
      "IPAddress": "string",
      "Region": "string",
      "CreditsRemaining": 0,
      "CreditsUsed": 0,
      "ExpirationDate": "2021-12-31",
      "MaximumConcurrentRequests": 0
    }
  },
  "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,
        "ReverseCompatibilityScore": 0
      }
    ],
    "SuggestedCategoryWeights": {
      "Education": 0,
      "JobTitles": 0,
      "Skills": 0,
      "Industries": 0,
      "Languages": 0,
      "Certifications": 0,
      "ExecutiveType": 0,
      "ManagementLevel": 0,
      "EducationHasData": false,
      "JobTitlesHasData": false,
      "SkillsHasData": false,
      "IndustriesHasData": false,
      "LanguagesHasData": false,
      "CertificationsHasData": false,
      "ExecutiveTypeHasData": false,
      "ManagementLevelHasData": false
    },
    "AppliedCategoryWeights": {
      "Education": 0,
      "JobTitles": 0,
      "Skills": 0,
      "Industries": 0,
      "Languages": 0,
      "Certifications": 0,
      "ExecutiveType": 0,
      "ManagementLevel": 0
    }
  }
}