Explain Weightage

Use the explainWeightage parameter in an API request to display the actual (calculated) weightage values applied to entities during response generation.

When sending an API request, you can assign custom weightage (resumeWeightage or jdWeightage)) values to different entities of a job description (JD) or resume. However, the final applied weightage, used to calculate the matching score, may differ from the values you provided in the request.

This difference occurs because the system adjusts weightage values dynamically based on internal calculations and other configured parameters. To view the actual weightage applied to each entity, include the optional parameter explainWeightage in your request:

"explainWeightage": true

When enabled, the API response includes detailed weightage information representing the computed values used for scoring.

Note:

The calculated weightage in the response represents the actual values applied for matching, not necessarily the ones specified in the request.
If dynamic weightage (resumeWeightage or jdWeightage) is not returned in the API response, then the default weightage is returned in the response.
The explainWeightage parameter can be passed in the API request of Simple Search, Match, Match with ID, Match with Multiple Sub-User Ids, and One To One Match.
To know more details about dynamic weightage, refer Dynamic Weightage.

Sample Request

"resumeWeightage": [
    {
        "Parent": "JobProfile",
        "Weight": 17.65,
        "Child": {
            "CurrentJobProfile": 100.0,
            "CurrentJobAlias": 100.0,
            "JobProfile": 80.0,
            "JobAlias": 80.0
        }
    },
    {
        "Parent": "Employer",
        "Weight": 17.65,
        "Child": {
            "CurrentEmployer": 100.0,
            "Employer": 80.0
        }
    },
    {
        "Parent": "Skill",
        "Weight": 17.64,
        "Child": {
            "SkillHaveExp": 100.0,
            "SkillAlias": 80.0,
            "SkillWithoutExp": 80.0
        }
    },
    {
        "Parent": "Degree",
        "Weight": 11.79,
        "Child": {
            "HighestDegree": 100.0,
            "Degree": 80.0
        }
    },
    {
        "Parent": "City",
        "Weight": 0.0,
        "Child": {
            "EmployerCity": 90.0,
            "AddressCity": 100.0,
            "CurrentCity": 100.0,
            "EducationCity": 50.0,
            "PreferredCity": 90.0,
            "CurrentEmployerCity": 100.0
        }
    },
    {
        "Parent": "State",
        "Weight": 0.0,
        "Child": {
            "EducationState": 50.0,
            "CurrentState": 100.0,
            "PreferredState": 90.0,
            "EmployerState": 90.0,
            "CurrentEmployerState": 100.0,
            "AddressState": 100.0
        }
    },
    {
        "Parent": "Country",
        "Weight": 0.0,
        "Child": {
            "PreferredCountry": 90.0,
            "EducationCountry": 50.0,
            "CurrentCountry": 100.0,
            "EmployerCountry": 90.0,
            "AddressCountry": 100.0,
            "CurrentEmployerCountry": 100.0
        }
    },
    {
        "Parent": "TotalExperienceInYear",
        "Weight": 11.76
    },
    {
        "Parent": "Category",
        "Weight": 11.76
    },
    {
        "Parent": "SubCategory",
        "Weight": 11.76
    }
]