What is Index ID and How to Map It?

What is an Index ID?

In the context of RChilli's Search & Match functionality, an Index ID is a unique identifier assigned to a document (e.g., resume or JD) after it has been parsed and indexed into RChilli’s Search Engine.

• Parsing extracts structured data.

• Indexing stores the document temporarily in a secure, region-specific environment.

• The Index ID is used in all operations such as search, match, retrieve, update, or delete.

What is the Difference Between Parsing and Indexing?

How to Map Index ID?

Mapping refers to associating the rchilli_index_id with your internal job or candidate records.

Example Mapping

{
  "candidate_id": "CAND12345",
  "rchilli_index_id": "abcde123456"
}

This helps in:

• Tracking indexed documents

• Performing future match or delete operations

How to Get the Index ID Using the API

Step 1: Use the ParseAndIndex API

Use this API to both parse and index the document in one call.

• Endpoint: POST /parseAndIndex

• Returns: IndexId in the response

ParseAndIndex API Documentation

How to Get Document Details Using Index ID

Step 2: Use Get Document Details by Index ID API

You can retrieve document contents using:

• Endpoint: GET /getDocumentDetail

• Parameter: indexId

This will return all parsed and indexed data such as skills, experience, education, etc.

Get Document Detail By Index ID

Additional Operations with Index ID

Maintain the Mapping in Your System

To keep records organized:

Summary

Need Assistance?

• Email: support@rchilli.com

• Full API Guide: Search & Match API Documentation

• Parse and Index Details

• Delete Document API

• Delete All Documents API