Interface IMatchV2Service
Use SearchMatchV2
Namespace: Textkernel.Tx.Services
Assembly: Textkernel.Tx.SDK.dll
Syntax
public interface IMatchV2ServiceMethods
| Improve this Doc View SourceAddCandidate(String, ParsedResume, IEnumerable<String>, Boolean, Dictionary<String, String>)
Upload a candidates CV to the search and match V2 environment.
Declaration
Task<ApiResponse<object>> AddCandidate(string documentId, ParsedResume resume, IEnumerable<string> roles = null, bool anonymize = false, Dictionary<string, string> customFields = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | documentId | The id to use for the document |
| ParsedResume | resume | Parsed output from the Textkernel CV/Resume Parser |
| System.Collections.Generic.IEnumerable<System.String> | roles | The roles associated with the request. Defaults to ["All"] if none are provided. |
| System.Boolean | anonymize | A boolean flag to strip PII data out of the resume before indexing. |
| System.Collections.Generic.Dictionary<System.String, System.String> | customFields | A collection of custom fields represented as key-value pairs. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ApiResponse<System.Object>> |
Exceptions
| Type | Condition |
|---|---|
| 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.
Declaration
Task<ApiResponse<object>> AddJob(string documentId, ParsedJob job, IEnumerable<string> roles = null, Dictionary<string, string> customFields = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | documentId | The id to use for the document |
| ParsedJob | job | Parsed output from the Textkernel Job Parser |
| System.Collections.Generic.IEnumerable<System.String> | roles | The roles associated with the request. Defaults to ["All"] if none are provided. |
| System.Collections.Generic.Dictionary<System.String, System.String> | customFields | A collection of custom fields represented as key-value pairs. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ApiResponse<System.Object>> |
Exceptions
| Type | Condition |
|---|---|
| TxException | Thrown when an API error occurs |
AutocompleteCandidates(AutocompleteCandidatesField, String, 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.
Declaration
Task<AutocompleteResponse> AutocompleteCandidates(AutocompleteCandidatesField field, string input, params string[] languages)Parameters
| Type | Name | Description |
|---|---|---|
| AutocompleteCandidatesField | field | Which field to use to retrieve completions |
| System.String | input | The user-typed input string. |
| System.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
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<AutocompleteResponse> |
Exceptions
| Type | Condition |
|---|---|
| TxException | Thrown when an API error occurs |
AutocompleteJobs(AutocompleteJobsField, String, 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.
Declaration
Task<AutocompleteResponse> AutocompleteJobs(AutocompleteJobsField field, string input, params string[] languages)Parameters
| Type | Name | Description |
|---|---|---|
| AutocompleteJobsField | field | Which field to use to retrieve completions |
| System.String | input | The user-typed input string. |
| System.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
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<AutocompleteResponse> |
Exceptions
| Type | Condition |
|---|---|
| TxException | Thrown when an API error occurs |
DeleteCandidates(IEnumerable<String>)
Delete candidate documents from environment
Declaration
Task<DeleteDocumentsResponse> DeleteCandidates(IEnumerable<string> documentIds)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<System.String> | documentIds | The document IDs to delete |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<DeleteDocumentsResponse> |
Exceptions
| Type | Condition |
|---|---|
| TxException | Thrown when an API error occurred |
DeleteJobs(IEnumerable<String>)
Delete job documents from environment
Declaration
Task<DeleteDocumentsResponse> DeleteJobs(IEnumerable<string> documentIds)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<System.String> | documentIds | The document IDs to delete |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<DeleteDocumentsResponse> |
Exceptions
| Type | Condition |
|---|---|
| TxException | Thrown when an API error occurred |
MatchCandidates(String, Options)
Match an existing candidate document with filters provided.
Declaration
Task<SearchResponse> MatchCandidates(string documentId, Options options)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | documentId | The document id that the user would like to run a match on. |
| Options | options | Options for the Match request |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<SearchResponse> |
Exceptions
| Type | Condition |
|---|---|
| TxException | Thrown when an API error occurred |
MatchJobs(String, Options)
Match an existing job document with filters provided.
Declaration
Task<SearchResponse> MatchJobs(string documentId, Options options)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | documentId | The document id that the user would like to run a match on. |
| Options | options | Options for the Match request |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<SearchResponse> |
Exceptions
| Type | Condition |
|---|---|
| TxException | Thrown when an API error occurred |
SearchCandidates(SearchQuery, Options)
Search for a candidate based on the query provided.
Declaration
Task<SearchResponse> SearchCandidates(SearchQuery query, Options options)Parameters
| Type | Name | Description |
|---|---|---|
| SearchQuery | query | The query object that will drive the search. |
| Options | options | Options for the search request |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<SearchResponse> |
Exceptions
| Type | Condition |
|---|---|
| TxException | Thrown when an API error occurred |
SearchJobs(SearchQuery, Options)
Search for a job based on the query provided.
Declaration
Task<SearchResponse> SearchJobs(SearchQuery query, Options options)Parameters
| Type | Name | Description |
|---|---|---|
| SearchQuery | query | The query object that will drive the search. |
| Options | options | Options for the search request |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<SearchResponse> |
Exceptions
| Type | Condition |
|---|---|
| TxException | Thrown when an API error occurred |