Class TxClient
The SDK client to perform Tx API calls.
Inheritance
Inherited Members
Namespace: Textkernel.Tx
Assembly: Textkernel.Tx.SDK.dll
Syntax
public class TxClient : ITxClient, IDisposable
Constructors
| Improve this Doc View SourceTxClient(HttpClient, TxClientSettings)
This constructor allows the user to specify the HttpClient to use. For best practices,
see here.
Here is an example of how to inject a TxClient with DI:
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddSingleton(_ => new TxClientSettings
{
AccountId = "12345678",
...
});
//requires Microsoft.Extensions.Http package
builder.Services.AddHttpClient<ITxClient, TxClient>();
//now you can retrieve your injected client from the service provider
TxClient client = builder.Services.GetRequiredService<TxClient>();
Declaration
public TxClient(HttpClient httpClient, TxClientSettings settings)
Parameters
Type | Name | Description |
---|---|---|
System.Net.Http.HttpClient | httpClient | The HttpClient to use |
TxClientSettings | settings | The settings for this client |
TxClient(String, String, DataCenter, IEnumerable<String>)
Declaration
public TxClient(string accountId, string serviceKey, DataCenter dataCenter, IEnumerable<string> trackingTags = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | accountId | The account id for your account |
System.String | serviceKey | The service key for your account |
DataCenter | dataCenter | |
System.Collections.Generic.IEnumerable<System.String> | trackingTags | Optional tags to use to track API usage for your account |
Remarks
IMPORTANT: if you are using DI or would like to pass in your own HttpClient, use TxClient(HttpClient, TxClientSettings)
Properties
| Improve this Doc View SourceShowFullRequestBodyInExceptions
Set to true for debugging API errors. It will show the full JSON request body in RequestBody
NOTE: do not set this to true in your production system, as it increases the memory footprint
Declaration
public bool ShowFullRequestBodyInExceptions { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Methods
| Improve this Doc View SourceAutocompleteProfession(String, IEnumerable<String>, String, Int32)
Returns normalized professions that begin with a given prefix, based on the chosen language(s). Each profession is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the profession is included in the results.
Declaration
public async Task<AutoCompleteProfessionsResponse> AutocompleteProfession(string prefix, IEnumerable<string> languages = null, string outputLanguage = null, int limit = 10)
Parameters
Type | Name | Description |
---|---|---|
System.String | prefix | The job title prefix to be completed. Must contain at least 1 character. |
System.Collections.Generic.IEnumerable<System.String> | languages | The language(s) used to search for matching professions (the language of the provided prefix).
A maximum of 5 languages can be provided. Must be one of the supported
ISO codes.
|
System.String | outputLanguage | The language to ouput the found professions in (default is 'en'). Must be one of the supported ISO codes. |
System.Int32 | limit | The maximum number of returned professions. The default is 10 and the maximum is 100. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<AutoCompleteProfessionsResponse> | A list of professions that match the given prefix. |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
AutocompleteSkill(String, IEnumerable<String>, String, IEnumerable<String>, Int32)
Returns normalized skills that begin with a given prefix, based on the chosen language(s). Each profession is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the profession is included in the results.
Declaration
public async Task<AutoCompleteSkillsResponse> AutocompleteSkill(string prefix, IEnumerable<string> languages = null, string outputLanguage = null, IEnumerable<string> types = null, int limit = 10)
Parameters
Type | Name | Description |
---|---|---|
System.String | prefix | The skill prefix to be completed. Must contain at least 1 character. |
System.Collections.Generic.IEnumerable<System.String> | languages | The language(s) used to search for matching skills (the language of the provided prefix).
A maximum of 5 languages can be provided. Must be one of the supported
ISO codes.
|
System.String | outputLanguage | The language to ouput the found skills in (default is 'en'). Must be one of the supported ISO codes. |
System.Collections.Generic.IEnumerable<System.String> | types | If specified, only these types of skills will be returned. The following values are acceptable: Professional, IT, Language, Soft, All. |
System.Int32 | limit | The maximum number of returned skills. The default is 10 and the maximum is 100. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<AutoCompleteSkillsResponse> | A list of skills that match the given prefix. |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
BimetricScore<TTarget>(ParsedJobWithId, List<TTarget>, CategoryWeights, SearchMatchSettings)
Score one or more target documents against a source job
Declaration
public async 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
public async 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 |
CompareProfessions(Int32, Int32, String)
Compare two professions based on the skills associated with each.
Declaration
public async Task<CompareProfessionsResponse> CompareProfessions(int profession1, int profession2, string outputLanguage = null)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | profession1 | A profession code ID from the Professions Taxonomy to compare. |
System.Int32 | profession2 | A profession code ID from the Professions Taxonomy to compare. |
System.String | outputLanguage | The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<CompareProfessionsResponse> | Common skills and exclusive skills between the two professions. |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
CompareSkillsToProfession(Int32, String, SkillScore[])
Compare a given set of skills to the skills related to a given profession.
Declaration
public async Task<CompareSkillsToProfessionResponse> CompareSkillsToProfession(int professionCodeId, string outputLanguage = null, params SkillScore[] skills)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | professionCodeId | The profession code ID from the Professions Taxonomy to compare the skill set to. |
System.String | outputLanguage | The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes. |
SkillScore[] | skills | The skill IDs (and optionally, scores) which should be compared against the given profession. The list can contain up to 50 skills. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<CompareSkillsToProfessionResponse> | Common skills and skills not in the profession. |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
CompareSkillsToProfession(ParsedResume, Int32, String, Boolean)
Compare the skills of a candidate to the skills related to a job using the Ontology API.
Declaration
public async Task<CompareSkillsToProfessionResponse> CompareSkillsToProfession(ParsedResume resume, int professionCodeId, string outputLanguage = null, bool weightSkillsByExperience = true)
Parameters
Type | Name | Description |
---|---|---|
ParsedResume | resume | The resume containing the skills of the candidate |
System.Int32 | professionCodeId | The code ID of the profession to compare the skills of the candidate to |
System.String | outputLanguage | The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes. |
System.Boolean | weightSkillsByExperience | Whether or not to give a higher weight to skills that the candidate has more experience with. Default is true. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<CompareSkillsToProfessionResponse> | Skills that are common between the candidate and the job, as well as what skills are missing |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
CreateIndex(IndexType, String)
Create a new index
Declaration
public async 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
public async 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
public async 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
public async 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 |
Dispose()
Disposes this object and the contained HttpClient
Declaration
public void Dispose()
ExtractSkills(String, String, String, Single)
Extracts known skills from the given text.
Declaration
public async Task<ExtractSkillsResponse> ExtractSkills(string text, string language = "en", string outputLanguage = null, float threshold = 0.5F)
Parameters
Type | Name | Description |
---|---|---|
System.String | text | The text to extract skills from. There is a 24,000 character limit. |
System.String | language | The language of the input text. Must be one of the supported
ISO codes.
|
System.String | outputLanguage | The language to use for the output skill descriptions. If not provided, defaults to the input language. Must be one of the supported ISO codes. |
System.Single | threshold | A value from [0 - 1] for the minimum confidence threshold for extracted skills. Lower values will return more skills, but also increase the likelihood of ambiguity-related errors. The recommended and default value is 0.5. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ExtractSkillsResponse> | A list of extracted skills. |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
FormatResume(FormatResumeRequest)
Format a parsed resume into a standardized/templated resume
Declaration
public async Task<FormatResumeResponse> FormatResume(FormatResumeRequest request)
Parameters
Type | Name | Description |
---|---|---|
FormatResumeRequest | request | The request body |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<FormatResumeResponse> | The formatted resume document |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
GenerateJobDescription(GenerateJobRequest)
Generates a job description based on specified parameters.
Declaration
public async Task<GenerateJobResponse> GenerateJobDescription(GenerateJobRequest request)
Parameters
Type | Name | Description |
---|---|---|
GenerateJobRequest | request | The request body |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GenerateJobResponse> |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
Geocode(ParsedJob, Address, GeocodeCredentials)
Use this if you would like to provide an address for geocoding instead of using the one in the parsed job. The address included in the parsed job (if present) will not be modified.
Declaration
public async Task<GeocodeJobResponse> Geocode(ParsedJob job, Address address, GeocodeCredentials geocodeCredentials = null)
Parameters
Type | Name | Description |
---|---|---|
ParsedJob | job | The job to insert the geocoordinates (from the address) into |
Address | address | The address to use to retrieve geocoordinates |
GeocodeCredentials | geocodeCredentials | The credentials used for geocoding |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GeocodeJobResponse> |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
Geocode(ParsedJob, GeocodeCredentials)
Uses the address in the job (if present) to look up geocoordinates and add them into the ParsedJob object. These coordinates are used by the AI Searching/Matching engine.
Declaration
public async Task<GeocodeJobResponse> Geocode(ParsedJob job, GeocodeCredentials geocodeCredentials = null)
Parameters
Type | Name | Description |
---|---|---|
ParsedJob | job | The job to geocode |
GeocodeCredentials | geocodeCredentials | The credentials used for geocoding |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GeocodeJobResponse> |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
Geocode(ParsedResume, Address, GeocodeCredentials)
Use this if you would like to provide an address for geocoding instead of using the one in the parsed resume. The address included in the parsed resume (if present) will not be modified.
Declaration
public async Task<GeocodeResumeResponse> Geocode(ParsedResume resume, Address address, GeocodeCredentials geocodeCredentials = null)
Parameters
Type | Name | Description |
---|---|---|
ParsedResume | resume | The resume to insert the geocoordinates (from the address) into |
Address | address | The address to use to retrieve geocoordinates |
GeocodeCredentials | geocodeCredentials | The credentials used for geocoding |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GeocodeResumeResponse> |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
Geocode(ParsedResume, GeocodeCredentials)
Uses the address in the resume (if present) to look up geocoordinates and add them into the ParsedResume object. These coordinates are used by the AI Searching/Matching engine.
Declaration
public async Task<GeocodeResumeResponse> Geocode(ParsedResume resume, GeocodeCredentials geocodeCredentials = null)
Parameters
Type | Name | Description |
---|---|---|
ParsedResume | resume | The resume to geocode |
GeocodeCredentials | geocodeCredentials | The credentials used for geocoding |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GeocodeResumeResponse> |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
GeocodeAndIndex(ParsedJob, IndexSingleDocumentInfo, Address, GeocodeCredentials, Boolean)
Use this if you would like to provide an address for geocoding instead of using the one in the parsed job. The address included in the parsed job (if present) will not be modified.
Declaration
public async Task<GeocodeAndIndexJobResponse> GeocodeAndIndex(ParsedJob job, IndexSingleDocumentInfo indexingOptions, Address address, GeocodeCredentials geocodeCredentials = null, bool indexIfGeocodeFails = false)
Parameters
Type | Name | Description |
---|---|---|
ParsedJob | job | The job to insert the geocoordinates (from the address) into |
IndexSingleDocumentInfo | indexingOptions | What index/document id to use to index the document after geocoding |
Address | address | The address to use to retrieve geocoordinates |
GeocodeCredentials | geocodeCredentials | The credentials used for geocoding |
System.Boolean | indexIfGeocodeFails | Indicates whether or not the document should still be added to the index if the geocode request fails. Default is false. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GeocodeAndIndexJobResponse> |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
GeocodeAndIndex(ParsedJob, IndexSingleDocumentInfo, GeocodeCredentials, Boolean)
Uses the address in the job (if present) to look up geocoordinates and add them into the ParsedJob object. These coordinates are used by the AI Searching/Matching engine.
Declaration
public async Task<GeocodeAndIndexJobResponse> GeocodeAndIndex(ParsedJob job, IndexSingleDocumentInfo indexingOptions, GeocodeCredentials geocodeCredentials = null, bool indexIfGeocodeFails = false)
Parameters
Type | Name | Description |
---|---|---|
ParsedJob | job | The job to geocode |
IndexSingleDocumentInfo | indexingOptions | What index/document id to use to index the document after geocoding |
GeocodeCredentials | geocodeCredentials | The credentials used for geocoding |
System.Boolean | indexIfGeocodeFails | Indicates whether or not the document should still be added to the index if the geocode request fails. Default is false. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GeocodeAndIndexJobResponse> |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
GeocodeAndIndex(ParsedJob, IndexSingleDocumentInfo, GeoCoordinates, Address, GeocodeCredentials, Boolean)
Use this if you already have latitude/longitude coordinates AND a known address and want to add/override them in your parsed job. The coordinates will be inserted into your parsed job, and the address in the parsed job will not be set/modified with what you specify.
Declaration
public async Task<GeocodeAndIndexJobResponse> GeocodeAndIndex(ParsedJob job, IndexSingleDocumentInfo indexingOptions, GeoCoordinates coordinates, Address address, GeocodeCredentials geocodeCredentials = null, bool indexIfGeocodeFails = false)
Parameters
Type | Name | Description |
---|---|---|
ParsedJob | job | The job to insert the geocoordinates into |
IndexSingleDocumentInfo | indexingOptions | What index/document id to use to index the document after geocoding |
GeoCoordinates | coordinates | The geocoordinates to use |
Address | address | The address to set/override in the parsed job prior to indexing |
GeocodeCredentials | geocodeCredentials | The credentials used for geocoding |
System.Boolean | indexIfGeocodeFails | Indicates whether or not the document should still be added to the index if the geocode request fails. Default is false. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GeocodeAndIndexJobResponse> |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
GeocodeAndIndex(ParsedJob, IndexSingleDocumentInfo, GeoCoordinates, GeocodeCredentials, Boolean)
Use this if you already have latitude/longitude coordinates and simply wish to add them to your parsed job. The coordinates will be inserted into your parsed job, and the address included in the parsed job (if present) will not be modified.
Declaration
public async Task<GeocodeAndIndexJobResponse> GeocodeAndIndex(ParsedJob job, IndexSingleDocumentInfo indexingOptions, GeoCoordinates coordinates, GeocodeCredentials geocodeCredentials = null, bool indexIfGeocodeFails = false)
Parameters
Type | Name | Description |
---|---|---|
ParsedJob | job | The job to insert the geocoordinates into |
IndexSingleDocumentInfo | indexingOptions | What index/document id to use to index the document after geocoding |
GeoCoordinates | coordinates | The geocoordinates to use |
GeocodeCredentials | geocodeCredentials | The credentials used for geocoding |
System.Boolean | indexIfGeocodeFails | Indicates whether or not the document should still be added to the index if the geocode request fails. Default is false. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GeocodeAndIndexJobResponse> |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
GeocodeAndIndex(ParsedResume, IndexSingleDocumentInfo, Address, GeocodeCredentials, Boolean)
Use this if you would like to provide an address for geocoding instead of using the one in the parsed resume. The address included in the parsed resume (if present) will not be modified.
Declaration
public async Task<GeocodeAndIndexResumeResponse> GeocodeAndIndex(ParsedResume resume, IndexSingleDocumentInfo indexingOptions, Address address, GeocodeCredentials geocodeCredentials = null, bool indexIfGeocodeFails = false)
Parameters
Type | Name | Description |
---|---|---|
ParsedResume | resume | The resume to insert the geocoordinates (from the address) into |
IndexSingleDocumentInfo | indexingOptions | What index/document id to use to index the document after geocoding |
Address | address | The address to use to retrieve geocoordinates |
GeocodeCredentials | geocodeCredentials | The credentials used for geocoding |
System.Boolean | indexIfGeocodeFails | Indicates whether or not the document should still be added to the index if the geocode request fails. Default is false. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GeocodeAndIndexResumeResponse> |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
GeocodeAndIndex(ParsedResume, IndexSingleDocumentInfo, GeocodeCredentials, Boolean)
Uses the address in the resume (if present) to look up geocoordinates and add them into the ParsedResume object. These coordinates are used by the AI Searching/Matching engine.
Declaration
public async Task<GeocodeAndIndexResumeResponse> GeocodeAndIndex(ParsedResume resume, IndexSingleDocumentInfo indexingOptions, GeocodeCredentials geocodeCredentials = null, bool indexIfGeocodeFails = false)
Parameters
Type | Name | Description |
---|---|---|
ParsedResume | resume | The resume to geocode |
IndexSingleDocumentInfo | indexingOptions | What index/document id to use to index the document after geocoding |
GeocodeCredentials | geocodeCredentials | The credentials used for geocoding |
System.Boolean | indexIfGeocodeFails | Indicates whether or not the document should still be added to the index if the geocode request fails. Default is false. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GeocodeAndIndexResumeResponse> |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
GeocodeAndIndex(ParsedResume, IndexSingleDocumentInfo, GeoCoordinates, Address, GeocodeCredentials, Boolean)
Use this if you already have latitude/longitude coordinates AND a known address and want to add/override them in your parsed resume. The coordinates will be inserted into your parsed resume, and the address in the parsed resume will not be set/modified with what you specify.
Declaration
public async Task<GeocodeAndIndexResumeResponse> GeocodeAndIndex(ParsedResume resume, IndexSingleDocumentInfo indexingOptions, GeoCoordinates coordinates, Address address, GeocodeCredentials geocodeCredentials = null, bool indexIfGeocodeFails = false)
Parameters
Type | Name | Description |
---|---|---|
ParsedResume | resume | The resume to insert the geocoordinates into |
IndexSingleDocumentInfo | indexingOptions | What index/document id to use to index the document after geocoding |
GeoCoordinates | coordinates | The geocoordinates to use |
Address | address | The address to set/override in the parsed resume prior to indexing |
GeocodeCredentials | geocodeCredentials | The credentials used for geocoding |
System.Boolean | indexIfGeocodeFails | Indicates whether or not the document should still be added to the index if the geocode request fails. Default is false. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GeocodeAndIndexResumeResponse> |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
GeocodeAndIndex(ParsedResume, IndexSingleDocumentInfo, GeoCoordinates, GeocodeCredentials, Boolean)
Use this if you already have latitude/longitude coordinates and simply wish to add them to your parsed resume. The coordinates will be inserted into your parsed resume, and the address included in the parsed resume (if present) will not be modified.
Declaration
public async Task<GeocodeAndIndexResumeResponse> GeocodeAndIndex(ParsedResume resume, IndexSingleDocumentInfo indexingOptions, GeoCoordinates coordinates, GeocodeCredentials geocodeCredentials = null, bool indexIfGeocodeFails = false)
Parameters
Type | Name | Description |
---|---|---|
ParsedResume | resume | The resume to insert the geocoordinates into |
IndexSingleDocumentInfo | indexingOptions | What index/document id to use to index the document after geocoding |
GeoCoordinates | coordinates | The geocoordinates to use |
GeocodeCredentials | geocodeCredentials | The credentials used for geocoding |
System.Boolean | indexIfGeocodeFails | Indicates whether or not the document should still be added to the index if the geocode request fails. Default is false. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GeocodeAndIndexResumeResponse> |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
GetAccountInfo()
Get the account info (remaining credits, max concurrency, etc).
Declaration
public async Task<GetAccountInfoResponse> GetAccountInfo()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GetAccountInfoResponse> |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurs |
GetAllIndexes()
Get all existing indexes
Declaration
public async 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
public async 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 |
GetProfessionsTaxonomy(String, TaxonomyFormat)
Get all professions in the taxonomy with associated IDs and descriptions in all supported languages.
Declaration
public async Task<GetProfessionsTaxonomyResponse> GetProfessionsTaxonomy(string language = null, TaxonomyFormat format = TaxonomyFormat.json)
Parameters
Type | Name | Description |
---|---|---|
System.String | language | The language parameter returns the taxonomy with descriptions only in that specified language. If not specified, descriptions in all languages are returned. Must be specified as one of the supported ISO codes. |
TaxonomyFormat | format | The format of the returned taxonomy.
|
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GetProfessionsTaxonomyResponse> | The full structure of the Professions Taxonomy |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
GetProfessionsTaxonomyMetadata()
Get metadata about the professions taxonomy/service.
Declaration
public async Task<GetMetadataResponse> GetProfessionsTaxonomyMetadata()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GetMetadataResponse> | Metadata related to the professions taxonomy. |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
GetResume(String, String)
Retrieve an existing resume from an index
Declaration
public async 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 |
GetSkillsTaxonomy(TaxonomyFormat)
Get all skills in the taxonomy with associated IDs and descriptions in all supported languages.
Declaration
public async Task<GetSkillsTaxonomyResponse> GetSkillsTaxonomy(TaxonomyFormat format = TaxonomyFormat.json)
Parameters
Type | Name | Description |
---|---|---|
TaxonomyFormat | format | The format of the returned taxonomy.
|
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GetSkillsTaxonomyResponse> | The full structure of the Skills Taxonomy. |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
GetSkillsTaxonomyMetadata()
Get metadata about the skills taxonomy/service.
Declaration
public async Task<GetMetadataResponse> GetSkillsTaxonomyMetadata()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GetMetadataResponse> | The skills taxonomy metadata |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
IndexDocument(ParsedJob, String, String, IEnumerable<String>)
Add a job to an existing index
Declaration
public async 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
public async 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
public async 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
public async 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 |
LookupProfessions(IEnumerable<Int32>, String)
Get details for the given professions in the taxonomy.
Declaration
public async Task<LookupProfessionCodesResponse> LookupProfessions(IEnumerable<int> codeIds, string outputLanguage = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<System.Int32> | codeIds | The profession code IDs to get details about from the Professions Taxonomy. |
System.String | outputLanguage | The language to use for professions descriptions (default is en). Must be an allowed
ISO code.
|
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<LookupProfessionCodesResponse> | A list of returned professions. |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
LookupSkills(IEnumerable<String>, String)
Get the details associated with given skills in the taxonomy.
Declaration
public async Task<LookupSkillCodesResponse> LookupSkills(IEnumerable<string> skillIds, string outputLanguage = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<System.String> | skillIds | |
System.String | outputLanguage | The language to use for the output skill descriptions. Must be one of the supported
ISO codes.
|
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<LookupSkillCodesResponse> | An array of skills objects. |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
Match(String, String, IEnumerable<String>, CategoryWeights, FilterCriteria, SearchMatchSettings, Int32)
Find matches for a resume or job that is already indexed
Declaration
public async 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
public async 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
public async 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 |
NormalizeProfessions(IEnumerable<String>, String, String)
Normalize the given job titles to the most closely-related professions in the taxonomy.
Declaration
public async Task<NormalizeProfessionsResponse> NormalizeProfessions(IEnumerable<string> jobTitles, string language = null, string outputLanguage = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<System.String> | jobTitles | The list of job titles to normalize (up to 10 job titles, each job title may not exceed 400 characters). |
System.String | language | The language of the input job titles. Must be one of the supported
ISO codes.
|
System.String | outputLanguage | The language to use for descriptions of the returned normalized professions. Must be one of the supported
ISO codes.
|
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<NormalizeProfessionsResponse> | A list of returned professions. |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
NormalizeSkills(IEnumerable<String>, String, String)
Normalize the given skills to the most closely-related skills in the taxonomy.
Declaration
public async Task<NormalizeSkillsResponse> NormalizeSkills(IEnumerable<string> skills, string language = "en", string outputLanguage = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<System.String> | skills | The list of skills to normalize (up to 50 skills, each skill may not exceed 100 characters). |
System.String | language | The language of the given skills. Must be one of the supported
ISO codes.
|
System.String | outputLanguage | The language to use for the output skill descriptions. Must be one of the supported
ISO codes.
|
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<NormalizeSkillsResponse> | An array of skills objects. |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
ParseJob(ParseRequest)
Parse a job
Declaration
public async Task<ParseJobResponse> ParseJob(ParseRequest request)
Parameters
Type | Name | Description |
---|---|---|
ParseRequest | request | The request body |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ParseJobResponse> | The parse result and any metadata |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when a parsing or API error occurred |
TxGeocodeJobException | Thrown when parsing was successful, but an error occurred during geocoding |
TxIndexJobException | Thrown when parsing was successful, but an error occurred during indexing |
TxProfessionNormalizationJobException | Thrown when parsing was successful, but an error occurred during profession normalization |
ParseResume(ParseRequest)
Parse a resume
Declaration
public async Task<ParseResumeResponse> ParseResume(ParseRequest request)
Parameters
Type | Name | Description |
---|---|---|
ParseRequest | request | The request body |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ParseResumeResponse> | The parse result and any metadata |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when a parsing or API error occurred |
TxGeocodeResumeException | Thrown when parsing was successful, but an error occurred during geocoding |
TxIndexResumeException | Thrown when parsing was successful, but an error occurred during indexing |
TxProfessionNormalizationResumeException | Thrown when parsing was successful, but an error occurred during profession normalization |
Search(IEnumerable<String>, FilterCriteria, SearchMatchSettings, PaginationSettings)
Search for resumes or jobs that meet specific criteria
Declaration
public async 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 |
SkillsSimilarityScore(IEnumerable<SkillScore>, IEnumerable<SkillScore>)
Determines how closely related one set of skills is to another. The service defines closely related skills such that knowing a skill either implies knowledge about another skill, or should make it considerably easier to acquire knowledge about that skill.
Declaration
public async Task<SkillsSimilarityScoreResponse> SkillsSimilarityScore(IEnumerable<SkillScore> skillSetA, IEnumerable<SkillScore> skillSetB)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<SkillScore> | skillSetA | A set of skills (and optionally, scores) to score against the other set of skills. The list can contain up to 50 skills. |
System.Collections.Generic.IEnumerable<SkillScore> | skillSetB | A set of skills (and optionally, scores) to score against the other set of skills. The list can contain up to 50 skills. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<SkillsSimilarityScoreResponse> | A score from [0 - 1] representing how closely related skill set A and skill set B are, based on the relations between skills. |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
SuggestProfessionsFromSkills(IEnumerable<SkillScore>, Int32, Boolean, String)
Suggest professions based on a given set of skill IDs.
Declaration
public async Task<SuggestProfessionsResponse> SuggestProfessionsFromSkills(IEnumerable<SkillScore> skills, int limit = 10, bool returnMissingSkills = false, string outputLanguage = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<SkillScore> | skills | The skill IDs (and optionally, scores) used to return the most relevant professions. The list can contain up to 50 skill IDs. |
System.Int32 | limit | The maximum amount of professions returned. If not specified this parameter defaults to 10. |
System.Boolean | returnMissingSkills | Flag to enable returning a list of missing skills per suggested profession. |
System.String | outputLanguage | The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<SuggestProfessionsResponse> | A list of professions most relevant to the given skills. |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
SuggestProfessionsFromSkills(ParsedJob, Int32, Boolean, String)
Suggest professions based on the skills within a given job.
Declaration
public async Task<SuggestProfessionsResponse> SuggestProfessionsFromSkills(ParsedJob job, int limit = 10, bool returnMissingSkills = false, string outputLanguage = null)
Parameters
Type | Name | Description |
---|---|---|
ParsedJob | job | The professions are suggested based on the skills within this job. |
System.Int32 | limit | The maximum amount of professions returned. If not specified this parameter defaults to 10. |
System.Boolean | returnMissingSkills | Flag to enable returning a list of missing skills per suggested profession. |
System.String | outputLanguage | The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<SuggestProfessionsResponse> | A list of professions most relevant to the given job, based on skills. |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
SuggestProfessionsFromSkills(ParsedResume, Int32, Boolean, String, Boolean)
Suggest professions based on the skills within a given resume.
Declaration
public async Task<SuggestProfessionsResponse> SuggestProfessionsFromSkills(ParsedResume resume, int limit = 10, bool returnMissingSkills = false, string outputLanguage = null, bool weightSkillsByExperience = true)
Parameters
Type | Name | Description |
---|---|---|
ParsedResume | resume | The professions are suggested based on the skills within this resume. |
System.Int32 | limit | The maximum amount of professions returned. If not specified this parameter defaults to 10. |
System.Boolean | returnMissingSkills | Flag to enable returning a list of missing skills per suggested profession. |
System.String | outputLanguage | The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes. |
System.Boolean | weightSkillsByExperience | Whether or not to give a higher weight to skills that the candidate has more experience with. Default is true. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<SuggestProfessionsResponse> | A list of professions most relevant to the given resume, based on skills. |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
SuggestSkillsFromJobTitle(String, String, Nullable<Int32>)
Takes a job title and suggests relevant skills.
Declaration
public async Task<SuggestSkillsFromJobTitleResponse> SuggestSkillsFromJobTitle(string jobTitle, string language = "en", int? limit = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | jobTitle | The title of the job for which skills are being suggested. |
System.String | language | Language of the suggested skills in ISO 639-1 code format. |
System.Nullable<System.Int32> | limit | Maximum number of skills to suggest. If not specified this parameter defaults to 10. This value cannot exceed 50. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<SuggestSkillsFromJobTitleResponse> |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
SuggestSkillsFromProfessions(IEnumerable<Int32>, Int32, String)
Suggests skills related to given professions. The service returns salient skills that are strongly associated with the professions.
Declaration
public async Task<SuggestSkillsResponse> SuggestSkillsFromProfessions(IEnumerable<int> professionCodeIDs, int limit = 10, string outputLanguage = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<System.Int32> | professionCodeIDs | The code IDs of the professions to suggest skills for. |
System.Int32 | limit | The maximum amount of suggested skills returned. The default is 10. |
System.String | outputLanguage | The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<SuggestSkillsResponse> | A list of suggested skills. |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
SuggestSkillsFromProfessions(ParsedJob, Int32, String)
Suggests skills related to a job based on the profession title in the job.
Declaration
public async Task<SuggestSkillsResponse> SuggestSkillsFromProfessions(ParsedJob job, int limit = 10, string outputLanguage = null)
Parameters
Type | Name | Description |
---|---|---|
ParsedJob | job | The job to suggest skills for (based on the profession in the job) |
System.Int32 | limit | The maximum amount of suggested skills returned. The default is 10. |
System.String | outputLanguage | The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<SuggestSkillsResponse> | A list of suggested skills. |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
SuggestSkillsFromProfessions(ParsedResume, Int32, String)
Suggests skills related to a resume based on the recent professions in the resume.
Declaration
public async Task<SuggestSkillsResponse> SuggestSkillsFromProfessions(ParsedResume resume, int limit = 10, string outputLanguage = null)
Parameters
Type | Name | Description |
---|---|---|
ParsedResume | resume | The resume to suggest skills for (based on the professions in the resume) |
System.Int32 | limit | The maximum amount of suggested skills returned. The default is 10. |
System.String | outputLanguage | The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<SuggestSkillsResponse> | A list of suggested skills. |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
SuggestSkillsFromSkills(IEnumerable<SkillScore>, Int32, String)
Returns skills related to a given skill or set of skills. The service returns closely related skills in a sense that knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably easier to acquire knowledge about them.
Declaration
public async Task<SuggestSkillsResponse> SuggestSkillsFromSkills(IEnumerable<SkillScore> skills, int limit = 25, string outputLanguage = null)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<SkillScore> | skills | The skills (and optionally, scores) for which the service should return related skills. The list can contain up to 50 skills. |
System.Int32 | limit | The maximum amount of suggested skills returned. The maximum and default is 25. |
System.String | outputLanguage | The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<SuggestSkillsResponse> | A list of suggested skills. |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
SuggestSkillsFromSkills(ParsedJob, Int32, String)
Suggests skills related to a job (but not in the job) based on the skills in the job. The service returns closely related skills in a sense that knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably easier to acquire knowledge about them.
Declaration
public async Task<SuggestSkillsResponse> SuggestSkillsFromSkills(ParsedJob job, int limit = 10, string outputLanguage = null)
Parameters
Type | Name | Description |
---|---|---|
ParsedJob | job | The job to suggest skills for (based on the skills in the job) |
System.Int32 | limit | The maximum amount of suggested skills returned. The maximum and default is 25. |
System.String | outputLanguage | The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<SuggestSkillsResponse> | A list of suggested skills. |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
SuggestSkillsFromSkills(ParsedResume, Int32, String, Boolean)
Suggests skills related to a resume (but not in the resume) based on the skills in the resume. The service returns closely related skills in a sense that knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably easier to acquire knowledge about them.
Declaration
public async Task<SuggestSkillsResponse> SuggestSkillsFromSkills(ParsedResume resume, int limit = 10, string outputLanguage = null, bool weightSkillsByExperience = true)
Parameters
Type | Name | Description |
---|---|---|
ParsedResume | resume | The resume to suggest skills for (based on the skills in the resume) |
System.Int32 | limit | The maximum amount of suggested skills returned. The maximum and default is 10. |
System.String | outputLanguage | The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes. |
System.Boolean | weightSkillsByExperience | Whether or not to give a higher weight to skills that the candidate has more experience with. Default is true. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<SuggestSkillsResponse> | A list of suggested skills. |
Exceptions
Type | Condition |
---|---|
TxException | Thrown when an API error occurred |
UpdateJobUserDefinedTags(String, String, IEnumerable<String>, UserDefinedTagsMethod)
Updates the user-defined tags for a job
Declaration
public async 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
public async 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 |