Skip to content

Latest commit

 

History

History
76 lines (53 loc) · 4.21 KB

OccupationsApi.md

File metadata and controls

76 lines (53 loc) · 4.21 KB
Raw

OpenAPI\Client\OccupationsApi

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

Method HTTP request Description
similarJobtitlesGET() GET /hr/v2/occupations/similar/semantic/ Similar JobTitles

similarJobtitlesGET()

similarJobtitlesGET($query, $size, $min_score, $src_lang, $dst_lang): \OpenAPI\Client\Model\SimilarEntitiesResponse

Similar JobTitles

This method returns the size most similar job titles found in the knowledge base with respect to the input jobtitle. The similarity of each result to the input job title is rated with a score between 0 (minimum similarity) and 1 (maximum similarity). This method can be used to perform a keyword expansion: expanding a job title with its synonyms or semantically similar job titles may be useful, for instance, to improve a job description or to perform a more flexible search with respect to a traditional word match or boolean search system. This method returns a dictionary with keys Hits (the number of job titles returned) and Out, which is a list of dictionaries with two keys: the first key (Term) contains the proposed job title, while the second one (Score) contains its similarity score, as described above. The parameter min_score set the threshold for the similarity score, below which the output skills are discarded; its default value is 0.5. Note that the number of retrieved similar job titles may be smaller than size when the minimum score is larger than 0 or when the searched job title is particularly uncommon.

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\OccupationsApi(
    // 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
);
$query = 'query_example'; // string | Input job title to be analyzed
$size = 10; // int | Number of similar job titles to return.
$min_score = 0.5; // float | Minimum pertinence score.
$src_lang = 'src_lang_example'; // string | Optional. Language of the input job titles.If missing, the detected language is assumed as `src_lang`.
$dst_lang = 'dst_lang_example'; // string | Optional. Destination language in which the output job titles are translated.If missing, the input or detected `src_lang` is assumed as `dst_lang`.

try {
    $result = $apiInstance->similarJobtitlesGET($query, $size, $min_score, $src_lang, $dst_lang);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OccupationsApi->similarJobtitlesGET: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
query string Input job title to be analyzed
size int Number of similar job titles to return. [optional] [default to 10]
min_score float Minimum pertinence score. [optional] [default to 0.5]
src_lang string Optional. Language of the input job titles.If missing, the detected language is assumed as `src_lang`. [optional]
dst_lang string Optional. Destination language in which the output job titles are translated.If missing, the input or detected `src_lang` is assumed as `dst_lang`. [optional]

Return type

\OpenAPI\Client\Model\SimilarEntitiesResponse

Authorization

APIKey

HTTP request headers

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

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