Explain Score

This feature is to get a detailed score of search fields that matches with the search result.

API request Parameters

Request parameters for Explain Score are described below:
Name Type Description Remarks
explainScore Boolean Default is false. If this is set true, it returns the details on how the document is searched. Optional
explainScoreType string Default is text. This can be set as JSON and this returns data only if ExplainScore parameter is set true. Optional

JSON request with exlainScore parameter

"explainScore": true,
"explainScoreType":"json",

JSON response for ExplainScoreType as text

[{
    "id": "1911260416391139",
    "explaination": "82.39 = sum of:\n    78.18 = sum of:\n      36.84 = CurrentJobProfile:developer\n      36.84 = JobProfile:developer\n      0.48 = Skill:c#\n      0.48 = Skill:vb.net\n      0.48 = Skill:jquery\n      0.48 = Skill:influential\n      0.48 = Skill:network\n      0.48 = Skill:communication\n      0.48 = Skill:design\n      0.38 = Skill:sql server\n      0.38 = Skill:creativity\n      0.38 = Skill:engagement\n    4.21 = sum of:\n      4.21 = ([Degree:btech, ([Degree:bachelor of techology]) btec, ([Degree:bachelor of engineering]) b.e, ([Degree:bachelor of technology]) b.tech])\n"
}]

JSON response for ExplainScoreType as JSON

"explainationType":"json"
    "explaination": {
                "score": 85.88,
                "maxScore": 100.0,
                "Search": {
                    "score": 85.88,
                    "maxScore": 100.0,
                    "ExplainScore": [
                        {
                            "score": 32.94,
                            "maxScore": 41.18,
                            "entity": "JobProfile",
                            "value": "software developer"
                        },
                        {
                            "score": 41.18,
                            "maxScore": 41.18,
                            "entity": "CurrentJobProfile",
                            "value": "software developer"
                        },
                        {
                            "score": 0.0,
                            "maxScore": 17.65,
                            "entity": "Degree",
                            "value": "B.tech."
                        },
                        {
                            "score": 11.76,
                            "maxScore": 11.76,
                            "entity": "TotalExperienceInYear",
                            "value": "[5.0 TO Infinity]"
                        },
                        {
                            "score": 0.0,
                            "maxScore": 5.88,
                            "entity": "Skill",
                            "value": "Java"
                        },
                        {
                            "score": 0.0,
                            "maxScore": 5.88,
                            "entity": "Skill",
                            "value": "Php"
                        },
                        {
                            "score": 0.0,
                            "maxScore": 5.88,
                            "entity": "Skill",
                            "value": "Computer Science"
                        },
                        {
                            "score": 0.0,
                            "maxScore": 5.88,
                            "entity": "City",
                            "value": "Pune"
                        },
                        {
                            "score": 0.0,
                            "maxScore": 5.88,
                            "entity": "Country",
                            "value": "India"
                        }
                    ]
                }
            }
        },