A service endpoint is a base URL that specifies the network address of an API service. The service has the following service endpoint and all URIs below are relative to this service endpoint:
https://ml.nuggetai.com/api
Extract Details from Job Description
Send a POST request to the job description endpoint to extract all the hard skills present within a job description.
The input is a paragraph of text containing the description about the job and returns various extracted fields such as hard skills, industry, job level, location, major etc.
POST /v1/parser/jd-details
Request Parameters
| Parameter | Type | Description |
|---|---|---|
x-api-key | string | Required. Your API key |
jd | string | Required. Job description |
Request Example
{
"jd": "Minimum 3+ years of experience in end-to-end project management (ideally in
financial services) Experience with end-to-end project management Experience working in an
agile and scrum environment Resourceful team player who thrives working with ambiguity
and minimal direction Excellent problem solving and analytical skills Demonstrated experience
building new processes from scratch and confident using workflow management tools such
as Jira Excellent communicator and key initiatives Excellent presentation and relationship
building skills"
}
Response Example
{
"response": {
"created_at": "2022-07-14 15:00:17.328036",
"data": {
"certification": [
"project management"
],
"company": null,
"degree": [
"Masters degree"
],
"employment_type": [],
"hard_skills": [
"financial services",
"jira",
"project management",
"scrum",
"analytical skills",
"workflow",
"workflow management",
"agile"
],
"industry": [
"Financial Services",
"Management"
],
"job_level": [],
"job_title": "",
"language": [
"English"
],
"location": "",
"major": [
"Management",
"computer science"
],
"other_experience": [],
"related_field": false,
"role_function": "",
"volunteering": []
}
}
}
Generate Hard Skills Score
Send a POST request to the endpoint to generate a hard skill score for each candidate.
The end-point takes the hard skills list (which were extracted from the job description) and a path to a folder with resumes on S3, and returns a list containing each candidates': hard skill score, S3 bucket resume link, name and email id.
POST /v1/parser/hard-skills
| Parameter | Type | Description |
|---|---|---|
x-api-key | string | Required. Your API key |
resume_bucket | string | Required. S3 bucket where all the resumes are stored |
bucket_folder | string | Required. Folder within S3 bucket |
hard_skills | string | Required. Hard skills extracted from job description |
aws_key | string | Required. AWS access key with read access to S3 bucket |
aws_secret_key | string | Required. AWS secret key with read access to S3 bucket |
Example Request Body
{ "resume_bucket":"<bucket name>",
"bucket_folder":"<path the S3 folder>",
"hard_skills":[
"lean six sigma",
"saas",
"automator",
],
"aws_key":"AKIAxxxxxxxxxxxxxD",
"aws_secret_key":"DLXAxxxxxxxxxxxxxE"
}
Response
{
"created_at":"2021-07-22 14:34:31.982092",
"data":{
"candidate_name||resume_name":{
"email":"[email protected]",
"score":0.7692307692307693,
"url":"S3_url_string"
}
}
}
SOFTEE (Softskill Open Format Text Extraction Engine)
Send a POST request to the endpoint to generate a multi-class score on open text. The 9 classes are Industrial/Organizational (I/O) Psychology-driven categories that define soft skills. These are the 9 skills:
In order to use the API, simply type in any sentence/paragraph and generate an understanding of one of these 9 skills:
Communication: effectively conveying information and messages to others.
Collaboration: working with others towards specific goals.Improvement
Focus: innovating to improve one's skills and work.
Interpersonal Sensitivity: considering others’ emotions, perspectives, and backgrounds.
Self-Management: regulating one's behaviors and emotions.
Work Management: strategically planning and coordinating own tasks and activities.
Leadership: guiding people to foster effective work.
Critical Thinking: making decisions and solving problems based on data analysis.
Systems Fluency: understanding the organizational structure and working within it to achieve goals and values.
POST /v1/super-talent/opentext