Skip to content

Latest commit

 

History

History
83 lines (69 loc) · 2.38 KB

ResolvedTitle.md

File metadata and controls

83 lines (69 loc) · 2.38 KB

Resolved Title Service

URL: https://www.api.careerbuilder.com/core/classifier/resolvedtitle

This endpoint supports the both HTTP/GET and HTTP/POST methods.

Request

Request Body Example:

{
  "target_titles": "Software Engineer|Database Administrator|Systems Administrator|Java Software Developer",
  "raw_title": "Java developer",
  "raw_description": "Come write some java code and do other stuff I guess maybe."
}
Request Fields
Name Required Comment 
target_titles
 true A pipe delimited list of possible titles to resolve to. A single title may be supplied if the user simply wishes to test whether an input is a good match for a specified title. 
raw_title
 true The title of the job offer to be classified. 
raw_description
 false The description of the job offer, possibly empty.

Version Parameter:

Resolved Title Service is currently on version 1.0. Version MUST BE specified in the Accept header (Ex. Accept:application/json;version=1.0).

Response

Sample Response:

{
    "data": {
        "title": "Network engineer",
        "confidence": 1
    }
}
Response Fields
Name Comment 
title
 The best match for rawTitle, selected from targetTitles. If no good match is found, this field will contain the string "No good match". 
confidence
 The classifier's confidence factor for the assignment. This is a normalized float value [0,1] but without any scale or reference point. It is used for ordering matches by the classifier but should not be used for thresholding. This field will be absent if no good match is found.

Versioning

ResolvedTitle is currently on version 1.0, and the data returned from this API is versioned.

Our general versioning strategy is available here.