Prediction
An API that predicts skills based on job titles and provided skill sets.
post
copied!# You can also use wgetcurl -X POST https://api-qa.phenompro.com/prediction/v1/skills
-H 'Content-type: application/json'
-H 'Accept: application/json'
-H 'Authorization: string'POST /prediction/v1/skills
An API that predicts skills based on job titles and provided skill sets.
Headers
| Name | In | Type | Required |
|---|---|---|---|
| Authorization | header | string | true |
Body Parameter
copied![
{
"type": "object",
"description": "Request object to get matching skills for given details.",
"properties": {
"titles": {
"title": "Titles",
"type": "array",
"description": "Titles' List.",
"items": {
"type": "string",
"description": "List of titles."
}
},
"skills": {
"title": "Skills",
"type": "array",
"description": "Skills' List.",
"items": {
"type": "string",
"description": "List of skills."
}
},
"size": {
"title": "Size",
"type": "integer",
"description": "Size of skills to return."
},
"source": {
"title": "Source",
"description": "Source.",
"type": "string"
}
}
}
]Request Parameters
| Type | Name |
|---|---|
| application/json | SkillPredictionRequest |
Response
200 response
copied![
{
"required": {
"0": "status"
},
"description": "Skills prediction response.",
"type": "object",
"properties": {
"status": {
"title": "Status",
"description": "Status of response.",
"type": "string"
},
"totalHits": {
"title": "Totalhits",
"description": "Total number of hits.",
"type": "integer"
},
"data": {
"SkillResults": {
"type": "object",
"description": "Predicted Skills.",
"properties": {
"results": {
"title": "Results",
"type": "array",
"description": "Results details.",
"items": {
"SkillResult": {
"type": "object",
"description": "Details of skills.",
"properties": {
"score": {
"title": "Score",
"description": "Matching score of a skill.",
"type": "number",
"format": "double"
},
"skill": {
"title": "Skill",
"description": "Matching skill.",
"type": "string"
}
}
}
}
}
}
}
}
}
}
]Bad Request
copied![
{
"description": "Bad request details.",
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status of bad request."
},
"message": {
"type": "string",
"description": "Bad request message."
}
}
}
]Server Error
copied![
{
"type": "object",
"description": "Error response details.",
"properties": {
"status": {
"type": "string",
"description": "Status of encountered error."
},
"message": {
"type": "string",
"description": "Error message."
}
}
}
]Responses
| Status | Description | Schema |
|---|---|---|
| 200 | 200 response | SkillPredictionResponse |
| 400 | Bad Request | BadRequest |
| 500 | Server Error | ErrorResponse |
Schemas
copied!{
"type": "object",
"description": "Request object to get matching skills for given details.",
"properties": {
"titles": {
"title": "Titles",
"type": "array",
"description": "Titles' List.",
"items": {
"type": "string",
"description": "List of titles."
}
},
"skills": {
"title": "Skills",
"type": "array",
"description": "Skills' List.",
"items": {
"type": "string",
"description": "List of skills."
}
},
"size": {
"title": "Size",
"type": "integer",
"description": "Size of skills to return.",
"default": 10
},
"source": {
"title": "Source",
"description": "Source.",
"type": "string"
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| titles | [string] | Titles' List. |
| skills | [string] | Skills' List. |
| size | integer | Size of skills to return. |
| source | string | Source. |
copied!{
"required": [
"status"
],
"description": "Skills prediction response.",
"type": "object",
"properties": {
"status": {
"title": "Status",
"description": "Status of response.",
"type": "string"
},
"totalHits": {
"title": "Totalhits",
"description": "Total number of hits.",
"type": "integer"
},
"data": {
"SkillResults": {
"type": "object",
"description": "Predicted Skills.",
"properties": {
"results": {
"title": "Results",
"type": "array",
"description": "Results details.",
"items": {
"SkillResult": {
"type": "object",
"description": "Details of skills.",
"properties": {
"score": {
"title": "Score",
"description": "Matching score of a skill.",
"type": "number",
"format": "double"
},
"skill": {
"title": "Skill",
"description": "Matching skill.",
"type": "string"
}
}
}
}
}
}
}
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| status | string | Status of response. |
| totalHits | integer | Total number of hits. |
| data | object | SkillResults |
copied!{
"type": "object",
"description": "Details of skills.",
"properties": {
"score": {
"title": "Score",
"description": "Matching score of a skill.",
"type": "number",
"format": "double"
},
"skill": {
"title": "Skill",
"description": "Matching skill.",
"type": "string"
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| score | number | Matching score of a skill. |
| skill | string | Matching skill. |
copied!{
"type": "object",
"description": "Predicted Skills.",
"properties": {
"results": {
"title": "Results",
"type": "array",
"description": "Results details.",
"items": {
"SkillResult": {
"type": "object",
"description": "Details of skills.",
"properties": {
"score": {
"title": "Score",
"description": "Matching score of a skill.",
"type": "number",
"format": "double"
},
"skill": {
"title": "Skill",
"description": "Matching skill.",
"type": "string"
}
}
}
}
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| results | array | SkillResult |
copied!{
"type": "object",
"description": "Error response details.",
"properties": {
"status": {
"type": "string",
"description": "Status of encountered error."
},
"message": {
"type": "string",
"description": "Error message."
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| status | string | Status of encountered error. |
| message | string | Error message. |
copied!{
"description": "Bad request details.",
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status of bad request."
},
"message": {
"type": "string",
"description": "Bad request message."
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| status | string | Status of bad request. |
| message | string | Bad request message. |
