Extract Skills
Use this API to find out what skills are related to your courses or other similar documents.
Extract skills
POST
https://apigateway.boost.rs/skillfinder/extract-skills
This endpoint allows you to extract the relevant skills from a text.
Query Parameters
Name | Type | Description |
---|---|---|
with[] | Array | The default response only returns the skills related to the content.
If the parameter is used, the response will return only the items requested via the parameters. You may use multiple parameters.
Available array options:
|
hierarchy | Boolean | If the value is set to The default response body returns only the skills. This parameter shows the hierarchy only when used in combination with the with[] parameter. |
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Authorisation token received from oAuth API.
|
Accept | String |
|
Accept-Language | String | Allows you to specify if you want the output to be in one of the accepted languages. Format: ISO 639-1 language code. If no value is specified, the response language will be English. |
Request Body
Name | Type | Description |
---|---|---|
language_code* | String | ISO 639-1 language code format, according to the Language list (see Getting started page). If not sent at all, the language will be detected automatically. |
content* | String | The body of text to extract skills from. Maximum 7,500 characters. |
category_id | Integer | Use this field for cases in which you want to use your custom skill set instead of the Boostrs platform skills. You must have an existing custom category and skills in it. |
Using the hierarchy
parameter
If there are no options specified via the with[] parameter, the response will only include skills (atomic skills); the hierarchy
parameter will have no effect.
Response fields
Field name | Description |
---|---|
| Document ID. |
| Document status. There may be more status messages in the future.
|
| Group of fields containing the skills that were matched to the document contents (source text). The results are ordered DESC by match score value.
|
Last updated