Interface ISkillsIntelligenceClient

Use SkillsIntelligence

Namespace: Textkernel.Tx.Services

Assembly: Textkernel.Tx.SDK.dll

Syntax

public interface ISkillsIntelligenceClient

Methods

AutocompleteProfession(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

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. Default is 'en' only.
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

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. Default is 'en' only.
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

CompareProfessions(Int32, Int32, String)

Compare two professions based on the skills associated with each.

Declaration

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

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

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

ExtractSkills(String, String, String, Single)

Extracts known skills from the given text.

Declaration

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. Default is 'en'.
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

GenerateJobDescription(GenerateJobRequest)

Generates a job description based on specified parameters.

Declaration

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

GetProfessionsTaxonomy(String, TaxonomyFormat)

Get all professions in the taxonomy with associated IDs and descriptions in all supported languages.

Declaration

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. NOTE: if you set this to csv, only the CsvOutput will be populated.

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

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

GetSkillsTaxonomy(TaxonomyFormat)

Get all skills in the taxonomy with associated IDs and descriptions in all supported languages.

Declaration

Task<GetSkillsTaxonomyResponse> GetSkillsTaxonomy(TaxonomyFormat format = TaxonomyFormat.json)

Parameters

Type	Name	Description
TaxonomyFormat	format	The format of the returned taxonomy. NOTE: if you set this to csv, only the CsvOutput will be populated.

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

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

LookupProfessions(IEnumerable<Int32>, String)

Get details for the given professions in the taxonomy.

Declaration

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. Default is 'en'.

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

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. Default is 'en'.

Returns

Type	Description
System.Threading.Tasks.Task<LookupSkillCodesResponse>	An array of skills objects.

Exceptions

Type	Condition
TxException	Thrown when an API error occurred

NormalizeProfessions(IEnumerable<String>, String, String)

Normalize the given job titles to the most closely-related professions in the taxonomy.

Declaration

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. Default is 'en'.
System.String	outputLanguage	The language to use for descriptions of the returned normalized professions. Must be one of the supported ISO codes. Defaults to whatever is used for the 'language' parameter.

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

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. Default is 'en'.
System.String	outputLanguage	The language to use for the output skill descriptions. Must be one of the supported ISO codes. Defaults to whatever is used for the 'language' parameter.

Returns

Type	Description
System.Threading.Tasks.Task<NormalizeSkillsResponse>	An array of skills objects.

Exceptions

Type	Condition
TxException	Thrown when an API error occurred

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

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

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

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

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

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

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

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

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

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

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

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