Watson Talent Match

Preview

Watson Talent Match

+ Day(s) remaining in the trial

Overview

IBM Watson Talent Match (IWTM) is an API Offering that performs an Artificial Intelligent (AI) analysis of a requisition requirements and an applicant’s resume and returns a Talent Match Score that represents how well an applicant’s skills match a requisition’s requirements. IWTM not only matches skills from a candidate’s profile to a requisition but also identifies and analyzes indirect skills and competencies from a candidate’s resume that are not explicitly identified. The IWTM API can parse structured and unstructured data.

Security

Keys

Pick a key to use with this API. Make sure you are logged in with your IBM id for your keys to be populated in the dropdown below. By selecting a key, it will be pre-filled for each endpoint in the Documentation section that can be used with the built-in testing. If you want to change which key to use for a particular endpoint, you can do so at the endpoint in the Documentation section.
You can manage your API keys in the <MyAPIs> section. API keys authenticate you to your subscription, so make sure to keep them secret. Do not share the X-IBM-Client-Secret portion of any API key in publicly accessible places such as GitHub, or client-side code.



Manage your keys
 

Match

Match job and person information.
Scores the match between a job profile and a person profile on a scale of 0 to 100. Returns both scoring details and matching profile elements. In order to use this method, use one of the valid combinations listed below. In all these combinations, version is an required parameter.
The first two parameters for each combination are required. * rawJob, rawPerson, atsJob (optional) and atsPerson (optional) * rawJob, parsedPerson, atsJob (optional) and atsPerson (optional) * parsedJob, rawPerson, atsJob (optional), and atsPerson (optional) * parsedJob, parsedPerson, atsJob (optional), and atsPerson (optional)

POST   /match

			https://api.ibm.com/watsontalent/run/match
		
Keys
Path and Query parameters

version

INTEGER , required

Input the integer version number associated with the implementation of match you wish to run.

FormData parameters

atsJob

STRING , optional

Contains the **FORMATTED** json representation of the job position used in matching as defined by the ATS system.

atsPerson

STRING , optional

Contains the **FORMATTED** json representation of the person profile used in matching as defined by the ATS system.

parsedJob

STRING , optional

Contains the **PREPARSED** json representation of the job and person profile used for matching. It is assumed the job passed in this parameter has been parsed first into json format via /match response.

parsedPerson

STRING , optional

Contains the **PREPARSED** json representation of the job and person profile used for matching. It is required the person passed in this parameter has been parsed first into json format via /match response.

rawJob

STRING , optional

Contains the **UNPARSED** raw job. A job passed into this method will be parsed into json before matching.

rawPerson

STRING , optional

Contains the **UNPARSED** raw person profile/resume. A person resume passed into this method will be parsed into json before matching.

Request code
								
var client = new RestClient("https://api.ibm.com/watsontalent/run/match?version=0"); var request = new RestRequest(Method.POST); request.AddHeader("x-ibm-client-id", "REPLACE_KEY_VALUE"); request.AddHeader("x-ibm-client-secret", "REPLACE_KEY_VALUE"); request.AddHeader("content-type", "multipart/form-data"); request.AddParameter("multipart/form-data", "rawJob=string&rawPerson=string&parsedJob=string&parsedPerson=string&atsJob=string&atsPerson=string", ParameterType.RequestBody); IRestResponse response = client.Execute(request);
Response model

200

The match score Returns both the score and matching profile.

Body

job

OBJECT , optional

match

OBJECT , optional

person

OBJECT , optional

competency

ARRAY , optional

competencyAggregations

ARRAY , optional

competencyClassifications

ARRAY , optional

education

OBJECT , optional

job

OBJECT , optional

competencyCategory

STRING , optional

level-0 lookup with Talent framework skill database based on Name

competencyGroup

STRING , optional

level-1 lookup with Talent framework skill database based on Name

competencyName

STRING , optional

Name of the Competency

competencyType

STRING , optional

Competency Type e.g. Computer Skills

class_name

STRING , optional

Competency Class Name

count

STRING , optional

Number of instances this Class was identified across all Classes

details

STRING , optional

Competency Class Details/Text phrase

allClasses

STRING , optional

An array of up to ten class-confidence pairs sorted in descending order of confidence. These are delimitted by pipe | symbol

text

STRING , optional

Text Phrase from the Job Description where the Classes were identified

top_class

STRING , optional

Top Class from the list of all Classess which has highest confidence.

top_class_confidence

STRING , optional

Numerical value for the top class

degrees

ARRAY , optional

gpa

DECIMAL , optional

Minimum GPA required.

gpaScale

INTEGER , optional

Minimum GPA required.

majors

ARRAY , optional

degree

STRING , optional

Degree needed for the Job

required

BOOLEAN , optional

Is the degree required.

major

STRING , optional

Major needed for the Job

required

BOOLEAN , optional

Is the major required.

description

STRING , optional

Please provide all the information related to Job Requirement, Educations, Experiences, Skills etc required for the Job in this field.

jobClassification

STRING , optional

locationName

STRING , optional

Short name of the Location used by Client to distinguish location information. (comma separated)

requiredExperience

STRING , optional

Free form textual description of required experience.

role

STRING , optional

Job Role Name of the Requisition provided by the Client

title

STRING , optional

Title of the job.

scores

ARRAY , optional

foundationalSkillScore

STRING , optional

foundationalSkillScoreDetails

ARRAY , optional

matchScore

STRING , optional

preferredSkillScore

STRING , optional

preferredSkillScoreDetails

ARRAY , optional

requiredSkillScore

STRING , optional

requiredSkillScoreDetails

ARRAY , optional

candidate

ARRAY , optional

foundationalSkillName

STRING , optional

requisition

ARRAY , optional

score

DECIMAL , optional

text

STRING , optional

score

DECIMAL , optional

text

STRING , optional

skillMatch

STRING , optional

skillMatchValue

ARRAY , optional

skillName

STRING , optional

skillMatch

STRING , optional

skillMatchValue

ARRAY , optional

skillName

STRING , optional

competency

OBJECT , optional

competencyAggregations

ARRAY , optional

competencyClassifications

ARRAY , optional

education

OBJECT , optional

jobExperience

OBJECT , optional

competencies

ARRAY , optional

yearsInIndustry

STRING , optional

Total years of experience in the Industry

competencyName

STRING , optional

Name of the Competency

competencyType

STRING , optional

Competency Type.

expertiseLevel

STRING , optional

Expertise Level

lastUsedDate

DATE , optional

Year when the competency was last used

skillCategory

STRING , optional

level-0 lookup with Talent framework skill database based on skill Name

skillGroup

STRING , optional

level-1 lookup with Talent framework skill database based on skill Name

yearsOfExperience

DECIMAL , optional

Years of experience associated to that Competency

class_name

STRING , optional

Competency Class Name

count

STRING , optional

Number of instances this Class was identified across all Classes

details

STRING , optional

Competency Class Details/Text phrase

allClasses

STRING , optional

An array of up to ten class-confidence pairs sorted in descending order of confidence. These are delimitted by pipe | symbol

text

STRING , optional

Text Phrase from the Job Description where the Classes were identified

top_class

STRING , optional

Top Class from the list of all Classess which has highest confidence.

top_class_confidence

STRING , optional

Numerical value for the top class

educations

ARRAY , optional

GPA

STRING , optional

Person's Grade Point Average while at the school

GPAScale

INTEGER , optional

Candidate'sGradePointAverage Scale (e.g. GPA of 3.75 with GPAScale of 4.0)

degree

STRING , optional

Degree that the candidate earned from the school

duration

INTEGER , optional

Duration in years of Education in the College/University.

eduSequence

INTEGER , optional

Sequence in the order of Most Recent Education (1 being the most recent)

educationLevel

STRING , optional

Education Level Values.

endDate

DATE , optional

Month and Year that the candidate completed this education

major

STRING , optional

Major area of study that the candidate participated in while at the school

majorFieldName

STRING , optional

It contains field name value for based on lookup with dictionary from major_normalized e.g. engineering.

majorFieldType

STRING , optional

It contains field Type value for based on lookup with dictionary from major_normalized e.g. science.

major_normalized

STRING , optional

major by lookup with TF dictionaory based on major if not found then polished(removed special character and stop words defined in TF) value.

ongoing

BOOLEAN , optional

Undergoing the education.

schoolCountry

STRING , optional

Education School Country

schoolLocation

STRING , optional

Education School Location

schoolLocation_normalized

STRING , optional

Normalized school location by lookup with TF dictionaory.

schoolName

STRING , optional

Name of the school that the candidate attended

schoolName_normalized

STRING , optional

Normalized schoolName by lookup with TF dictionaory.

startDate

DATE , optional

Month and Year that the candidate attended this education

jobExperiences

ARRAY , optional

companyName

STRING , optional

Name of the organization where candidate worked

companyName_normalized

STRING , optional

Normalized company name by lookup with TF dictionary.

country

STRING , optional

Work location - country

duration

INTEGER , optional

Duration in years worked in this Company.

endDate

DATE , optional

Year candidate ended employment at the organization.

expSequence

STRING , optional

Sequence in the order of Most Recent Experience (1 being the most recent)

jobDescription

STRING , optional

Job Description/ work done.

jobTitle

STRING , optional

Candidate's job title in the organization

ongoing

BOOLEAN , optional

Current working company.

startDate

DATE , optional

Year candidate started working at the organization

state

STRING , optional

Work location - state

default

Unexpected error

Body

errors

ARRAY , optional

details

STRING , optional

Optional additional details for the error message

errorRef

STRING , optional

The error message id.

fieldName

STRING , optional

The field name of the error.

reason

STRING , optional

The brief error message text.

validationErrors

STRING , optional

Detailed input validation errors.

Response example

200

The match score Returns both the score and matching profile.

								{
  "job" : {
    "competency" : [{
    "competencyCategory" : string,
    "competencyGroup" : string,
    "competencyName" : string,
    "competencyType" : string
  }],
    "competencyAggregations" : [{
    "class_name" : string,
    "count" : string,
    "details" : string
  }],
    "competencyClassifications" : [{
    "allClasses" : string,
    "text" : string,
    "top_class" : string,
    "top_class_confidence" : string
  }],
    "education" : {
    "degrees" : [{
    "degree" : string,
    "required" : boolean
  }],
    "gpa" : decimal,
    "gpaScale" : integer,
    "majors" : [{
    "major" : string,
    "required" : boolean
  }]
  },
    "job" : {
    "description" : string,
    "jobClassification" : string,
    "locationName" : string,
    "requiredExperience" : string,
    "role" : string,
    "title" : string
  }
  },
  "match" : {
    "scores" : [{
    "foundationalSkillScore" : string,
    "foundationalSkillScoreDetails" : [{
    "candidate" : [{
    "score" : decimal,
    "text" : string
  }],
    "foundationalSkillName" : string,
    "requisition" : [{
    "score" : decimal,
    "text" : string
  }]
  }],
    "matchScore" : string,
    "preferredSkillScore" : string,
    "preferredSkillScoreDetails" : [{
    "skillMatch" : string,
    "skillMatchValue" : [string],
    "skillName" : string
  }],
    "requiredSkillScore" : string,
    "requiredSkillScoreDetails" : [{
    "skillMatch" : string,
    "skillMatchValue" : [string],
    "skillName" : string
  }]
  }]
  },
  "person" : {
    "competency" : {
    "competencies" : [{
    "competencyName" : string,
    "competencyType" : string,
    "expertiseLevel" : [basic, working, extensiveExperience, subjectMatterDepthAndBreadth],
    "lastUsedDate" : date,
    "skillCategory" : string,
    "skillGroup" : string,
    "yearsOfExperience" : decimal
  }],
    "yearsInIndustry" : string
  },
    "competencyAggregations" : [{
    "class_name" : string,
    "count" : string,
    "details" : string
  }],
    "competencyClassifications" : [{
    "allClasses" : string,
    "text" : string,
    "top_class" : string,
    "top_class_confidence" : string
  }],
    "education" : {
    "educations" : [{
    "GPA" : string,
    "GPAScale" : integer,
    "degree" : string,
    "duration" : integer,
    "eduSequence" : integer,
    "educationLevel" : [secondary, vocational, university, bachelors, masters, phd, course],
    "endDate" : date,
    "major" : string,
    "majorFieldName" : string,
    "majorFieldType" : string,
    "major_normalized" : string,
    "ongoing" : boolean,
    "schoolCountry" : string,
    "schoolLocation" : string,
    "schoolLocation_normalized" : string,
    "schoolName" : string,
    "schoolName_normalized" : string,
    "startDate" : date
  }]
  },
    "jobExperience" : {
    "jobExperiences" : [{
    "companyName" : string,
    "companyName_normalized" : string,
    "country" : string,
    "duration" : integer,
    "endDate" : date,
    "expSequence" : string,
    "jobDescription" : string,
    "jobTitle" : string,
    "ongoing" : boolean,
    "startDate" : date,
    "state" : string
  }]
  }
  }
}
							

default

Unexpected error

								{
  "errors" : [{
    "details" : string,
    "errorRef" : string,
    "fieldName" : string,
    "reason" : string,
    "validationErrors" : string
  }]
}
							

Loading content...