com.sovren

Class SovrenClient

java.lang.Object

com.sovren.SovrenClient

public class SovrenClient
extends Object

The SDK client to perform Sovren API calls.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	ShowFullRequestBodyInExceptions Set to true for debugging API errors.

Constructor Summary

Constructors

Constructor and Description
SovrenClient(String accountId, String serviceKey, DataCenter dataCenter) Create an SDK client to perform Sovren API calls with the account information found at https://portal.sovren.com
SovrenClient(String accountId, String serviceKey, DataCenter dataCenter, List<String> trackingTags) Create an SDK client to perform Sovren API calls with the account information found at https://portal.sovren.com

Method Summary

Modifier and Type	Method and Description
ProfessionsAutoCompleteResponse	autocompleteProfession(String prefix) Returns normalized professions that begin with a given prefix, based on the default language of english.
ProfessionsAutoCompleteResponse	autocompleteProfession(String prefix, List<String> languages, String outputLanguage, int limit) Returns normalized professions that begin with a given prefix, based on the chosen language(s).
AutoCompleteSkillsResponse	autocompleteSkill(String prefix) Returns normalized skills that begin with a given prefix, based on the chosen language(s).
AutoCompleteSkillsResponse	autocompleteSkill(String prefix, List<String> languages, String outputLanguage, List<String> types, int limit) Returns normalized skills that begin with a given prefix, based on the chosen language(s).
<TTarget extends IParsedDocWithId> BimetricScoreResponse	bimetricScore(ParsedJobWithId sourceJob, List<TTarget> targetDocuments, CategoryWeights preferredWeights, SearchMatchSettings settings) Score one or more target documents against a source job
<TTarget extends IParsedDocWithId> BimetricScoreResponse	bimetricScore(ParsedResumeWithId sourceResume, List<TTarget> targetDocuments, CategoryWeights preferredWeights, SearchMatchSettings settings) Score one or more target documents against a source resume
CompareProfessionsResponse	compareProfessions(int profession1, int profession2) Compare two professions based on the skills associated with each.
CompareSkillsToProfessionResponse	compareSkillsToProfessions(int professionCodeId, String... skillIds) Compare a given set of skills to the skills related to a given profession.
CompareSkillsToProfessionResponse	compareSkillsToProfessions(ParsedResume resume, int professionCodeId) Compare the skills of a candidate to the skills related to a job using the Ontology API.
CreateIndexResponse	createIndex(IndexType type, String indexId) Create a new index
DeleteDocumentResponse	deleteDocument(String indexId, String documentId) Delete an existing document from an index
DeleteIndexResponse	deleteIndex(String indexId) Delete an existing index.
DeleteMultipleDocumentsResponse	deleteMultipleDocuments(String indexId, List<String> documentIds) Delete a group of existing documents from an index
ExtractSkillsResponse	extractSkills(String text) Extracts known skills from the given text.
ExtractSkillsResponse	extractSkills(String text, String language, String outputLanguage, float threshold) Extracts known skills from the given text.
GeocodeJobResponse	geocode(ParsedJob job, Address address, GeocodeCredentials geocodeCredentials) Use this if you would like to provide an address for geocoding instead of using the one in the parsed job.
GeocodeJobResponse	geocode(ParsedJob job, GeocodeCredentials geocodeCredentials) Uses the address in the job (if present) to look up geocoordinates and add them into the ParsedJob object.
GeocodeResumeResponse	geocode(ParsedResume resume, Address address, GeocodeCredentials geocodeCredentials) Use this if you would like to provide an address for geocoding instead of using the one in the parsed resume.
GeocodeResumeResponse	geocode(ParsedResume resume, GeocodeCredentials geocodeCredentials) Uses the address in the resume (if present) to look up geocoordinates and add them into the ParsedResume object.
GeocodeAndIndexJobResponse	geocodeAndIndex(ParsedJob job, IndexSingleDocumentInfo indexingOptions, Address address, boolean indexIfGeocodeFails, GeocodeCredentials geocodeCredentials) Use this if you would like to provide an address for geocoding instead of using the one in the parsed rjobesume.
GeocodeAndIndexJobResponse	geocodeAndIndex(ParsedJob job, IndexSingleDocumentInfo indexingOptions, boolean indexIfGeocodeFails, GeocodeCredentials geocodeCredentials) Uses the address in the job (if present) to look up geocoordinates and add them into the ParsedJob object.
GeocodeAndIndexJobResponse	geocodeAndIndex(ParsedJob job, IndexSingleDocumentInfo indexingOptions, GeoCoordinates coordinates, boolean indexIfGeocodeFails, GeocodeCredentials geocodeCredentials) Use this if you already have latitude/longitude coordinates and simply wish to add them to your parsed job.
GeocodeAndIndexResumeResponse	geocodeAndIndex(ParsedResume resume, IndexSingleDocumentInfo indexingOptions, Address address, boolean indexIfGeocodeFails, GeocodeCredentials geocodeCredentials) Use this if you would like to provide an address for geocoding instead of using the one in the parsed resume.
GeocodeAndIndexResumeResponse	geocodeAndIndex(ParsedResume resume, IndexSingleDocumentInfo indexingOptions, boolean indexIfGeocodeFails, GeocodeCredentials geocodeCredentials) Uses the address in the resume (if present) to look up geocoordinates and add them into the ParsedResume object.
GeocodeAndIndexResumeResponse	geocodeAndIndex(ParsedResume resume, IndexSingleDocumentInfo indexingOptions, GeoCoordinates coordinates, boolean indexIfGeocodeFails, GeocodeCredentials geocodeCredentials) Use this if you already have latitude/longitude coordinates and simply wish to add them to your parsed resume.
GetAccountInfoResponse	getAccountInfo() Get the account info (remaining credits, max concurrency, etc).
GetAllIndexesResponse	getAllIndexes() Get all existing indexes
GetJobResponse	getJob(String indexId, String documentId) Retrieve an existing job from an index
GetProfessionsTaxonomyResponse	getProfessionsTaxonomy() Get all professions in the taxonomy with associated IDs and descriptions in all supported languages.
GetProfessionsTaxonomyResponse	getProfessionsTaxonomy(String language, TaxonomyFormat format) Get all professions in the taxonomy with associated IDs and descriptions in all supported languages.
GetMetadataResponse	getProfessionsTaxonomyMetadata() Get metadata about the professions taxonomy/service.
GetResumeResponse	getResume(String indexId, String documentId) Retrieve an existing resume from an index
GetSkillsTaxonomyResponse	getSkillsTaxonomy() Get all skills in the taxonomy with associated IDs and descriptions in all supported languages.
GetSkillsTaxonomyResponse	getSkillsTaxonomy(TaxonomyFormat format) Get all skills in the taxonomy with associated IDs and descriptions in all supported languages.
GetMetadataResponse	getSkillsTaxonomyMetadata() Get metadata about the skills taxonomy/service.
IndexDocumentResponse	indexDocument(ParsedJob job, String indexId, String documentId, List<String> userDefinedTags) Add a job to an existing index
IndexDocumentResponse	indexDocument(ParsedResume resume, String indexId, String documentId, List<String> userDefinedTags) Add a resume to an existing index
IndexMultipleDocumentsResponse	indexMultipleJobs(List<IndexJobInfo> jobs, String indexId) Add several jobs to an existing index
IndexMultipleDocumentsResponse	indexMultipleResumes(List<IndexResumeInfo> resumes, String indexId) Add several resumes to an existing index
LookupProfessionCodesResponse	lookupProfessions(List<Integer> codeIds) Get details for the given professions in the taxonomy.
LookupProfessionCodesResponse	lookupProfessions(List<Integer> codeIds, String outputLanguage) Get details for the given professions in the taxonomy.
LookupSkillCodesResponse	lookupSkills(List<String> skillIds) Get the details associated with given skills in the taxonomy.
LookupSkillCodesResponse	lookupSkills(List<String> skillIds, String outputLanguage) Get the details associated with given skills in the taxonomy.
MatchResponse	match(ParsedJob job, List<String> indexesToQuery, CategoryWeights preferredWeights, FilterCriteria filters, SearchMatchSettings settings, int numResults) Find matches for a non-indexed job.
MatchResponse	match(ParsedResume resume, List<String> indexesToQuery, CategoryWeights preferredWeights, FilterCriteria filters, SearchMatchSettings settings, int numResults) Find matches for a non-indexed resume.
MatchResponse	match(String indexId, String documentId, List<String> indexesToQuery, CategoryWeights preferredWeights, FilterCriteria filters, SearchMatchSettings settings, int numResults) Find matches for a resume or job that is already indexed
NormalizeProfessionsResponse	normalizeProfessions(List<String> jobTitles) Normalize the given job titles to the most closely-related professions in the taxonomy.
NormalizeProfessionsResponse	normalizeProfessions(List<String> jobTitles, String language, String outputLanguage) Normalize the given job titles to the most closely-related professions in the taxonomy.
NormalizeSkillsResponse	normalizeSkills(List<String> skills) Normalize the given skills to the most closely-related skills in the taxonomy.
NormalizeSkillsResponse	normalizeSkills(List<String> skills, String language, String outputLanguage) Normalize the given skills to the most closely-related skills in the taxonomy.
ParseJobResponse	parseJob(ParseRequest request) Parse a job
ParseResumeResponse	parseResume(ParseRequest request) Parse a resume
SearchResponse	search(List<String> indexesToQuery, FilterCriteria query, SearchMatchSettings settings, PaginationSettings pagination) Search for resumes or jobs that meet specific criteria
SuggestProfessionsResponse	suggestProfessions(List<String> skillIds) Suggest professions based on a given set of skill IDs.
SuggestProfessionsResponse	suggestProfessions(List<String> skillIds, int limit, boolean returnMissingSkills) Suggest professions based on a given set of skill IDs.
SuggestProfessionsResponse	suggestProfessions(ParsedJob job) Suggest professions based on the skills within a given job.
SuggestProfessionsResponse	suggestProfessions(ParsedJob job, int limit, boolean returnMissingSkills) Suggest professions based on the skills within a given job.
SuggestProfessionsResponse	suggestProfessions(ParsedResume resume) Suggest professions based on the skills within a given resume.
SuggestProfessionsResponse	suggestProfessions(ParsedResume resume, int limit, boolean returnMissingSkills) Suggest professions based on the skills within a given resume.
SuggestSkillsResponse	suggestSkills(List<Integer> professionCodeIds) Suggests skills related to given professions.
SuggestSkillsResponse	suggestSkills(List<Integer> professionCodeIds, int limit) Suggests skills related to given professions.
SuggestSkillsResponse	suggestSkills(ParsedJob job) Suggests skills related to a job based on the profession title in the job.
SuggestSkillsResponse	suggestSkills(ParsedJob job, int limit) Suggests skills related to a job based on the profession title in the job.
SuggestSkillsResponse	suggestSkills(ParsedResume resume) Suggests skills related to a resume based on the recent professions in the resume.
SuggestSkillsResponse	suggestSkills(ParsedResume resume, int limit) Suggests skills related to a resume based on the recent professions in the resume.
SovrenUIClient	ui(MatchUISettings uiOptions) Access methods for generating Sovren Matching UI sessions.
UpdateUserDefinedTagsResponse	updateJobUserDefinedTags(String indexId, String documentId, List<String> userDefinedTags, UserDefinedTagsMethod method) Updates the user-defined tags for a job
UpdateUserDefinedTagsResponse	updateResumeUserDefinedTags(String indexId, String documentId, List<String> userDefinedTags, UserDefinedTagsMethod method) Updates the user-defined tags for a resume

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ShowFullRequestBodyInExceptions

public boolean ShowFullRequestBodyInExceptions

Set to true for debugging API errors. It will show the full JSON request body in SovrenException.RequestBody
NOTE: do not set this to true in your production system, as it increases the memory footprint

Constructor Detail

SovrenClient

public SovrenClient(String accountId,
                    String serviceKey,
                    DataCenter dataCenter)

Create an SDK client to perform Sovren API calls with the account information found at https://portal.sovren.com

Parameters:

accountId - - The account id for your account

serviceKey - - The service key for your account

dataCenter - - The Data Center for your account. Either DataCenter.US, DataCenter.EU, or @link DataCenter#AU}

Throws:

IllegalArgumentException - if the accountId, serviceKey, or dataCenter are null/empty

SovrenClient

public SovrenClient(String accountId,
                    String serviceKey,
                    DataCenter dataCenter,
                    List<String> trackingTags)

Create an SDK client to perform Sovren API calls with the account information found at https://portal.sovren.com

Parameters:

accountId - - The account id for your account

serviceKey - - The service key for your account

dataCenter - - The Data Center for your account. Either DataCenter.US, DataCenter.EU or DataCenter.AU

trackingTags - - Optional tags to use to track API usage for your account

Throws:

IllegalArgumentException - if the accountId, serviceKey, or dataCenter are null/empty

Method Detail

getAccountInfo

public GetAccountInfoResponse getAccountInfo()
                                      throws SovrenException

Get the account info (remaining credits, max concurrency, etc).

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

parseResume

public ParseResumeResponse parseResume(ParseRequest request)
                                throws SovrenException

Parse a resume

Parameters:

request - The request body

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

parseJob

public ParseJobResponse parseJob(ParseRequest request)
                          throws SovrenException

Parse a job

Parameters:

request - The request body

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

createIndex

public CreateIndexResponse createIndex(IndexType type,
                                       String indexId)
                                throws SovrenException

Create a new index

Parameters:

type - The type of documents stored in this index. Either 'Resume' or 'Job'

indexId - The ID to assign to the new index. This is restricted to alphanumeric with dashes and underscores. All values will be converted to lower-case.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

getAllIndexes

public GetAllIndexesResponse getAllIndexes()
                                    throws SovrenException

Get all existing indexes

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

deleteIndex

public DeleteIndexResponse deleteIndex(String indexId)
                                throws SovrenException

Delete an existing index. Note that this is a destructive action and cannot be undone. All the documents in this index will be deleted.

Parameters:

indexId - The index to delete (case-insensitive).

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

indexDocument

public IndexDocumentResponse indexDocument(ParsedResume resume,
                                           String indexId,
                                           String documentId,
                                           List<String> userDefinedTags)
                                    throws SovrenException

Add a resume to an existing index

Parameters:

resume - A resume generated by the Sovren Resume Parser

indexId - The index the document should be added into (case-insensitive).

documentId - The ID to assign to the new document. This is restricted to alphanumeric with dashes and underscores. All values will be converted to lower-case.

userDefinedTags - The user-defined tags that the resume should have, or null

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

indexDocument

public IndexDocumentResponse indexDocument(ParsedJob job,
                                           String indexId,
                                           String documentId,
                                           List<String> userDefinedTags)
                                    throws SovrenException

Add a job to an existing index

Parameters:

job - A job generated by the Sovren Job Parser

indexId - The index the document should be added into (case-insensitive).

documentId - The ID to assign to the new document. This is restricted to alphanumeric with dashes and underscores. All values will be converted to lower-case.

userDefinedTags - The user-defined tags that the resume should have, or null

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

indexMultipleResumes

public IndexMultipleDocumentsResponse indexMultipleResumes(List<IndexResumeInfo> resumes,
                                                           String indexId)
                                                    throws SovrenException

Add several resumes to an existing index

Parameters:

resumes - The resumes generated by the Sovren Resume Parser paired with their DocumentIds

indexId - The index the documents should be added into (case-insensitive).

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

indexMultipleJobs

public IndexMultipleDocumentsResponse indexMultipleJobs(List<IndexJobInfo> jobs,
                                                        String indexId)
                                                 throws SovrenException

Add several jobs to an existing index

Parameters:

jobs - The jobs generated by the Sovren Job Parser paired with their DocumentIds

indexId - The index the documents should be added into (case-insensitive).

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

deleteDocument

public DeleteDocumentResponse deleteDocument(String indexId,
                                             String documentId)
                                      throws SovrenException

Delete an existing document from an index

Parameters:

indexId - The index containing the document

documentId - The ID of the document to delete

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

deleteMultipleDocuments

public DeleteMultipleDocumentsResponse deleteMultipleDocuments(String indexId,
                                                               List<String> documentIds)
                                                        throws SovrenException

Delete a group of existing documents from an index

Parameters:

indexId - The index containing the documents

documentIds - The IDs of the documents to delete

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

getResume

public GetResumeResponse getResume(String indexId,
                                   String documentId)
                            throws SovrenException

Retrieve an existing resume from an index

Parameters:

indexId - The index containing the resume

documentId - The ID of the resume to retrieve

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

getJob

public GetJobResponse getJob(String indexId,
                             String documentId)
                      throws SovrenException

Retrieve an existing job from an index

Parameters:

indexId - The index containing the job

documentId - The ID of the job to retrieve

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

updateResumeUserDefinedTags

public UpdateUserDefinedTagsResponse updateResumeUserDefinedTags(String indexId,
                                                                 String documentId,
                                                                 List<String> userDefinedTags,
                                                                 UserDefinedTagsMethod method)
                                                          throws SovrenException

Updates the user-defined tags for a resume

Parameters:

indexId - The index containing the resume

documentId - The ID of the resume to update

userDefinedTags - The user-defined tags to add/delete/etc

method - Which method to use for the specified user-defined tags

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

updateJobUserDefinedTags

public UpdateUserDefinedTagsResponse updateJobUserDefinedTags(String indexId,
                                                              String documentId,
                                                              List<String> userDefinedTags,
                                                              UserDefinedTagsMethod method)
                                                       throws SovrenException

Updates the user-defined tags for a job

Parameters:

indexId - The index containing the job

documentId - The ID of the job to update

userDefinedTags - The user-defined tags to add/delete/etc

method - Which method to use for the specified user-defined tags

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

match

public MatchResponse match(ParsedResume resume,
                           List<String> indexesToQuery,
                           CategoryWeights preferredWeights,
                           FilterCriteria filters,
                           SearchMatchSettings settings,
                           int numResults)
                    throws SovrenException

Find matches for a non-indexed resume.

Parameters:

resume - The resume (generated by the Sovren Resume Parser) to use as the source for a match query

indexesToQuery - The indexes to find results in. These must all be of the same type (resumes or jobs)

preferredWeights - The preferred category weights for scoring the results. If null, Sovren will determine the best values based on the source resume

filters - Any filters to apply prior to the match (a result must satisfy all the filters), or null

settings - The settings for this match request. Use null for defaults.

numResults - The number of results to show. Use 0 for the default.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

match

public MatchResponse match(ParsedJob job,
                           List<String> indexesToQuery,
                           CategoryWeights preferredWeights,
                           FilterCriteria filters,
                           SearchMatchSettings settings,
                           int numResults)
                    throws SovrenException

Find matches for a non-indexed job.

Parameters:

job - The job (generated by the Sovren Job Parser) to use as the source for a match query

indexesToQuery - The indexes to find results in. These must all be of the same type (resumes or jobs)

preferredWeights - The preferred category weights for scoring the results. If null, Sovren will determine the best values based on the source job

filters - Any filters to apply prior to the match (a result must satisfy all the filters), or null

settings - The settings for this match request. Use null for defaults.

numResults - The number of results to show. Use 0 for the default.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

match

public MatchResponse match(String indexId,
                           String documentId,
                           List<String> indexesToQuery,
                           CategoryWeights preferredWeights,
                           FilterCriteria filters,
                           SearchMatchSettings settings,
                           int numResults)
                    throws SovrenException

Find matches for a resume or job that is already indexed

Parameters:

indexId - The index containing the document you want to match

documentId - The ID of the document to match

indexesToQuery - The indexes to find results in. These must all be of the same type (resumes or jobs)

preferredWeights - The preferred category weights for scoring the results. If null, Sovren will determine the best values based on the source resume/job

filters - Any filters to apply prior to the match (a result must satisfy all the filters), or null

settings - The settings for this match request. Use null for defaults.

numResults - The number of results to show. Use 0 for the default.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

search

public SearchResponse search(List<String> indexesToQuery,
                             FilterCriteria query,
                             SearchMatchSettings settings,
                             PaginationSettings pagination)
                      throws SovrenException

Search for resumes or jobs that meet specific criteria

Parameters:

indexesToQuery - The indexes to find results in. These must all be of the same type (resumes or jobs)

query - The search query. A result must satisfy all of these criteria

settings - The settings for this search request. Use null for defaults.

pagination - Pagination settings. Use null for defaults.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

bimetricScore

public <TTarget extends IParsedDocWithId> BimetricScoreResponse bimetricScore(ParsedResumeWithId sourceResume,
                                                                              List<TTarget> targetDocuments,
                                                                              CategoryWeights preferredWeights,
                                                                              SearchMatchSettings settings)
                                                                       throws SovrenException

Score one or more target documents against a source resume

Type Parameters:

TTarget - Either ParsedResumeWithId or ParsedJobWithId

Parameters:

sourceResume - The source resume

targetDocuments - The target resumes/jobs

preferredWeights - The preferred category weights for scoring the results. If null, Sovren will determine the best values based on the source resume.

settings - The settings for this search request. Use null for defaults.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

bimetricScore

public <TTarget extends IParsedDocWithId> BimetricScoreResponse bimetricScore(ParsedJobWithId sourceJob,
                                                                              List<TTarget> targetDocuments,
                                                                              CategoryWeights preferredWeights,
                                                                              SearchMatchSettings settings)
                                                                       throws SovrenException

Score one or more target documents against a source job

Type Parameters:

TTarget - Either ParsedResumeWithId or ParsedJobWithId

Parameters:

sourceJob - The source job

targetDocuments - The target resumes/jobs

preferredWeights - The preferred category weights for scoring the results. If null, Sovren will determine the best values based on the source job.

settings - The settings for this search request. Use null for defaults.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

geocode

public GeocodeResumeResponse geocode(ParsedResume resume,
                                     GeocodeCredentials geocodeCredentials)
                              throws SovrenException

Uses the address in the resume (if present) to look up geocoordinates and add them into the ParsedResume object. These coordinates are used by the AI Searching/Matching engine.

Parameters:

resume - The resume to insert the geocoordinates (from the address) into

geocodeCredentials - - The credentials you want to use for geocoding (use null for Sovren credentials)

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurred

geocode

public GeocodeResumeResponse geocode(ParsedResume resume,
                                     Address address,
                                     GeocodeCredentials geocodeCredentials)
                              throws SovrenException

Use this if you would like to provide an address for geocoding instead of using the one in the parsed resume. The address included in the parsed resume (if present) will not be modified.

Parameters:

resume - The resume to insert the geocoordinates (from the address) into

address - The address to use to retrieve geocoordinates

geocodeCredentials - - The credentials you want to use for geocoding (use null for Sovren credentials)

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurred

geocode

public GeocodeJobResponse geocode(ParsedJob job,
                                  GeocodeCredentials geocodeCredentials)
                           throws SovrenException

Uses the address in the job (if present) to look up geocoordinates and add them into the ParsedJob object. These coordinates are used by the AI Searching/Matching engine.

Parameters:

job - The job to insert the geocoordinates (from the address) into

geocodeCredentials - - The credentials you want to use for geocoding (use null for Sovren credentials)

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurred

geocode

public GeocodeJobResponse geocode(ParsedJob job,
                                  Address address,
                                  GeocodeCredentials geocodeCredentials)
                           throws SovrenException

Use this if you would like to provide an address for geocoding instead of using the one in the parsed job. The address included in the parsed job (if present) will not be modified.

Parameters:

job - The job to insert the geocoordinates (from the address) into

address - The address to use to retrieve geocoordinates

geocodeCredentials - - The credentials you want to use for geocoding (use null for Sovren credentials)

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurred

geocodeAndIndex

public GeocodeAndIndexResumeResponse geocodeAndIndex(ParsedResume resume,
                                                     IndexSingleDocumentInfo indexingOptions,
                                                     boolean indexIfGeocodeFails,
                                                     GeocodeCredentials geocodeCredentials)
                                              throws SovrenException

Uses the address in the resume (if present) to look up geocoordinates and add them into the ParsedResume object. These coordinates are used by the AI Searching/Matching engine.

Parameters:

resume - The resume to geocode

indexingOptions - What index/document id to use to index the document after geocoding

indexIfGeocodeFails - Indicates whether or not the document should still be added to the index if the geocode request fails.

geocodeCredentials - - The credentials you want to use for geocoding (use null for Sovren credentials)

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurred

geocodeAndIndex

public GeocodeAndIndexResumeResponse geocodeAndIndex(ParsedResume resume,
                                                     IndexSingleDocumentInfo indexingOptions,
                                                     Address address,
                                                     boolean indexIfGeocodeFails,
                                                     GeocodeCredentials geocodeCredentials)
                                              throws SovrenException

Use this if you would like to provide an address for geocoding instead of using the one in the parsed resume. The address included in the parsed resume (if present) will not be modified.

Parameters:

resume - The resume to insert the geocoordinates (from the address) into

indexingOptions - What index/document id to use to index the document after geocoding

address - The address to use to retrieve geocoordinates

indexIfGeocodeFails - Indicates whether or not the document should still be added to the index if the geocode request fails.

geocodeCredentials - - The credentials you want to use for geocoding (use null for Sovren credentials)

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurred

geocodeAndIndex

public GeocodeAndIndexResumeResponse geocodeAndIndex(ParsedResume resume,
                                                     IndexSingleDocumentInfo indexingOptions,
                                                     GeoCoordinates coordinates,
                                                     boolean indexIfGeocodeFails,
                                                     GeocodeCredentials geocodeCredentials)
                                              throws SovrenException

Use this if you already have latitude/longitude coordinates and simply wish to add them to your parsed resume. The coordinates will be inserted into your parsed resume, and the address included in the parsed resume (if present) will not be modified.

Parameters:

resume - The resume to insert the geocoordinates into

indexingOptions - What index/document id to use to index the document after geocoding

coordinates - The geocoordinates to use

indexIfGeocodeFails - Indicates whether or not the document should still be added to the index if the geocode request fails.

geocodeCredentials - - The credentials you want to use for geocoding (use null for Sovren credentials)

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurred

geocodeAndIndex

public GeocodeAndIndexJobResponse geocodeAndIndex(ParsedJob job,
                                                  IndexSingleDocumentInfo indexingOptions,
                                                  boolean indexIfGeocodeFails,
                                                  GeocodeCredentials geocodeCredentials)
                                           throws SovrenException

Uses the address in the job (if present) to look up geocoordinates and add them into the ParsedJob object. These coordinates are used by the AI Searching/Matching engine.

Parameters:

job - The job to geocode

indexingOptions - What index/document id to use to index the document after geocoding

indexIfGeocodeFails - Indicates whether or not the document should still be added to the index if the geocode request fails.

geocodeCredentials - - The credentials you want to use for geocoding (use null for Sovren credentials)

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurred

geocodeAndIndex

public GeocodeAndIndexJobResponse geocodeAndIndex(ParsedJob job,
                                                  IndexSingleDocumentInfo indexingOptions,
                                                  Address address,
                                                  boolean indexIfGeocodeFails,
                                                  GeocodeCredentials geocodeCredentials)
                                           throws SovrenException

Use this if you would like to provide an address for geocoding instead of using the one in the parsed rjobesume. The address included in the parsed job (if present) will not be modified.

Parameters:

job - The job to insert the geocoordinates (from the address) into

indexingOptions - What index/document id to use to index the document after geocoding

address - The address to use to retrieve geocoordinates

indexIfGeocodeFails - Indicates whether or not the document should still be added to the index if the geocode request fails.

geocodeCredentials - - The credentials you want to use for geocoding (use null for Sovren credentials)

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurred

geocodeAndIndex

public GeocodeAndIndexJobResponse geocodeAndIndex(ParsedJob job,
                                                  IndexSingleDocumentInfo indexingOptions,
                                                  GeoCoordinates coordinates,
                                                  boolean indexIfGeocodeFails,
                                                  GeocodeCredentials geocodeCredentials)
                                           throws SovrenException

Use this if you already have latitude/longitude coordinates and simply wish to add them to your parsed job. The coordinates will be inserted into your parsed job, and the address included in the parsed job (if present) will not be modified.

Parameters:

job - The job to insert the geocoordinates into

indexingOptions - What index/document id to use to index the document after geocoding

coordinates - The geocoordinates to use

indexIfGeocodeFails - Indicates whether or not the document should still be added to the index if the geocode request fails.

geocodeCredentials - - The credentials you want to use for geocoding (use null for Sovren credentials)

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurred

ui

public SovrenUIClient ui(MatchUISettings uiOptions)

Access methods for generating Sovren Matching UI sessions. For example: sovClient.UI(options).search(...)

Parameters:

uiOptions - Options/settings for the Matching UI.
NOTE: if you do not provide a UIOptions.Username (in MatchUISettings.UIOptions), the user will be prompted to login as soon as the Matching UI session is loaded

Returns:

The client for making Matching UI API calls

getSkillsTaxonomy

public GetSkillsTaxonomyResponse getSkillsTaxonomy(TaxonomyFormat format)
                                            throws SovrenException

Get all skills in the taxonomy with associated IDs and descriptions in all supported languages.

Parameters:

format - The format of the returned taxonomy.
NOTE: if you set this to TaxonomyFormat.csv, only the Taxonomy.CsvOutput will be populated.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

getSkillsTaxonomy

public GetSkillsTaxonomyResponse getSkillsTaxonomy()
                                            throws SovrenException

Get all skills in the taxonomy with associated IDs and descriptions in all supported languages.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

getSkillsTaxonomyMetadata

public GetMetadataResponse getSkillsTaxonomyMetadata()
                                              throws SovrenException

Get metadata about the skills taxonomy/service.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

autocompleteSkill

public AutoCompleteSkillsResponse autocompleteSkill(String prefix,
                                                    List<String> languages,
                                                    String outputLanguage,
                                                    List<String> types,
                                                    int limit)
                                             throws SovrenException

Returns normalized skills that begin with a given prefix, based on the chosen language(s). Each skill is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the skill is included in the results.

Parameters:

prefix - The skill prefix to be completed. Must contain at least 1 character.

languages - The language(s) used to search for matching skills (the language of the provided Prefix). A maximum of 5 languages can be provided. Must be one of the supported ISO codes.
Default is 'en' only.

outputLanguage - The language to ouput the found skill descriptions in (default is 'en'). Must be one of the supported ISO codes.

types - If specified, only these types of skills will be returned. The following values are acceptable: Professional, IT, Language, Soft, All.

limit - The maximum number of returned skills. The default is 10 and the maximum is 100.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

autocompleteSkill

public AutoCompleteSkillsResponse autocompleteSkill(String prefix)
                                             throws SovrenException

Returns normalized skills that begin with a given prefix, based on the chosen language(s). Each skill is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the skill is included in the results.

Parameters:

prefix - The skill prefix to be completed. Must contain at least 1 character.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

lookupSkills

public LookupSkillCodesResponse lookupSkills(List<String> skillIds,
                                             String outputLanguage)
                                      throws SovrenException

Get the details associated with given skills in the taxonomy.

Parameters:

skillIds - The IDs of the skills to get details about. A maximum of 100 IDs can be requested.

outputLanguage - The language to use for the output skill descriptions. If not provided, defaults to en. If specified, must be one of the supported ISO codes.
Default is 'en'.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

lookupSkills

public LookupSkillCodesResponse lookupSkills(List<String> skillIds)
                                      throws SovrenException

Get the details associated with given skills in the taxonomy.

Parameters:

skillIds - The IDs of the skills to get details about. A maximum of 100 IDs can be requested.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

normalizeSkills

public NormalizeSkillsResponse normalizeSkills(List<String> skills,
                                               String language,
                                               String outputLanguage)
                                        throws SovrenException

Normalize the given skills to the most closely-related skills in the taxonomy.

Parameters:

skills - The list of skills to normalize (up to 50 skills, each skill may not exceed 100 characters).

language - The language of the given skills. Must be one of the supported ISO codes.
Default is 'en'.

outputLanguage - The language to use for the output skill descriptions. Must be one of the supported ISO codes.
Defaults to whatever is used for the 'language' parameter.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

normalizeSkills

public NormalizeSkillsResponse normalizeSkills(List<String> skills)
                                        throws SovrenException

Normalize the given skills to the most closely-related skills in the taxonomy.

Parameters:

skills - The list of skills to normalize (up to 50 skills, each skill may not exceed 100 characters).

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

extractSkills

public ExtractSkillsResponse extractSkills(String text,
                                           String language,
                                           String outputLanguage,
                                           float threshold)
                                    throws SovrenException

Extracts known skills from the given text.

Parameters:

text - The text to extract skills from. There is a 24,000 character limit.

language - The language of the input text. Must be one of the supported ISO codes.
Default is 'en'.

outputLanguage - The language to use for the output skill descriptions. If not provided, defaults to the input language. Must be one of the supported ISO codes.

threshold - A value from [0 - 1] for the minimum confidence threshold for extracted skills. Lower values will return more skills, but also increase the likelihood of ambiguity-related errors. The recommended and default value is 0.5.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

extractSkills

public ExtractSkillsResponse extractSkills(String text)
                                    throws SovrenException

Extracts known skills from the given text.

Parameters:

text - The text to extract skills from. There is a 24,000 character limit.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

getProfessionsTaxonomy

public GetProfessionsTaxonomyResponse getProfessionsTaxonomy(String language,
                                                             TaxonomyFormat format)
                                                      throws SovrenException

Get all professions in the taxonomy with associated IDs and descriptions in all supported languages.

Parameters:

language - The language parameter returns the taxonomy with descriptions only in that specified language. If not specified, descriptions in all languages are returned. Must be specified as one of the supported ISO codes.

format - The format of the returned taxonomy.
NOTE: if you set this to TaxonomyFormat.csv, only the Taxonomy.CsvOutput will be populated.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

getProfessionsTaxonomy

public GetProfessionsTaxonomyResponse getProfessionsTaxonomy()
                                                      throws SovrenException

Get all professions in the taxonomy with associated IDs and descriptions in all supported languages.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

getProfessionsTaxonomyMetadata

public GetMetadataResponse getProfessionsTaxonomyMetadata()
                                                   throws SovrenException

Get metadata about the professions taxonomy/service.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

autocompleteProfession

public ProfessionsAutoCompleteResponse autocompleteProfession(String prefix,
                                                              List<String> languages,
                                                              String outputLanguage,
                                                              int limit)
                                                       throws SovrenException

Returns normalized professions that begin with a given prefix, based on the chosen language(s). Each profession is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the profession is included in the results.

Parameters:

prefix - The job title prefix to be completed. Must contain at least 1 character.

languages - The language(s) used to search for matching professions (the language of the provided Prefix). A maximum of 5 languages can be provided. Must be one of the supported ISO codes. Default is 'en' only.

outputLanguage - The language to ouput the found professions in (default is 'en'). Must be one of the supported ISO codes.

limit - The maximum number of returned professions. The default is 10 and the maximum is 100.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

autocompleteProfession

public ProfessionsAutoCompleteResponse autocompleteProfession(String prefix)
                                                       throws SovrenException

Returns normalized professions that begin with a given prefix, based on the default language of english. Each profession is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the profession is included in the results.

Parameters:

prefix - The job title prefix to be completed. Must contain at least 1 character.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

normalizeProfessions

public NormalizeProfessionsResponse normalizeProfessions(List<String> jobTitles,
                                                         String language,
                                                         String outputLanguage)
                                                  throws SovrenException

Normalize the given job titles to the most closely-related professions in the taxonomy.

Parameters:

jobTitles - The list of job titles to normalize (up to 10 job titles, each job title may not exceed 400 characters).

language - The language of the input job titles. Must be one of the supported ISO codes.
Default is 'en'.

outputLanguage - The language to use for descriptions of the returned normalized professions. Must be one of the supported ISO codes.
Defaults to whatever is used for the 'language' parameter.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

normalizeProfessions

public NormalizeProfessionsResponse normalizeProfessions(List<String> jobTitles)
                                                  throws SovrenException

Normalize the given job titles to the most closely-related professions in the taxonomy.

Parameters:

jobTitles - The list of job titles to normalize (up to 10 job titles, each job title may not exceed 400 characters).

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

lookupProfessions

public LookupProfessionCodesResponse lookupProfessions(List<Integer> codeIds,
                                                       String outputLanguage)
                                                throws SovrenException

Get details for the given professions in the taxonomy.

Parameters:

codeIds - The profession code IDs to get details about from the Sovren Professions Taxonomy.

outputLanguage - The language to use for professions descriptions (default is en). Must be an allowed ISO code.
Default is 'en'.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

lookupProfessions

public LookupProfessionCodesResponse lookupProfessions(List<Integer> codeIds)
                                                throws SovrenException

Get details for the given professions in the taxonomy.

Parameters:

codeIds - The profession code IDs to get details about from the Sovren Professions Taxonomy.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

compareProfessions

public CompareProfessionsResponse compareProfessions(int profession1,
                                                     int profession2)
                                              throws SovrenException

Compare two professions based on the skills associated with each.

Parameters:

profession1 - A profession code ID from the Sovren Professions Taxonomy to compare.

profession2 - A profession code ID from the Sovren Professions Taxonomy to compare.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

compareSkillsToProfessions

public CompareSkillsToProfessionResponse compareSkillsToProfessions(int professionCodeId,
                                                                    String... skillIds)
                                                             throws SovrenException

Compare a given set of skills to the skills related to a given profession.

Parameters:

professionCodeId - The profession code ID from the Sovren Professions Taxonomy to compare the skill set to.

skillIds - The skill IDs which should be compared against the given profession. The list can contain up to 50 skills.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

compareSkillsToProfessions

public CompareSkillsToProfessionResponse compareSkillsToProfessions(ParsedResume resume,
                                                                    int professionCodeId)
                                                             throws SovrenException

Compare the skills of a candidate to the skills related to a job using the Ontology API.

Parameters:

resume - The resume containing the skills of the candidate

professionCodeId - The profession code ID from the Sovren Professions Taxonomy to compare the skill set to.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

suggestSkills

public SuggestSkillsResponse suggestSkills(List<Integer> professionCodeIds,
                                           int limit)
                                    throws SovrenException

Suggests skills related to given professions. The service returns salient skills that are strongly associated with the professions.

Parameters:

professionCodeIds - The code IDs of the professions to suggest skills for.

limit - The maximum amount of suggested skills returned. The maximum amount allowed is 10. If not sure what value should be, provide 10 as default limit.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

suggestSkills

public SuggestSkillsResponse suggestSkills(List<Integer> professionCodeIds)
                                    throws SovrenException

Suggests skills related to given professions. The service returns salient skills that are strongly associated with the professions.

Parameters:

professionCodeIds - The code IDs of the professions to suggest skills for.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

suggestSkills

public SuggestSkillsResponse suggestSkills(ParsedResume resume,
                                           int limit)
                                    throws SovrenException

Suggests skills related to a resume based on the recent professions in the resume.

Parameters:

resume - The resume to suggest skills for (based on the professions in the resume).

limit - The maximum amount of suggested skills returned. The maximum amount allowed is 10. If not sure what value should be, provide 10 as default limit.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

suggestSkills

public SuggestSkillsResponse suggestSkills(ParsedResume resume)
                                    throws SovrenException

Suggests skills related to a resume based on the recent professions in the resume.

Parameters:

resume - The resume to suggest skills for (based on the professions in the resume).

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

suggestSkills

public SuggestSkillsResponse suggestSkills(ParsedJob job,
                                           int limit)
                                    throws SovrenException

Suggests skills related to a job based on the profession title in the job.

Parameters:

job - The resume to suggest skills for (based on the professions in the resume).

limit - The maximum amount of suggested skills returned. The maximum amount allowed is 10. If not sure what value should be, provide 10 as default limit.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

suggestSkills

public SuggestSkillsResponse suggestSkills(ParsedJob job)
                                    throws SovrenException

Suggests skills related to a job based on the profession title in the job.

Parameters:

job - The resume to suggest skills for (based on the professions in the resume).

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

suggestProfessions

public SuggestProfessionsResponse suggestProfessions(ParsedResume resume,
                                                     int limit,
                                                     boolean returnMissingSkills)
                                              throws SovrenException

Suggest professions based on the skills within a given resume.

Parameters:

resume - The professions are suggested based on the skills within this resume.

limit - The maximum amount of professions returned. If not sure what value should be, provide 10 as default limit.

returnMissingSkills - Flag to enable returning a list of missing skills per suggested profession.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

suggestProfessions

public SuggestProfessionsResponse suggestProfessions(ParsedResume resume)
                                              throws SovrenException

Suggest professions based on the skills within a given resume.

Parameters:

resume - The professions are suggested based on the skills within this resume. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

suggestProfessions

public SuggestProfessionsResponse suggestProfessions(ParsedJob job,
                                                     int limit,
                                                     boolean returnMissingSkills)
                                              throws SovrenException

Suggest professions based on the skills within a given job.

Parameters:

job - The professions are suggested based on the skills within this job.

limit - The maximum amount of professions returned. If not sure what value should be, provide 10 as default limit.

returnMissingSkills - Flag to enable returning a list of missing skills per suggested profession.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

suggestProfessions

public SuggestProfessionsResponse suggestProfessions(ParsedJob job)
                                              throws SovrenException

Suggest professions based on the skills within a given job.

Parameters:

job - The professions are suggested based on the skills within this job. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

suggestProfessions

public SuggestProfessionsResponse suggestProfessions(List<String> skillIds,
                                                     int limit,
                                                     boolean returnMissingSkills)
                                              throws SovrenException

Suggest professions based on a given set of skill IDs.

Parameters:

skillIds - The skill IDs used to return the most relevant professions. The list can contain up to 50 skill IDs.

limit - The maximum amount of professions returned. If not sure what value should be, provide 10 as default limit.

returnMissingSkills - Flag to enable returning a list of missing skills per suggested profession.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs

suggestProfessions

public SuggestProfessionsResponse suggestProfessions(List<String> skillIds)
                                              throws SovrenException

Suggest professions based on a given set of skill IDs.

Parameters:

skillIds - The skill IDs used to return the most relevant professions. The list can contain up to 50 skill IDs. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters.

Returns:

The API response body

Throws:

SovrenException - Thrown when an API error occurs