Interface ISearchMatchService

Use SearchMatchV1

Namespace: Textkernel.Tx.Services

Assembly: Textkernel.Tx.SDK.dll

Syntax

public interface ISearchMatchService

Methods

BimetricScore<TTarget>(ParsedJobWithId, List<TTarget>, CategoryWeights, SearchMatchSettings)

Score one or more target documents against a source job

Declaration

Task<BimetricScoreResponse> BimetricScore<TTarget>(ParsedJobWithId sourceJob, List<TTarget> targetDocuments, CategoryWeights preferredWeights = null, SearchMatchSettings settings = null)
    where TTarget : IParsedDocWithId

Parameters

Type	Name	Description
ParsedJobWithId	sourceJob	The source job
System.Collections.Generic.List<TTarget>	targetDocuments	The target resumes/jobs
CategoryWeights	preferredWeights	The preferred category weights for scoring the results. If none are provided, The best values will be determined based on the source job
SearchMatchSettings	settings	Settings to be used for this scoring request

Returns

Type	Description
System.Threading.Tasks.Task<BimetricScoreResponse>

Type Parameters

Name	Description
TTarget	Either ParsedResumeWithId or ParsedJobWithId

Exceptions

Type	Condition
TxException	Thrown when an API error occurs

BimetricScore<TTarget>(ParsedResumeWithId, List<TTarget>, CategoryWeights, SearchMatchSettings)

Score one or more target documents against a source resume

Declaration

Task<BimetricScoreResponse> BimetricScore<TTarget>(ParsedResumeWithId sourceResume, List<TTarget> targetDocuments, CategoryWeights preferredWeights = null, SearchMatchSettings settings = null)
    where TTarget : IParsedDocWithId

Parameters

Type	Name	Description
ParsedResumeWithId	sourceResume	The source resume
System.Collections.Generic.List<TTarget>	targetDocuments	The target resumes/jobs
CategoryWeights	preferredWeights	The preferred category weights for scoring the results. If none are provided, The best values will be determined based on the source resume
SearchMatchSettings	settings	Settings to be used for this scoring request

Returns

Type	Description
System.Threading.Tasks.Task<BimetricScoreResponse>

Type Parameters

Name	Description
TTarget	Either ParsedResumeWithId or ParsedJobWithId

Exceptions

Type	Condition
TxException	Thrown when an API error occurs

CreateIndex(IndexType, String)

Create a new index

Declaration

Task<CreateIndexResponse> CreateIndex(IndexType type, string indexId)

Parameters

Type	Name	Description
IndexType	type	The type of documents stored in this index. Either 'Resume' or 'Job'
System.String	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

Type	Description
System.Threading.Tasks.Task<CreateIndexResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurs

DeleteDocument(String, String)

Delete an existing document from an index

Declaration

Task<DeleteDocumentResponse> DeleteDocument(string indexId, string documentId)

Parameters

Type	Name	Description
System.String	indexId	The index containing the document
System.String	documentId	The ID of the document to delete

Returns

Type	Description
System.Threading.Tasks.Task<DeleteDocumentResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurs

DeleteIndex(String)

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

Declaration

Task<DeleteIndexResponse> DeleteIndex(string indexId)

Parameters

Type	Name	Description
System.String	indexId

Returns

Type	Description
System.Threading.Tasks.Task<DeleteIndexResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurs

DeleteMultipleDocuments(String, IEnumerable<String>)

Delete a group of existing documents from an index

Declaration

Task<DeleteMultipleDocumentsResponse> DeleteMultipleDocuments(string indexId, IEnumerable<string> documentIds)

Parameters

Type	Name	Description
System.String	indexId	The index containing the documents
System.Collections.Generic.IEnumerable<System.String>	documentIds	The IDs of the documents to delete

Returns

Type	Description
System.Threading.Tasks.Task<DeleteMultipleDocumentsResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurs

GetAllIndexes()

Get all existing indexes

Declaration

Task<GetAllIndexesResponse> GetAllIndexes()

Returns

Type	Description
System.Threading.Tasks.Task<GetAllIndexesResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurs

GetJob(String, String)

Retrieve an existing job from an index

Declaration

Task<GetJobResponse> GetJob(string indexId, string documentId)

Parameters

Type	Name	Description
System.String	indexId	The index containing the job
System.String	documentId	The ID of the job to retrieve

Returns

Type	Description
System.Threading.Tasks.Task<GetJobResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurs

GetResume(String, String)

Retrieve an existing resume from an index

Declaration

Task<GetResumeResponse> GetResume(string indexId, string documentId)

Parameters

Type	Name	Description
System.String	indexId	The index containing the resume
System.String	documentId	The ID of the resume to retrieve

Returns

Type	Description
System.Threading.Tasks.Task<GetResumeResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurs

IndexDocument(ParsedJob, String, String, IEnumerable<String>)

Add a job to an existing index

Declaration

Task<IndexDocumentResponse> IndexDocument(ParsedJob job, string indexId, string documentId, IEnumerable<string> userDefinedTags = null)

Parameters

Type	Name	Description
ParsedJob	job	A job generated by the Job Parser
System.String	indexId	The index the document should be added into (case-insensitive).
System.String	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.
System.Collections.Generic.IEnumerable<System.String>	userDefinedTags	The user-defined tags that the job should have

Returns

Type	Description
System.Threading.Tasks.Task<IndexDocumentResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurs

IndexDocument(ParsedResume, String, String, IEnumerable<String>)

Add a resume to an existing index

Declaration

Task<IndexDocumentResponse> IndexDocument(ParsedResume resume, string indexId, string documentId, IEnumerable<string> userDefinedTags = null)

Parameters

Type	Name	Description
ParsedResume	resume	A resume generated by the Resume Parser
System.String	indexId	The index the document should be added into (case-insensitive).
System.String	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.
System.Collections.Generic.IEnumerable<System.String>	userDefinedTags	The user-defined tags that the resume should have

Returns

Type	Description
System.Threading.Tasks.Task<IndexDocumentResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurs

IndexMultipleDocuments(IEnumerable<IndexJobInfo>, String)

Add several jobs to an existing index

Declaration

Task<IndexMultipleDocumentsResponse> IndexMultipleDocuments(IEnumerable<IndexJobInfo> jobs, string indexId)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<IndexJobInfo>	jobs	The jobs generated by the Job Parser paired with their DocumentIds
System.String	indexId	The index the jobs should be added into (case-insensitive).

Returns

Type	Description
System.Threading.Tasks.Task<IndexMultipleDocumentsResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurs

IndexMultipleDocuments(IEnumerable<IndexResumeInfo>, String)

Add several resumes to an existing index

Declaration

Task<IndexMultipleDocumentsResponse> IndexMultipleDocuments(IEnumerable<IndexResumeInfo> resumes, string indexId)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<IndexResumeInfo>	resumes	The resumes generated by the Resume Parser paired with their DocumentIds
System.String	indexId	The index the resumes should be added into (case-insensitive).

Returns

Type	Description
System.Threading.Tasks.Task<IndexMultipleDocumentsResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurs

Match(String, String, IEnumerable<String>, CategoryWeights, FilterCriteria, SearchMatchSettings, Int32)

Find matches for a resume or job that is already indexed

Declaration

Task<MatchResponse> Match(string indexId, string documentId, IEnumerable<string> indexesToQuery, CategoryWeights preferredWeights = null, FilterCriteria filters = null, SearchMatchSettings settings = null, int numResults = 0)

Parameters

Type	Name	Description
System.String	indexId	The index containing the document you want to match
System.String	documentId	The ID of the document to match
System.Collections.Generic.IEnumerable<System.String>	indexesToQuery	The indexes to find results in. These must all be of the same type (resumes or jobs)
CategoryWeights	preferredWeights	The preferred category weights for scoring the results. If none are provided, The best values will be determined based on the source resume/job
FilterCriteria	filters	Any filters to apply prior to the match (a result must satisfy all the filters)
SearchMatchSettings	settings	Settings for this match
System.Int32	numResults	The number of results to show. If not specified, the default will be used.

Returns

Type	Description
System.Threading.Tasks.Task<MatchResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurs

Match(ParsedJob, IEnumerable<String>, CategoryWeights, FilterCriteria, SearchMatchSettings, Int32)

Find matches for a non-indexed job.

Declaration

Task<MatchResponse> Match(ParsedJob job, IEnumerable<string> indexesToQuery, CategoryWeights preferredWeights = null, FilterCriteria filters = null, SearchMatchSettings settings = null, int numResults = 0)

Parameters

Type	Name	Description
ParsedJob	job	The job (generated by the Job Parser) to use as the source for a match query
System.Collections.Generic.IEnumerable<System.String>	indexesToQuery	The indexes to find results in. These must all be of the same type (resumes or jobs)
CategoryWeights	preferredWeights	The preferred category weights for scoring the results. If none are provided, The best values will be determined based on the source job
FilterCriteria	filters	Any filters to apply prior to the match (a result must satisfy all the filters)
SearchMatchSettings	settings	Settings for this match
System.Int32	numResults	The number of results to show. If not specified, the default will be used.

Returns

Type	Description
System.Threading.Tasks.Task<MatchResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurs

Match(ParsedResume, IEnumerable<String>, CategoryWeights, FilterCriteria, SearchMatchSettings, Int32)

Find matches for a non-indexed resume.

Declaration

Task<MatchResponse> Match(ParsedResume resume, IEnumerable<string> indexesToQuery, CategoryWeights preferredWeights = null, FilterCriteria filters = null, SearchMatchSettings settings = null, int numResults = 0)

Parameters

Type	Name	Description
ParsedResume	resume	The resume (generated by the Resume Parser) to use as the source for a match query
System.Collections.Generic.IEnumerable<System.String>	indexesToQuery	The indexes to find results in. These must all be of the same type (resumes or jobs)
CategoryWeights	preferredWeights	The preferred category weights for scoring the results. If none are provided, The best values will be determined based on the source resume
FilterCriteria	filters	Any filters to apply prior to the match (a result must satisfy all the filters)
SearchMatchSettings	settings	Settings for this match
System.Int32	numResults	The number of results to show. If not specified, the default will be used.

Returns

Type	Description
System.Threading.Tasks.Task<MatchResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurs

Search(IEnumerable<String>, FilterCriteria, SearchMatchSettings, PaginationSettings)

Search for resumes or jobs that meet specific criteria

Declaration

Task<SearchResponse> Search(IEnumerable<string> indexesToQuery, FilterCriteria query, SearchMatchSettings settings = null, PaginationSettings pagination = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.String>	indexesToQuery	The indexes to find results in. These must all be of the same type (resumes or jobs)
FilterCriteria	query	The search query. A result must satisfy all of these criteria
SearchMatchSettings	settings	The settings for this search request
PaginationSettings	pagination	Pagination settings. If not specified the default will be used

Returns

Type	Description
System.Threading.Tasks.Task<SearchResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurs

UpdateJobUserDefinedTags(String, String, IEnumerable<String>, UserDefinedTagsMethod)

Updates the user-defined tags for a job

Declaration

Task<UpdateUserDefinedTagsResponse> UpdateJobUserDefinedTags(string indexId, string documentId, IEnumerable<string> userDefinedTags, UserDefinedTagsMethod method)

Parameters

Type	Name	Description
System.String	indexId	The index containing the job
System.String	documentId	The ID of the job to update
System.Collections.Generic.IEnumerable<System.String>	userDefinedTags	The user-defined tags to add/delete/etc
UserDefinedTagsMethod	method	Which method to use for the specified user-defined tags

Returns

Type	Description
System.Threading.Tasks.Task<UpdateUserDefinedTagsResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurs

UpdateResumeUserDefinedTags(String, String, IEnumerable<String>, UserDefinedTagsMethod)

Updates the user-defined tags for a resume

Declaration

Task<UpdateUserDefinedTagsResponse> UpdateResumeUserDefinedTags(string indexId, string documentId, IEnumerable<string> userDefinedTags, UserDefinedTagsMethod method)

Parameters

Type	Name	Description
System.String	indexId	The index containing the resume
System.String	documentId	The ID of the resume to update
System.Collections.Generic.IEnumerable<System.String>	userDefinedTags	The user-defined tags to add/delete/etc
UserDefinedTagsMethod	method	Which method to use for the specified user-defined tags

Returns

Type	Description
System.Threading.Tasks.Task<UpdateUserDefinedTagsResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurs