com.textkernel.tx.services

Class MatchV2Service

java.lang.Object

com.textkernel.tx.services.MatchV2Service

public class MatchV2Service
extends Object

See TxClient.searchMatchV2()

Field Summary

Fields

Modifier and Type	Field and Description
protected ApiEndpoints	_endpoints
protected EnvironmentSettings	_settings

Constructor Summary

Constructors

Constructor and Description
MatchV2Service(okhttp3.OkHttpClient httpClient, EnvironmentSettings settings) Do not use this.

Method Summary

Modifier and Type	Method and Description
AddCandidateResponse	addCandidate(String documentId, ParsedResume resume, List<String> roles, boolean anonymize, Map<String,String> customFields) Upload a candidates CV to the search and match V2 environment.
AddJobResponse	addJob(String documentId, ParsedJob job, List<String> roles, Map<String,String> customFields) Upload a job to the search and match V2 environment.
AutocompleteResponse	autocompleteCandidates(AutocompleteCandidatesField field, String input, String... languages) Returns a list of suggested Completions.
AutocompleteResponse	autocompleteJobs(AutocompleteJobsField field, String input, String... languages) Returns a list of suggested Completions.
protected okhttp3.RequestBody	createJsonBody(Object body)
DeleteDocumentsResponse	deleteCandidates(List<String> documentIds) Delete candidate documents from environment
DeleteDocumentsResponse	deleteJobs(List<String> documentIds) Delete job documents from environment
protected <T extends ApiResponse<?>> HttpResponse<T>	executeRequest(okhttp3.Request apiRequest, Class<T> classOfT, String requestBody)
SearchResponse	matchCandidates(DocumentSource sourceDocument, Options options, SearchQuery query) Match an existing candidate document with filters provided.
SearchResponse	matchJobs(DocumentSource sourceDocument, Options options, SearchQuery query) Match an existing job document with filters provided.
SearchResponse	searchCandidates(SearchQuery query, Options options) Search for a candidate based on the query provided.
SearchResponse	searchJobs(SearchQuery query, Options options) Search for a job based on the query provided.
protected void	setEnvironment(IndexingOptionsGeneric options)

Methods inherited from class java.lang.Object

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

Field Detail

_settings

protected final EnvironmentSettings _settings

_endpoints

protected final ApiEndpoints _endpoints

Constructor Detail

MatchV2Service

public MatchV2Service(okhttp3.OkHttpClient httpClient,
                      EnvironmentSettings settings)

Do not use this. See TxClient.searchMatchV2()

Parameters:

httpClient - The http client for API calls

settings - environment settings

Method Detail

addCandidate

public AddCandidateResponse addCandidate(String documentId,
                                         ParsedResume resume,
                                         List<String> roles,
                                         boolean anonymize,
                                         Map<String,String> customFields)
                                  throws TxException

Upload a candidates CV to the search and match V2 environment.

Parameters:

documentId - The id to use for the document

resume - Parsed output from the Textkernel CV/Resume Parser

roles - (optional) The roles associated with the request. Defaults to ["All"] if none are provided.

anonymize - (optional) A boolean flag to strip PII data out of the resume before indexing

customFields - (optional) A collection of custom fields represented as key-value pairs

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

addJob

public AddJobResponse addJob(String documentId,
                             ParsedJob job,
                             List<String> roles,
                             Map<String,String> customFields)
                      throws TxException

Upload a job to the search and match V2 environment.

Parameters:

documentId - The id to use for the document

job - Parsed output from the Textkernel Job Parser

roles - (optional) The roles associated with the request. Defaults to ["All"] if none are provided.

customFields - (optional) A collection of custom fields represented as key-value pairs

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

deleteCandidates

public DeleteDocumentsResponse deleteCandidates(List<String> documentIds)
                                         throws TxException

Delete candidate documents from environment

Parameters:

documentIds - The document IDs to delete

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

deleteJobs

public DeleteDocumentsResponse deleteJobs(List<String> documentIds)
                                   throws TxException

Delete job documents from environment

Parameters:

documentIds - The document IDs to delete

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

matchCandidates

public SearchResponse matchCandidates(DocumentSource sourceDocument,
                                      Options options,
                                      SearchQuery query)
                               throws TxException

Match an existing candidate document with filters provided.

Parameters:

sourceDocument - The document to generate the search query from

options - Options for the Match request

query - (optional) The query object that will be combined with the match query to drive the search

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

matchJobs

public SearchResponse matchJobs(DocumentSource sourceDocument,
                                Options options,
                                SearchQuery query)
                         throws TxException

Match an existing job document with filters provided.

Parameters:

sourceDocument - The document to generate the search query from

options - Options for the Match request

query - (optional) The query object that will be combined with the match query to drive the search

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

searchCandidates

public SearchResponse searchCandidates(SearchQuery query,
                                       Options options)
                                throws TxException

Search for a candidate based on the query provided.

Parameters:

query - The query object that will drive the search.

options - Options for the search request

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

searchJobs

public SearchResponse searchJobs(SearchQuery query,
                                 Options options)
                          throws TxException

Search for a job based on the query provided.

Parameters:

query - The query object that will drive the search.

options - Options for the search request

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

autocompleteCandidates

public AutocompleteResponse autocompleteCandidates(AutocompleteCandidatesField field,
                                                   String input,
                                                   String... languages)
                                            throws TxException

Returns a list of suggested Completions. This endpoint is used to give a user instant feedback while typing a query. If the given field is the FULLTEXT field, the service returns suggestions from all configured dictionaries that are not explicitly excluded from full-text suggestions.

Parameters:

field - Which field to use to retrieve completions

input - The user-typed input string

languages - Optional 2-letter ISO-639-1 language codes. The first language is used for field label translations. All languages are used to retrieve completions when the environment doesn't have default languages set.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

autocompleteJobs

public AutocompleteResponse autocompleteJobs(AutocompleteJobsField field,
                                             String input,
                                             String... languages)
                                      throws TxException

Returns a list of suggested Completions. This endpoint is used to give a user instant feedback while typing a query. If the given field is the FULLTEXT field, the service returns suggestions from all configured dictionaries that are not explicitly excluded from full-text suggestions.

Parameters:

field - Which field to use to retrieve completions

input - The user-typed input string

languages - Optional 2-letter ISO-639-1 language codes. The first language is used for field label translations. All languages are used to retrieve completions when the environment doesn't have default languages set.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

setEnvironment

protected void setEnvironment(IndexingOptionsGeneric options)

createJsonBody

protected okhttp3.RequestBody createJsonBody(Object body)

executeRequest

protected <T extends ApiResponse<?>> HttpResponse<T> executeRequest(okhttp3.Request apiRequest,
                                                                    Class<T> classOfT,
                                                                    String requestBody)
                                                             throws TxException

Throws:

TxException