com.sovren

Class SovrenUIClient

java.lang.Object

com.sovren.SovrenUIClient

public class SovrenUIClient
extends Object

Extension methods to generate the Sovren Matching UI. Access with SovrenClient.ui(MatchUISettings)

Method Summary

Modifier and Type	Method and Description
<TTarget extends IParsedDocWithId> GenerateUIResponse	bimetricScore(ParsedJobWithId sourceJob, List<TTarget> targetDocuments, CategoryWeights preferredWeights, SearchMatchSettings settings) Create a Matching UI session to score one or more target documents against a source job
<TTarget extends IParsedDocWithId> GenerateUIResponse	bimetricScore(ParsedResumeWithId sourceResume, List<TTarget> targetDocuments, CategoryWeights preferredWeights, SearchMatchSettings settings) Create a Matching UI session to score one or more target documents against a source resume
GenerateUIResponse	match(ParsedJob job, List<String> indexesToQuery, CategoryWeights preferredWeights, FilterCriteria filters, SearchMatchSettings settings, int numResults) Create a Matching UI session to find matches for a non-indexed job.
GenerateUIResponse	match(ParsedResume resume, List<String> indexesToQuery, CategoryWeights preferredWeights, FilterCriteria filters, SearchMatchSettings settings, int numResults) Create a Matching UI session to find matches for a non-indexed resume.
GenerateUIResponse	match(String indexId, String documentId, List<String> indexesToQuery, CategoryWeights preferredWeights, FilterCriteria filters, SearchMatchSettings settings, int numResults) Create a Matching UI session to find matches for a resume or job that is already indexed
GenerateUIResponse	search(List<String> indexesToQuery, FilterCriteria query, SearchMatchSettings settings, PaginationSettings pagination) Create a Matching UI session to search for resumes or jobs that meet specific criteria

Methods inherited from class java.lang.Object

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

Method Detail

match

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

Create a Matching UI session to 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 response containing a URL for the Matching UI session

Throws:

SovrenException - Thrown when an API error occurs

match

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

Create a Matching UI session to 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 response containing a URL for the Matching UI session

Throws:

SovrenException - Thrown when an API error occurs

match

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

Create a Matching UI session to 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 response containing a URL for the Matching UI session

Throws:

SovrenException - Thrown when an API error occurs

search

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

Create a Matching UI session to 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 response containing a URL for the Matching UI session

Throws:

SovrenException - Thrown when an API error occurs

bimetricScore

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

Create a Matching UI session to 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 response containing a URL for the Matching UI session

Throws:

SovrenException - Thrown when an API error occurs

bimetricScore

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

Create a Matching UI session to 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 response containing a URL for the Matching UI session

Throws:

SovrenException - Thrown when an API error occurs