Compare Skills

The /professions/compare_skills endpoint allows to compare two given profession with respect to their related skills.

NOTE that the skill set used to determine the "common skills" is a larger set than the skills that the /suggest_skills endpoint returns. This is done to ensure also less salient skills are listed as common ones if they are related to both professions. That means that the "common skills" don't necessarily align with the suggested skills.

Endpoint

Method	Media	URL
POST	application/json	https://api.textkernel.nl/professions/v1/compare_skills

Input parameters

Parameter	Type	Default	Description
code_ids	list str	None (required)	The two profession code IDs for which the service should compare related skills.
output_language	str	None (optional)	Parameter to set the language of the returned descriptions. If not set, the service will return no descriptions. Expects a language in ISO 639-1 format (e.g. "en", "nl").

Response

Status	Content type	Content description
200 (OK)	application/json	A JSON object containing: suggested_skills: the list of related skills with their relation strength meta: meta information of the service version
400 (Bad request)		The input request body is incorrect
422 (Validation error)		One of the input code IDs is not a valid code ID in the Textkernel profession taxonomy.

Example

curl -X POST "https://api.textkernel.nl/professions/v1/compare_skills" \
        -H "Authorization: Bearer $TOKEN"\
        -H "accept: application/json" \
        -H "Content-Type: application/json" \
        -d "{\"code_ids\": [\"696\", \"3178\"]}"


{
  "meta": {
    "service_version": "1.0.0",
    "taxonomy_release": "2021-07-05"
  },
  "similarity_score": 0.05211433312950096,
  "common_skills": [
    {
      "score": 0.7009135563836913,
      "code_id": "KS120B874P2P6BK1MQ0T"
    },
    {
      "score": 0.6078001801212654,
      "code_id": "KS440QS66YCBN23Y8K25"
    }
  ],
  "exclusive_skills": {
    "696": [
      {
        "score": 0.976375916777892,
        "code_id": "KS120076FGP5WGWYMP0F"
      },
      {
        "score": 0.9651344675938166,
        "code_id": "KS124PR62MV42B5C9S9F"
      }
    ],
    "3178": [
      {
        "score": 0.9720689968978681,
        "code_id": "KS1282M68WL9T4YH3SLF"
      },
      {
        "score": 0.9388032970636087,
        "code_id": "KS821U8XQRM3KNTJ84N7"
      }
    ]
  }
}

Response fields

Field	Type	Value
similarity_score	float	A similarity score between the two professions. The score is a value in the range [0 - 1].
common_skills	list skill	List of common skills for both professions.
exclusive_skills	map	List of exclusive skills for each profession.
skill.code_id	str	The code ID of the related Skill in the Textkernel Skill taxonomy.
skill.score	float	An association score indicating the relationship strength. The score is a value in the range [0 - 1].
skill.description	str	The skill description as per the TK taxonomy in the specified output_language. Will only be returned if output_language is specified.

Rate limits

Accounts have a limited request rate. If you exceed the limit you will receive 429 Too Many Requests HTTP responses.

Plan	Limit	Units
Standard	1000	Minute
Demo	30	Minute

Remember to send your authentication token with each request (see Authentication).