Skip to content

Latest commit

 

History

History
718 lines (495 loc) · 29 KB

ResumeManagementApi.md

File metadata and controls

718 lines (495 loc) · 29 KB

OpenAPI\Client\ResumeManagementApi

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

Method HTTP request Description
addResumePOST() POST /hr/v2/index/{indexname}/resume/ Add Resume
deletePicDELETE() DELETE /hr/v2/index/{indexname}/resume/{resume_id}/pic/ Delete Pic
deleteResumeDELETE() DELETE /hr/v2/index/{indexname}/resume/{resume_id}/ Delete Resume
getCvGET() GET /hr/v2/index/{indexname}/resume/{resume_id}/document/ Get CV
getCvTextGET() GET /hr/v2/index/{indexname}/resume/{resume_id}/text/ Get CV Text
getPicGET() GET /hr/v2/index/{indexname}/resume/{resume_id}/pic/ Get Pic
getResumeGET() GET /hr/v2/index/{indexname}/resume/{resume_id}/ Get Resume
patchResumePATCH() PATCH /hr/v2/index/{indexname}/resume/{resume_id}/ Patch Resume
resumeStatusGET() GET /hr/v2/index/{indexname}/resume/{resume_id}/status/ Resume Status
updatePicPUT() PUT /hr/v2/index/{indexname}/resume/{resume_id}/pic/ Update Pic
updateResumePUT() PUT /hr/v2/index/{indexname}/resume/{resume_id}/ Update Resume

addResumePOST()

addResumePOST($indexname, $file_item_request, $sync, $resume_id, $src_lang, $dst_lang): \OpenAPI\Client\Model\ItemIdResponse

Add Resume

This method adds a resume to indexname and assigns it a resume_id (namely, a Unique Universal ID or UUID4). On the right, we provide an example of input structure that corresponds to the result of the method Parse Resume. However, the input structure is customizable. Further details can be found in the Resume Model section. Entities among skills, job (or position) titles and languages are automatically mapped by INDAto the adopted knowledge base, so that users can leverage on standardized values.Original values and entity IDs are available in Details.RawValues and Details.Code, respectively.Unrecognized items are ignored and not indexed, except for the WorkExperiences.PositionTitle entities. This method adds the resume to be processed to the server's task queue and return immediately the resume_id. Note that the document may not successfully conclude the processing pipeline (e.g., it may be discarded because duplicate of one of the documents already present in the indexname), and thus it may not be actually added to the index. In order to verify the resume status, the user can use the resume_id through the following methods: + Resume Status + Get Failures For a synchronous approach, use the sync query parameter: if set to true, the resume is processed immediately. However, for standard usage in production environments, we recommend relying on the asynchronous strategy by ignoring this parameter, in order to reduce the response times (due to the heterogeneity of resumes, the response time of each resume processing can vary substantially among different documents). Please note that, for user's convenience, the API credits requests assume that the synchronous approach is named as Add Resume Sync, so that it can be easily distinguished from the asynchronous Add Resume.

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\ResumeManagementApi(
    // 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
$file_item_request = new \OpenAPI\Client\Model\FileItemRequest(); // \OpenAPI\Client\Model\FileItemRequest
$sync = false; // bool | Optional. Whether to wait for the resume processing or not.
$resume_id = 'resume_id_example'; // string | Optional. ID to use for the resume. Already existing IDs will cause a 409 error.
$src_lang = 'src_lang_example'; // string | Optional. Language in which the following *Data* entities are expressed: *Skills*, *WorkExperiences.Skills*, *JobTitles*, *WorkExperiences.PositionTitle* and *Languages*.If missing, the detected *Attachment.CV.File* language is assumed as `src_lang`.
$dst_lang = 'dst_lang_example'; // string | Optional. Destination language in which the following *Data* entities are translated: *Skills*, *WorkExperiences.Skills*, *JobTitles*, *WorkExperiences.PositionTitle* and *Languages*.If missing, the input or detected `src_lang` is assumed as `dst_lang`.

try {
    $result = $apiInstance->addResumePOST($indexname, $file_item_request, $sync, $resume_id, $src_lang, $dst_lang);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResumeManagementApi->addResumePOST: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
indexname string
file_item_request \OpenAPI\Client\Model\FileItemRequest
sync bool Optional. Whether to wait for the resume processing or not. [optional] [default to false]
resume_id string Optional. ID to use for the resume. Already existing IDs will cause a 409 error. [optional]
src_lang string Optional. Language in which the following Data entities are expressed: Skills, WorkExperiences.Skills, JobTitles, WorkExperiences.PositionTitle and Languages.If missing, the detected Attachment.CV.File language is assumed as `src_lang`. [optional]
dst_lang string Optional. Destination language in which the following Data entities are translated: Skills, WorkExperiences.Skills, JobTitles, WorkExperiences.PositionTitle and Languages.If missing, the input or detected `src_lang` is assumed as `dst_lang`. [optional]

Return type

\OpenAPI\Client\Model\ItemIdResponse

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]

deletePicDELETE()

deletePicDELETE($indexname, $resume_id): \OpenAPI\Client\Model\DeleteItemResponse

Delete Pic

This method deletes the profile picture associated with the resume resume_id and sets its profile picture to the default one.

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\ResumeManagementApi(
    // 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

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

Parameters

Name Type Description Notes
indexname string
resume_id string

Return type

\OpenAPI\Client\Model\DeleteItemResponse

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]

deleteResumeDELETE()

deleteResumeDELETE($indexname, $resume_id): \OpenAPI\Client\Model\DeleteItemResponse

Delete Resume

This method deletes the resume associated with resume_id from the index indexname.

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\ResumeManagementApi(
    // 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

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

Parameters

Name Type Description Notes
indexname string
resume_id string

Return type

\OpenAPI\Client\Model\DeleteItemResponse

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]

getCvGET()

getCvGET($indexname, $resume_id): \OpenAPI\Client\Model\BinaryItemResponse

Get CV

This method returns the Base64 encoding and the extension of the document associated with the resume resume_id.

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\ResumeManagementApi(
    // 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

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

Parameters

Name Type Description Notes
indexname string
resume_id string

Return type

\OpenAPI\Client\Model\BinaryItemResponse

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]

getCvTextGET()

getCvTextGET($indexname, $resume_id): \OpenAPI\Client\Model\DocumentTextResponse

Get CV Text

This method returns the text of the document associated with the resume resume_id. Note that this method merely returns the text, since the extraction has occurred during the add/update of the resume.

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\ResumeManagementApi(
    // 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

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

Parameters

Name Type Description Notes
indexname string
resume_id string

Return type

\OpenAPI\Client\Model\DocumentTextResponse

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]

getPicGET()

getPicGET($indexname, $resume_id): \OpenAPI\Client\Model\BinaryPicResponse

Get Pic

This method returns the Base64 encoding and the extension of the profile picture associated with the resume resume_id.

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\ResumeManagementApi(
    // 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

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

Parameters

Name Type Description Notes
indexname string
resume_id string

Return type

\OpenAPI\Client\Model\BinaryPicResponse

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]

getResumeGET()

getResumeGET($indexname, $resume_id): \OpenAPI\Client\Model\GetItemResponse

Get Resume

This method returns the information related to the resume stored with id resume_id in the index indexname. As reported in the schema below, the method has two different response schemas: + a 4xx response is returned when the resume is still in the processing queue, if the processing failed, or if its resume_id has never been seen; + a 200 response is returned if the resume has been successfully processed and inserted in the index.

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\ResumeManagementApi(
    // 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

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

Parameters

Name Type Description Notes
indexname string
resume_id string

Return type

\OpenAPI\Client\Model\GetItemResponse

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]

patchResumePATCH()

patchResumePATCH($indexname, $resume_id, $patch_item_request, $src_lang): \OpenAPI\Client\Model\PatchItemResponse

Patch Resume

This method updates the information related to the resume stored with id resume_id. This method accepts an application/json body with the same structure as Add Resume, however in this case all fields are optional. Fields that contain differences between the corresponding original ones are substituted, while new fields are added. Bear in mind that lists are considered as singular value, therefore to modify an entry in a list it is necessary to insert the full list. Note that this method only modifies the information; in order to change the attached file, please refer to the method Update Resume. Entities among skills, job (or position) titles and languages are automatically mapped by INDAto the adopted knowledge base, so that users can leverage on standardized values.Original values and entity IDs are available in Details.RawValues and Details.Code, respectively.Unrecognized items are ignored and not indexed, except for the WorkExperiences.PositionTitle entities. Please note that, unlike the Add Resume, this function does not allowusers to set a dst_lang, as the one used at index time cannot be changed.It can be retrieved by accessing the Metadata.Language field.

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\ResumeManagementApi(
    // 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
$patch_item_request = new \OpenAPI\Client\Model\PatchItemRequest(); // \OpenAPI\Client\Model\PatchItemRequest
$src_lang = 'src_lang_example'; // string | Optional. Language in which the following *Data* entities are expressed: *Skills*, *WorkExperiences.Skills*, *JobTitles*, *WorkExperiences.PositionTitle* and *Languages*.If missing, the indexed *Attachment.CV.File* language is assumed as `src_lang`.

try {
    $result = $apiInstance->patchResumePATCH($indexname, $resume_id, $patch_item_request, $src_lang);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResumeManagementApi->patchResumePATCH: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

\OpenAPI\Client\Model\PatchItemResponse

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]

resumeStatusGET()

resumeStatusGET($indexname, $resume_id): \OpenAPI\Client\Model\ResumeResponsesStatus

Resume Status

This method returns the status of a resume, which can be any of the following: + Processing: the resume is in INDA process queues; + Available: the resume is in the index and is available to the user; + Duplicate: the resume was a duplicate, refer to the indicated DuplicateID to retrieve the already indexed one; + Failed: the processing of the input failed; + Missing: none of the previous; the resume_id may be wrong or corresponding to a deleted resume.

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\ResumeManagementApi(
    // 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

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

Parameters

Name Type Description Notes
indexname string
resume_id string

Return type

\OpenAPI\Client\Model\ResumeResponsesStatus

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]

updatePicPUT()

updatePicPUT($indexname, $resume_id, $update_pic_request): \OpenAPI\Client\Model\PatchItemResponse

Update Pic

This method updates the profile picture associated with the resume resume_id. The supported extensions are png, jpg, jpeg.

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\ResumeManagementApi(
    // 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
$update_pic_request = {"Attachments":{"Pic":{"File":"<binary of picture>","FileExt":"<extension of picture>"}}}; // \OpenAPI\Client\Model\UpdatePicRequest

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

Parameters

Name Type Description Notes
indexname string
resume_id string
update_pic_request \OpenAPI\Client\Model\UpdatePicRequest

Return type

\OpenAPI\Client\Model\PatchItemResponse

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]

updateResumePUT()

updateResumePUT($indexname, $resume_id, $update_item_request, $src_lang): \OpenAPI\Client\Model\BaseItemIdResponse

Update Resume

This method updates both the information and the CV file (Data.Attachments.CV.File) related to the resume stored with id resume_id. This method manages to update the structured data in the same way Patch Resume does as well as updating the corresponding CV file. It verifies if the file is duplicate with respect to the data already present into the indexname. If it finds a possible duplicate with the same resume_id (if one is reuploading the same CV file) it proceeds updating the structured data, skipping the file update, while it manages to completely delete the item resume_id if the file is found on indexname but associated with a resume with different resume_id. The method will enqueue the task and immediately return a response in an asynchronous fashion. In order to verify the resume_id status one could rely on: + Resume Status + Get Failures Entities among skills, job (or position) titles and languages are automatically mapped by INDAto the adopted knowledge base, so that users can leverage on standardized values.Original values and entity IDs are available in Details.RawValues and Details.Code, respectively.Unrecognized items are ignored and not indexed, except for the WorkExperiences.PositionTitle entities. Please note that, unlike the Add Resume, this function does not allowusers to set a dst_lang, as the one used at index time cannot be changed.It can be retrieved by accessing the Metadata.Language field.

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\ResumeManagementApi(
    // 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
$update_item_request = new \OpenAPI\Client\Model\UpdateItemRequest(); // \OpenAPI\Client\Model\UpdateItemRequest
$src_lang = 'src_lang_example'; // string | Optional. Language in which the following *Data* entities are expressed: *Skills*, *WorkExperiences.Skills*, *JobTitles*, *WorkExperiences.PositionTitle* and *Languages*.If missing, the detected *Attachment.CV.File* language is assumed as `src_lang`.

try {
    $result = $apiInstance->updateResumePUT($indexname, $resume_id, $update_item_request, $src_lang);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResumeManagementApi->updateResumePUT: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

\OpenAPI\Client\Model\BaseItemIdResponse

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]