Skip to content

Latest commit

 

History

History
287 lines (204 loc) · 17.3 KB

ResumeToJobAdsApi.md

File metadata and controls

287 lines (204 loc) · 17.3 KB
Raw

OpenAPI\Client\ResumeToJobAdsApi

All URIs are relative to https://api.inda.ai, except if the operation defines another base path.

Method HTTP request Description
matchJobadsEvidenceFromIndexedResumePOST() POST /hr/v2/index/{indexname}/jobads/matching/resume/{resume_id}/evidence/ Match JobAds Evidence from indexed Resume
matchJobadsEvidencePOST() POST /hr/v2/index/{indexname}/jobads/matching/resume/evidence/ Match JobAds Evidence
matchJobadsFromIndexedResumePOST() POST /hr/v2/index/{indexname}/jobads/matching/resume/{resume_id}/ Match JobAds from indexed Resume
matchJobadsPOST() POST /hr/v2/index/{indexname}/jobads/matching/resume/ Match JobAds

matchJobadsEvidenceFromIndexedResumePOST()

matchJobadsEvidenceFromIndexedResumePOST($indexname, $resume_id, $base_jobad_matching_evidence_query): \OpenAPI\Client\Model\MatchJobAdEvidenceResponse

Match JobAds Evidence from indexed Resume

This method can be used for a registered resume; it is analogous to the The Match JobAds Evidence method, but it takes in input the ID of the resume instead of its JSON. Please refer to the Match JobAds Evidence description for further details on the method and on its output.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: APIKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\ResumeToJobAdsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$indexname = 'indexname_example'; // string
$resume_id = 'resume_id_example'; // string
$base_jobad_matching_evidence_query = new \OpenAPI\Client\Model\BaseJobadMatchingEvidenceQuery(); // \OpenAPI\Client\Model\BaseJobadMatchingEvidenceQuery

try {
    $result = $apiInstance->matchJobadsEvidenceFromIndexedResumePOST($indexname, $resume_id, $base_jobad_matching_evidence_query);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResumeToJobAdsApi->matchJobadsEvidenceFromIndexedResumePOST: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
indexname string
resume_id string
base_jobad_matching_evidence_query \OpenAPI\Client\Model\BaseJobadMatchingEvidenceQuery

Return type

\OpenAPI\Client\Model\MatchJobAdEvidenceResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

matchJobadsEvidencePOST()

matchJobadsEvidencePOST($indexname, $jobad_matching_evidence_query, $src_lang): \OpenAPI\Client\Model\MatchJobAdEvidenceResponse

Match JobAds Evidence

This method provides details about the score of a list of job adverts according to the matching with a given resume. The method should be used after the call of Match JobAds or Match JobAds from indexed Resume, on a JobadID or a set of JobadIDs returned by one of these methods, in order to obtain the evidence of the matching score. The relevant information for the matching evidence is the same described in the Match JobAds method. For each job advert ID, the method returns: + a matching score between the job advert's required and preferred EQF level and the candidate's one (if any); + a matching score between the job advert's required and preferred experience durations and the total duration of the candidate's work experiences (if any); + a matching score between the job advert's required and preferred seniorities and the candidate's seniority (if any); + a detail for each skill in the job advert, containing the relative matching score with respect to the resume; + a detail for each job title in the job advert, containing the relative matching score with respect to the resume. Each aforementioned matching score has to be considered as an affinity score between job advert's and candidate's data, which contributes to the final Match JobAds response's Score. Any JobAdID not corresponding to an available job advert in the index indexname will be ignored. Note that the Match JobAds Evidence from indexed Resume, method can be used for a resume which has been already indexed.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: APIKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\ResumeToJobAdsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$indexname = 'indexname_example'; // string
$jobad_matching_evidence_query = new \OpenAPI\Client\Model\JobadMatchingEvidenceQuery(); // \OpenAPI\Client\Model\JobadMatchingEvidenceQuery
$src_lang = 'src_lang_example'; // string | Optional. Language in which the following *Resume.Data* entities are expressed: *Skills*, *WorkExperiences.Skills*, *JobTitles*, *WorkExperiences.PositionTitle* and *Languages*.If missing, the detected *Attachment.CV.PlainText* language is assumed as `src_lang`.

try {
    $result = $apiInstance->matchJobadsEvidencePOST($indexname, $jobad_matching_evidence_query, $src_lang);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResumeToJobAdsApi->matchJobadsEvidencePOST: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
indexname string
jobad_matching_evidence_query \OpenAPI\Client\Model\JobadMatchingEvidenceQuery
src_lang string Optional. Language in which the following Resume.Data entities are expressed: Skills, WorkExperiences.Skills, JobTitles, WorkExperiences.PositionTitle and Languages.If missing, the detected Attachment.CV.PlainText language is assumed as `src_lang`. [optional]

Return type

\OpenAPI\Client\Model\MatchJobAdEvidenceResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

matchJobadsFromIndexedResumePOST()

matchJobadsFromIndexedResumePOST($indexname, $resume_id, $base_jobad_matching_query, $size, $offset, $min_score, $dst_lang, $jobad_langs): \OpenAPI\Client\Model\SearchJobAdMatchResponse

Match JobAds from indexed Resume

This method performs a search among the job adverts in index indexname to find the best matches for a given resume already registered in INDA. To perform the search starting from the resume of a candidate not yet registered in INDA, please use the Match JobAds, method. The method can be used, for instance, in the career page in order to guide the candidate to the best matching with their resume. The method can also be used -- via scheduled execution over a pool of resumes -- to generate for each applicant a feed of suggested job positions which are relevant for them, in order to improve candidate engagement. Skills and job titles are particularly relevant and should be present in the resume to obtain an accurate matching. Other relevant information -- e.g., experience duration, EQF level -- is retrieved from the resume and contributes to the pertinence score of each job adverts, provided that the index contains a sufficient number of job adverts with that information.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: APIKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\ResumeToJobAdsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$indexname = 'indexname_example'; // string
$resume_id = 'resume_id_example'; // string
$base_jobad_matching_query = new \OpenAPI\Client\Model\BaseJobadMatchingQuery(); // \OpenAPI\Client\Model\BaseJobadMatchingQuery
$size = 5; // int | Optional. Number of documents to return.
$offset = 0; // int | Optional. Number of documents to skip. Ignored if *cache* is <code style='color: #333333; opacity: 0.9'>true</code>.
$min_score = 0; // float | Optional. Minimum pertinence score.
$dst_lang = array('dst_lang_example'); // string[] | Results languages. If left empty then the results will not be filtered by language and the they will contain multi-language results.
$jobad_langs = array('jobad_langs_example'); // string[] | DEPRECATED: use <code style='color: #333333; opacity: 0.9'>dst_langs</code> instead. Results languages. If left empty then the results will not be filtered by language.

try {
    $result = $apiInstance->matchJobadsFromIndexedResumePOST($indexname, $resume_id, $base_jobad_matching_query, $size, $offset, $min_score, $dst_lang, $jobad_langs);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResumeToJobAdsApi->matchJobadsFromIndexedResumePOST: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
indexname string
resume_id string
base_jobad_matching_query \OpenAPI\Client\Model\BaseJobadMatchingQuery
size int Optional. Number of documents to return. [optional] [default to 5]
offset int Optional. Number of documents to skip. Ignored if cache is <code style='color: #333333; opacity: 0.9'>true</code>. [optional] [default to 0]
min_score float Optional. Minimum pertinence score. [optional] [default to 0]
dst_lang string[] Results languages. If left empty then the results will not be filtered by language and the they will contain multi-language results. [optional]
jobad_langs string[] DEPRECATED: use <code style='color: #333333; opacity: 0.9'>dst_langs</code> instead. Results languages. If left empty then the results will not be filtered by language. [optional]

Return type

\OpenAPI\Client\Model\SearchJobAdMatchResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

matchJobadsPOST()

matchJobadsPOST($indexname, $jobad_matching_query, $size, $offset, $min_score, $src_lang, $dst_lang, $jobad_langs): \OpenAPI\Client\Model\SearchJobAdMatchResponse

Match JobAds

This method performs a search among the job adverts in index indexname to find the best matches for a given resume. To perform the search starting from a resume already registered in INDA, we suggest to use the Match JobAds from indexed Resume, method. The method can be used, for instance, in the career page in order to guide the candidate to the best matching with their resume. The method can also be used -- via scheduled execution over a pool of resumes -- to generate for each candidate a feed of suggested job positions which are relevant for them, in order to improve candidate engagement. Skills and job titles are particularly relevant and should be present in the resume to obtain an accurate matching. Other relevant information -- e.g., experience duration, EQF level -- is retrieved from the resume and contributes to the pertinence score of each job adverts, provided that the index contains a sufficient number of job adverts with that information. Optionally, a list of query filters (QueryFilters) can be provided to narrow the query. We strongly encourage use of query_filters to reduce computation time and improve the result accuracy.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: APIKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\ResumeToJobAdsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$indexname = 'indexname_example'; // string
$jobad_matching_query = new \OpenAPI\Client\Model\JobadMatchingQuery(); // \OpenAPI\Client\Model\JobadMatchingQuery
$size = 5; // int | Optional. Number of documents to return.
$offset = 0; // int | Optional. Number of documents to skip. Ignored if *cache* is <code style='color: #333333; opacity: 0.9'>true</code>.
$min_score = 0; // float | Optional. Minimum pertinence score.
$src_lang = 'src_lang_example'; // string | Job Description language. If left empty each section's language will detected automatically.
$dst_lang = array('dst_lang_example'); // string[] | Results languages. If left empty then the results will not be filtered by language and the they will contain multi-language results.
$jobad_langs = array('jobad_langs_example'); // string[] | DEPRECATED: use <code style='color: #333333; opacity: 0.9'>dst_langs</code> instead. Results languages. If left empty then the results will not be filtered by language.

try {
    $result = $apiInstance->matchJobadsPOST($indexname, $jobad_matching_query, $size, $offset, $min_score, $src_lang, $dst_lang, $jobad_langs);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResumeToJobAdsApi->matchJobadsPOST: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
indexname string
jobad_matching_query \OpenAPI\Client\Model\JobadMatchingQuery
size int Optional. Number of documents to return. [optional] [default to 5]
offset int Optional. Number of documents to skip. Ignored if cache is <code style='color: #333333; opacity: 0.9'>true</code>. [optional] [default to 0]
min_score float Optional. Minimum pertinence score. [optional] [default to 0]
src_lang string Job Description language. If left empty each section's language will detected automatically. [optional]
dst_lang string[] Results languages. If left empty then the results will not be filtered by language and the they will contain multi-language results. [optional]
jobad_langs string[] DEPRECATED: use <code style='color: #333333; opacity: 0.9'>dst_langs</code> instead. Results languages. If left empty then the results will not be filtered by language. [optional]

Return type

\OpenAPI\Client\Model\SearchJobAdMatchResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]