com.textkernel.tx.services

Class SearchMatchService

java.lang.Object

com.textkernel.tx.services.SearchMatchService

public class SearchMatchService
extends Object

See TxClient.searchMatchV1()

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
<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
CreateIndexResponse	createIndex(IndexType type, String indexId) Create a new index
protected okhttp3.RequestBody	createJsonBody(Object body)
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
protected <T extends ApiResponse<?>> HttpResponse<T>	executeRequest(okhttp3.Request apiRequest, Class<T> classOfT, String requestBody)
GetAllIndexesResponse	getAllIndexes() Get all existing indexes
GetJobResponse	getJob(String indexId, String documentId) Retrieve an existing job from an index
GetResumeResponse	getResume(String indexId, String documentId) Retrieve an existing resume from an index
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
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
SearchResponse	search(List<String> indexesToQuery, FilterCriteria query, SearchMatchSettings settings, PaginationSettings pagination) Search for resumes or jobs that meet specific criteria
protected void	setEnvironment(IndexingOptionsGeneric options)
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

_settings

protected final EnvironmentSettings _settings

_endpoints

protected final ApiEndpoints _endpoints

Constructor Detail

SearchMatchService

public SearchMatchService(okhttp3.OkHttpClient httpClient,
                          EnvironmentSettings settings)

Do not use this. See TxClient.searchMatchV1()

Parameters:

httpClient - The http client for API calls

settings - environment settings

Method Detail

createIndex

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

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:

TxException - Thrown when an API error occurs

getAllIndexes

public GetAllIndexesResponse getAllIndexes()
                                    throws TxException

Get all existing indexes

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

deleteIndex

public DeleteIndexResponse deleteIndex(String indexId)
                                throws TxException

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:

TxException - Thrown when an API error occurs

indexDocument

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

Add a resume to an existing index

Parameters:

resume - A resume generated by the 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:

TxException - Thrown when an API error occurs

indexDocument

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

Add a job to an existing index

Parameters:

job - A job generated by the 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:

TxException - Thrown when an API error occurs

indexMultipleResumes

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

Add several resumes to an existing index

Parameters:

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

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

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

indexMultipleJobs

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

Add several jobs to an existing index

Parameters:

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

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

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

deleteDocument

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

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:

TxException - Thrown when an API error occurs

deleteMultipleDocuments

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

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:

TxException - Thrown when an API error occurs

getResume

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

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:

TxException - Thrown when an API error occurs

getJob

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

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:

TxException - Thrown when an API error occurs

updateResumeUserDefinedTags

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

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:

TxException - Thrown when an API error occurs

updateJobUserDefinedTags

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

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:

TxException - Thrown when an API error occurs

match

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

Find matches for a non-indexed resume.

Parameters:

resume - The resume (generated by the 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, The best values will be determined 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:

TxException - Thrown when an API error occurs

match

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

Find matches for a non-indexed job.

Parameters:

job - The job (generated by the 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, The best values will be determined 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:

TxException - 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 TxException

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, The best values will be determined 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:

TxException - Thrown when an API error occurs

search

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

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:

TxException - Thrown when an API error occurs

bimetricScore

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

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, The best values will be determined based on the source resume.

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

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

bimetricScore

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

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, The best values will be determined based on the source job.

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

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