Update Index

The Update Index API allows you to update a block of JSON or a specific entity within a resume or job description (JD) without requiring document parsing through the ResumeParser or JDParser API.

Currently, the ParseAndIndex method requires the complete Resume or JD document. It uses the ResumeParser or JDParser API to parse the document and then indexes or updates it based on the parsed JSON. This process consumes 2 credits.

The Update Index API is a more efficient option when you only need to update or delete a specific part of the JSON, such as a block or entity, in a resume or JD. You only need the document's indexed ID and the details you want to modify or remove, and it uses just 1 credit.

Note:

In the Search and Match v3.0 API, you can update or delete any entity in both resumes and JDs.
In the Search and Match v4.0, updates and deletions are supported for resumes only. JDs currently do not support update or delete functionality through the v4.0 API.

API URL

This API uses the below URL for Search and Match v3.0:

https://searchengine.rchilli.com/RChilliSearchEngineAPI/RChilli/updateIndex

This API uses the below URL for Search and Match v4.0:

https://searchengine.rchilli.com/RChilliSearchEngineAPI/RChilli/v4/updateIndex

API Endpoint

The API uses the below endpoint:

/updateIndex

API Method

This API method uses POST method.

API Request Type

The API uses JSON request type.

API Request Headers


Header	Data Type	Description
Content-Type	string	Indicates the input type of the incoming request body. The only supported value is `application/json`.

API Parameters

To execute this API, the following parameters in the JSON request are needed:

Name Type Description Remarks

indexType String Type of the file i.e Resume or JD Required

indexKey String Use your user key as shared by RChilli team Required

id String This is the indexed document ID for the resume or job description where you want to update or remove data. Required

insertEntityValue

Array

This is an array containing the details of the entities you want to add or update in the document. Refer to the table below for the entities that can currently be added using the insertEntityValue array:


Resume	JD
CurrentJobProfile SkillHaveExp Skill TotalExperienceInYear HighestDegree CurrentEmployer customValue	JobProfileTitle RequiredSkillSet PreferredSkillSet MinimumYearsExperience MaximumYearsExperience QualificationsPreferred QualificationsRequired customValue

Optional

Note:

If you do not use insertEntityValue, then removeEntityValue become required.
To know more details about customValue, refer Custom Value.

removeEntityValue

Array

This is an array containing the details of the entities you want to remove from the document. Refer to the table below for the entities that can currently be removed using the removeEntityValue array:


Resume	JD
SkillHaveExp Skill customValue	RequiredSkillSet PreferredSkillSet Qualifications customValue

Optional

Note: If you do not use removeEntityValue, then insertEntityValue become required.

Sample JSON Resume Request - Search and Match v3.0

Below is the sample JSON Request to insert resume details.

{
    "index": {
        "indexType": "Resume",
        "indexKey": "Use your indexKey",
        "subUserId": "Your subUserId"
    },
    "data": {
        "id": "202408220428PMResume",
        "insertEntityValue": {
            "CurrentJobProfile": "Sr. Software Engineer",
            "SkillHaveExp": [
                "Java"
            ],
            "Skill": [
                "Oracle",
                "AWS"
            ],
            "TotalExperienceInYear": 4.5,
            "HighestDegree": "MCA",
            "customValue": {
                "Shift": "Day",
                "customField2": [
                    "Value 2"
                ],
                "customField3": [
                    {
                        "docField1": "doc field value 1"
                    }
                ]
            },
            "CurrentEmployer": "TCS"
        },
        "removeEntityValue": {
            "SkillHaveExp": [
                "PHP"
            ],
            "Skill": [
                "PostgreSQL"
            ]
        }
    }
}

Sample JSON Resume Request - Search and Match v4.0

Below is the sample JSON Request to insert resume details.

{
    "index": {
        "indexType": "Resume",
        "indexKey": "Use your indexKey",
        "subUserId": "Your subUserId"
    },
    "data": {
        "id": "202505260659PMResumeExperience",
        "insertEntityValue": {
            "CurrentJobProfile": {
                "value": "Sr. Software Engineer",
                "experienceInMonth": 48
            },
            "SkillHaveExp": [
                {
                    "value": "Java",
                    "experienceInMonth": 36
                }
            ],
            "Skill": [
                "GitHub",
                "PostgreSQL"
            ]
        },
        "removeEntityValue": {
            "SkillHaveExp": [
                "MaxScript"
            ],
            "Skill": [
                "Social Networks"
            ]
        }
    }
}

Sample JSON JD Request - Search and Match v3.0

Sample JSON request to insert JD details.

{
    "index": {
        "indexType": "JD",
        "indexKey": "Use your indexKey",
        "subUserId": "test1"
    },
    "data": {
        "id": "202408220428PMJd",
        "insertEntityValue": {
            "JobProfileTitle": "Sr. Software Engineer",
            "RequiredSkillSet": [
                "Java"
            ],
            "PreferredSkillSet": [
                "Oracle",
                "AWS"
            ],
            "MinimumYearsExperience": 4.5,
            "MaximumYearsExperience": 10.0,
            "QualificationsPreferred": [
                "Master"
            ],
            "QualificationsRequired": [
                "Bachelor"
            ]
        },
        "removeEntityValue": {
            "RequiredSkillSet": [
                "PHP"
            ],
            "PreferredSkillSet": [
                "PostgreSQL"
            ],
            "Qualifications": [
                "BCA"
            ]
        }
    }
}

Sample JSON Response

{
    "status": "200",
    "indexType": "JD",
    "subUserId": "test1",
    "action": "updated",
    "id": "202408220428PMJd",
    "doc": "eyJRdWFsaWZpY2..."
}