Home
API Information
RChilli's API suite enables quick and seamless integration, giving users easy access to all RChilli services. From resume parsing to job management and advanced search, our APIs simplify and automate HR processes, enhancing recruitment efficiency.
Search and Match
The endpoints indicate how you access the resource, while the method indicates the allowed interactions (such as GET, POST, or DELETE) with the resource.
Features
The following topics in this section describe the features of the Search and Match.
Sorting
You can sort Resume and JD search results by selecting further fields in the sorting parameter.

Getting Started
The section guide you through an overview of RChilli and the initial steps for setting up and using the products.
API Information
RChilli's API suite enables quick and seamless integration, giving users easy access to all RChilli services. From resume parsing to job management and advanced search, our APIs simplify and automate HR processes, enhancing recruitment efficiency.
- Resume Parser
  The endpoints indicate how you access the resource, while the method indicates the allowed interactions (such as GET, POST, or DELETE) with the resource.
- JD Parser
  The endpoints indicate how you access the resource, while the method indicates the allowed interactions (such as GET, POST, or DELETE) with the resource.
- Search and Match
  The endpoints indicate how you access the resource, while the method indicates the allowed interactions (such as GET, POST, or DELETE) with the resource.
  - API Authentication
    Search and Match API uses private user key (index key) to authenticate requests. To authenticate the call to an API endpoint, there are only 3 steps:
  - Search and Match Endpoints
    This section provides detailed information on the various endpoints available in the Search and Match API.
  - Features
    The following topics in this section describe the features of the Search and Match.
    - Geographical Search
      This feature is used to find a candidate near you through geographical search in simple and advance search methods.
    - Facets
      Facet is a list of values with the count of documents in which these values are found. Facets are displayed on the left side of the page while searching for Resume's and JD's.
    - Filter
      You can filter Resume and JD search results by selecting further fields in the Facets.
    - Sorting
      You can sort Resume and JD search results by selecting further fields in the sorting parameter.
    - Ignore/Exclude Filter
      This feature is used to filter the results by ignoring/removing fields as necessary from the result. This feature is used by simply adding '-' (minus symbol) in front of the fields that you want to ignore/remove from the result.
    - Include Document ID
      This feature searches and matches the documents whose indexed IDs are passed in the API request.
    - Exclude Document ID
      This feature searches and matches all the indexed documents except the documents whose indexed IDs are passed in the API request.
    - Pagination
      Pagination helps you to fetch data in batches call as a page.
    - Explain Score
      This feature is to get a detailed score of search fields that matches with the search result.
    - Custom Weightage/Scoring
      This is the weightage of fields for search and match fields that can be customized as per the requirement.
    - DeDuplication
      Deduplication helps to avoid indexing duplicate records in the search engine.
    - Partial Match
      Partial Match helps to search the documents based on the words in the keyword.
    - Custom Value
      Custom Value helps to index documents with the custom values.
    - Field Lists
      Currently, Search and Match API returns the default fields (entities) in the response (fields in the records array). Now with the fieldList parameter in the Search and Match API request, you can customize the fields in the API response. See the example in Table 1. Simple Search request and response with and without fieldList parameter.
    - Dynamic Weightage
      The weightage for the Search and Match entities in the API response can be customized by passing the dynamic weightage in the Search and Match API input.
    - Date Range
      This feature searches and matches all the indexed documents based on the date range passed in the API request.
    - Required Match Fields
      The entities specified within the requiredMatchFields parameter of the Search and Match API request are considered as mandatory criteria for searching and matching, with an 'AND' condition applied between the entities.
    - Experience Range Deviation
      The experienceRangeDeviation parameter when passed in the search and match API request and if it is TRUE, then the search result is based on the criteria as describe in this topic.
    - Dynamic Field Matching
      Currently, the search and match API perform matching on all available entities within the Resume/JD. If the user wants to match with a specific entity in the resume/JD, they can use the dynamicMatchFields parameter in the API input.
    - Match using Indexed IDs
      This topic describe the procedure on how you can match resume or JD using the document indexed IDs.
    - Match Degree with Specialization
      This topic describe the procedure on how you can match the Specialization entity along with Degree of the candidate.
    - Skill Ranking
      Skill ranking extracts, organizes, and weights key skills to prioritize the top 30 for matching based on relevance, recency, and proficiency.
    - Skill Type
      This topic describe the procedure on how you can get the skillType in the Search and Match API response.
    - Source Type
      This topic describe the procedure on how you can get the Source Type in the Search and Match API response.
    - Job Zone Weightage
      Job Zones categorize job profiles into one of five categories based on the required levels of education, experience, and training.
    - Zero Score Weightage
      Currently, in the SearchAndMatch API, entities are returned with weightage when a document is matched but if no document is matched then entities with weightage are not returned.
    - Semantic Search
      This topic describe the procedure on how you can do the semantic search in the Search and Match API.
    - Ontology Search
      This topic describe the procedure on how you can use the Ontology search in the Search and Match API.
    - Degree Weight Optimization
      The Search and Match degree matching for JD to resume has been enhanced with the Degree Weight Optimization feature.
    - Source Value
      When you use the Search and Match API to compare Resumes with Job Descriptions (JDs), it is important to know which values from the source document (like a JD) are being used for matching. This helps you better understand the results that the API returns. This topic explains on how to find the source value in the API response to make your matching results clearer.
  - Response Schema
    The following table describe the Search and Match fields.
  - Request Example
    To get the search and match output data, send a POST request using search and match endpoints, methods, and parameters.
  - Response Example
    Follow the below sample search and match response in the JSON format.
  - Language Support
    RChilli Search and Match supports searching in multiple languages, it does not require any separate configuration. The Search and Match auto-identifies the languages of the Resume/JD and extracts the information.
  - Error Code
    This topic lists the error codes of Search and Match Error Code.
- Taxonomy
  The endpoints indicate how you access the resource, while the method indicates the allowed interactions (such as GET, POST, or DELETE) with the resource.
- Resume Redactor
  RChilli Resume Redactor API helps in masking resumes before sending them to the employer.
- Plugins
  The RChilli provides Plugins, such as Resume_Templater_plugin.html, Document_Converter_plugin.html, NER_Tagger_plugin.html, Contact Extractor, GeoLocation_plugin.html, Job_Zone_Plugin.html, and flexisense_requests_plugin_overview.html that extend the capabilities of the RChilli products.
My Account and Features
The My Account application serves as a central hub for users to demo all RChilli API integrations, view API test results, and access their Userkey for authentication.
RChilli Marketplace
The resume parser output can be enriched by activating the other application workflows that are listed on the Enrichment Marketplace such as Lusha, BOLD, Toofr, Rchilli Redact, LLM Parser, etc.
ERP Integration
The components of RChilli application can be integrated with the Oracle HCM Cloud, Oracle PeopleSoft, Salesforce, SAP, and ServiceNow Application.
Release Notes
Release notes comprise new features, improvements, and bug fixes for the following RChilli products.
Glossary
The glossary includes terms and definitions in RChilli Knowledge Center.

Sorting

You can sort Resume and JD search results by selecting further fields in the sorting parameter.

The sorting is an optional parameter (query) that can be passed in the API request of Simple Search, Boolean Search, and Match. Once sorting is passed in the request parameter of Simple Search and Boolean Search, it will return the resume/JD results that fulfills the sorting query, see below sorting sample query:

JSON request with Sorting parameter

Note:

The sort parameter arranges search results in either ascending (asc) or descending (desc) order.
When more than one sort criteria is provided, the second entry will only be used if the first entry results in a tie. If there is a third entry, it will only be used if the first and second entries are tied. This pattern continues with further entries.

"sorting":[
      {
        "field" : "Field Name 1",
        "order" : "asc/desc"
      },
	  {
        "field" : "Field Name 2",
        "order" : "asc/desc"
      }
]

The following fields can be used in the sorting (above) parameter:

Table 1. Facets Results
Resume Sorting Fields	JD Sorting Fields
score	score
ResumeDate	JDDate
ResumeLanguage	JobProfileTitle
ResumeCountry	JobLocationCity
DateOfBirth	JobLocationState
Category	Organization
SubCategory	MinimumYearsExperience
CurrentJobProfile	MaximumYearsExperience
CurrentEmployer	SalaryMinAmount
TotalExperienceInMonths	SalaryMaxAmount
TotalExperienceInYear	TotalExperienceRange
TotalExperienceRange
Institute
City
State
Country
ZipCode

Note: The Sorting can be applied on the custom values that are indexed into search engine. See below JSON request.


"sorting": [
        {
            "field": {
                "customValue": [
                    {
                        "field": "Field Name 1",
                        "order": "asc/desc"
                    }
                ]
            }
        }
    ],

Note: The Sorting with the custom fields is applicable only with the string type of custom fields.