How to include Document ID's in Search and Match Methods.

To include Document IDs in the Search and Match methods using RChilli's APIs, you can follow these best practices and guidelines:

Including Document IDs in Search and Match API

1. During Indexing: Attach a Unique Document ID

When using the Index or ParseAndIndex API, you can assign a unique documentid to each resume or job description. This documentid becomes the identifier for that record in the search index.

Sample JSON Request with documentid:

{
"userkey": "your_user_key",
"version": "8.0.0",
"subuserid": "your_subuser_id",
"documentid": "candidate_12345",
"filedata": "base64_encoded_resume",
"filename": "resume.pdf"
}

This documentid will be stored in the index and can be used later to:

• Retrieve the document

• Update the document

• Delete the document

• Identify it in search results

2. In Search Results: Use documentid for Reference

When you perform a Simple Search, Match Resume to Job, or Match Job to Resume, the result will include the associated documentid that was indexed along with the document.

Example Response Snippet:

{
"MatchedDocument": [
{
"documentid": "candidate_12345",
"score": 98.2,
"skillmatch": { ... }
}
]
}

This helps you map the search result back to your internal systems using the same document ID.

3. Deletion or Update Using documentid

To delete or update a document, you must use the same documentid you used during indexing.

• Delete API Endpoint: /deleteDocumentById

• Update API: Call the indexDocument API again with the same documentid, and it will replace the old entry.

Why Use documentid?

• Traceability: Easily map parsed/indexed documents to internal candidate or job IDs.

• Manageability: Update or delete specific records precisely.

• Search Result Mapping: Quickly locate the original document in your database from search results.

Helpful References

• Parse and Index API Documentation

• Delete Document by ID API

• Search and Match Overview

If you have any questions, you can always contact RChilli Support by creating a ticket simply by sending an email to support@rchilli.com.