Interface IMatchV2Service

Namespace

Textkernel.Tx.Services

Assembly

Textkernel.Tx.SDK.dll

Use SearchMatchV2

public interface IMatchV2Service

Methods

AddCandidate(string, ParsedResume, IEnumerable<string>, bool, Dictionary<string, string>)

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

Task<ApiResponse<object>> AddCandidate(string documentId, ParsedResume resume, IEnumerable<string> roles = null, bool anonymize = false, Dictionary<string, string> customFields = null)

Parameters

documentId string

The id to use for the document

resume ParsedResume

Parsed output from the Textkernel CV/Resume Parser

roles IEnumerable<string>

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

anonymize bool

A boolean flag to strip PII data out of the resume before indexing.

customFields Dictionary<string, string>

A collection of custom fields represented as key-value pairs.

Returns

Task<ApiResponse<object>>

Exceptions

TxException

Thrown when an API error occurs

AddJob(string, ParsedJob, IEnumerable<string>, Dictionary<string, string>)

Upload a job to the search and match V2 environment.

Task<ApiResponse<object>> AddJob(string documentId, ParsedJob job, IEnumerable<string> roles = null, Dictionary<string, string> customFields = null)

Parameters

documentId string

The id to use for the document

job ParsedJob

Parsed output from the Textkernel Job Parser

roles IEnumerable<string>

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

customFields Dictionary<string, string>

A collection of custom fields represented as key-value pairs.

Returns

Task<ApiResponse<object>>

Exceptions

TxException

Thrown when an API error occurs

AutocompleteCandidates(AutocompleteCandidatesField, string, params string[])

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.

Task<AutocompleteResponse> AutocompleteCandidates(AutocompleteCandidatesField field, string input, params string[] languages)

Parameters

field AutocompleteCandidatesField

Which field to use to retrieve completions

input string

The user-typed input string.

languages string[]

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

Task<AutocompleteResponse>

Exceptions

TxException

Thrown when an API error occurs

AutocompleteJobs(AutocompleteJobsField, string, params string[])

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.

Task<AutocompleteResponse> AutocompleteJobs(AutocompleteJobsField field, string input, params string[] languages)

Parameters

field AutocompleteJobsField

Which field to use to retrieve completions

input string

The user-typed input string.

languages string[]

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

Task<AutocompleteResponse>

Exceptions

TxException

Thrown when an API error occurs

DeleteCandidates(IEnumerable<string>)

Delete candidate documents from environment

Task<DeleteDocumentsResponse> DeleteCandidates(IEnumerable<string> documentIds)

Parameters

documentIds IEnumerable<string>

The document IDs to delete

Returns

Task<DeleteDocumentsResponse>

Exceptions

TxException

Thrown when an API error occurred

DeleteJobs(IEnumerable<string>)

Delete job documents from environment

Task<DeleteDocumentsResponse> DeleteJobs(IEnumerable<string> documentIds)

Parameters

documentIds IEnumerable<string>

The document IDs to delete

Returns

Task<DeleteDocumentsResponse>

Exceptions

TxException

Thrown when an API error occurred

MatchCandidates(DocumentSource, Options, SearchQuery)

Match an existing candidate document with filters provided.

Task<SearchResponse> MatchCandidates(DocumentSource sourceDocument, Options options, SearchQuery query = null)

Parameters

sourceDocument DocumentSource

The document to generate the search query from

options Options

Options for the Match request

query SearchQuery

The query object that will be combined with the match query to drive the search

Returns

Task<SearchResponse>

Exceptions

TxException

Thrown when an API error occurred

MatchJobs(DocumentSource, Options, SearchQuery)

Match an existing job document with filters provided.

Task<SearchResponse> MatchJobs(DocumentSource sourceDocument, Options options, SearchQuery query = null)

Parameters

sourceDocument DocumentSource

The document to generate the search query from

options Options

Options for the Match request

query SearchQuery

The query object that will be combined with the match query to drive the search

Returns

Task<SearchResponse>

Exceptions

TxException

Thrown when an API error occurred

SearchCandidates(SearchQuery, Options)

Search for a candidate based on the query provided.

Task<SearchResponse> SearchCandidates(SearchQuery query, Options options)

Parameters

query SearchQuery

The query object that will drive the search.

options Options

Options for the search request

Returns

Task<SearchResponse>

Exceptions

TxException

Thrown when an API error occurred

SearchJobs(SearchQuery, Options)

Search for a job based on the query provided.

Task<SearchResponse> SearchJobs(SearchQuery query, Options options)

Parameters

query SearchQuery

The query object that will drive the search.

options Options

Options for the search request

Returns

Task<SearchResponse>

Exceptions

TxException

Thrown when an API error occurred