Grading API now shows how each profile meets the job on 8 axes

Profile grading can now return, for each profile, whether it meets the job on 8 axes such as skills, seniority and role, so you can show why a profile fits. A profile that can't be read no longer makes the whole request fail.

Action required

Now: none. GET /profile/grading keeps its parameters, and scores keeps its [1 - score, score] pairs in the order of profiles. An entry can now be null for a profile that couldn't be graded: skip it and read errors.
Later: none. Nothing in this update is deprecated.

What changed

New parameter return_axis (boolean, default false) on GET /profile/grading.
With return_axis=true and grader-hrflow-profiles-cosmic5 or grader-hrflow-profiles-titan5, axis holds one object per profile, in the order of profiles, with 8 keys: education, languages, skills, seniority, management, contract, role and domain. Each is true when the job requires it and the profile meets it, false when the job requires it and the profile doesn't, and null when the job doesn't mention it. Otherwise axis is null.
New field errors: one entry per profile, null when the profile was graded, otherwise {"code", "message"} saying why it has no score.
A profile that can't be read no longer makes the whole request fail: its scores entry is null, its errors entry has the code item_not_found, and the other profiles are graded. Before, the request answered 400.
An entry of scores can be null when its profile has no score; the other entries keep their pairs and their order.
Single-profile requests (deprecated) also return axis next to score.
GET /job/grading also returns errors, one entry per job: a job that can't be read no longer makes the whole request fail. Its scores entry is null and its errors entry has the code item_not_found.

Example

curl -G https://api.hrflow.ai/v1/profile/grading \
  -H "X-API-KEY: <your_api_key>" \
  -H "X-USER-EMAIL: <your_email>" \
  --data-urlencode "algorithm_key=grader-hrflow-profiles-cosmic5" \
  --data-urlencode "board_key=<board_key>" \
  --data-urlencode "job_key=<job_key>" \
  --data-urlencode "source_key=<source_key>" \
  --data-urlencode "profile_ids[0][source_key]=<source_key>" \
  --data-urlencode "profile_ids[0][profile_key]=<profile_key>" \
  --data-urlencode "return_axis=true"

{
  "code": 200,
  "message": "…",
  "data": {
    "profiles": [{"key": "<profile_key>"}],
    "scores": [[0.49184858798980713, 0.50815147161483765]],
    "axis": [{"education": true, "languages": null, "skills": true, "seniority": false,
              "management": null, "contract": null, "role": true, "domain": true}],
    "errors": [null]
  }
}

Action required

What changed

Example

Links