Interface ISkillsIntelligenceClient

Namespace

Textkernel.Tx.Services

Assembly

Textkernel.Tx.SDK.dll

Use SkillsIntelligence

public interface ISkillsIntelligenceClient

Methods

AutocompleteProfession(string, IEnumerable<string>, string, int)

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.

Task<AutoCompleteProfessionsResponse> AutocompleteProfession(string prefix, IEnumerable<string> languages = null, string outputLanguage = null, int limit = 10)

Parameters

prefix string

The job title prefix to be completed. Must contain at least 1 character.

languages IEnumerable<string>

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.

outputLanguage string

The language to ouput the found professions in (default is 'en'). Must be one of the supported ISO codes.

limit int

The maximum number of returned professions. The default is 10 and the maximum is 100.

Returns

Task<AutoCompleteProfessionsResponse>

A list of professions that match the given prefix.

Exceptions

TxException

Thrown when an API error occurred

AutocompleteSkill(string, IEnumerable<string>, string, IEnumerable<string>, int)

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.

Task<AutoCompleteSkillsResponse> AutocompleteSkill(string prefix, IEnumerable<string> languages = null, string outputLanguage = null, IEnumerable<string> types = null, int limit = 10)

Parameters

prefix string

The skill prefix to be completed. Must contain at least 1 character.

languages IEnumerable<string>

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.

outputLanguage string

The language to ouput the found skills in (default is 'en'). Must be one of the supported ISO codes.

types IEnumerable<string>

If specified, only these types of skills will be returned. The following values are acceptable: Professional, IT, Language, Soft, All.

limit int

The maximum number of returned skills. The default is 10 and the maximum is 100.

Returns

Task<AutoCompleteSkillsResponse>

A list of skills that match the given prefix.

Exceptions

TxException

Thrown when an API error occurred

CompareProfessions(int, int, string)

Compare two professions based on the skills associated with each.

Task<CompareProfessionsResponse> CompareProfessions(int profession1, int profession2, string outputLanguage = null)

Parameters

profession1 int

A profession code ID from the Professions Taxonomy to compare.

profession2 int

A profession code ID from the Professions Taxonomy to compare.

outputLanguage string

The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes.

Returns

Task<CompareProfessionsResponse>

Common skills and exclusive skills between the two professions.

Exceptions

TxException

Thrown when an API error occurred

CompareSkillsToProfession(int, string, params SkillScore[])

Compare a given set of skills to the skills related to a given profession.

Task<CompareSkillsToProfessionResponse> CompareSkillsToProfession(int professionCodeId, string outputLanguage = null, params SkillScore[] skills)

Parameters

professionCodeId int

The profession code ID from the Professions Taxonomy to compare the skill set to.

outputLanguage string

The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes.

skills SkillScore[]

The skill IDs (and optionally, scores) which should be compared against the given profession. The list can contain up to 50 skills.

Returns

Task<CompareSkillsToProfessionResponse>

Common skills and skills not in the profession.

Exceptions

TxException

Thrown when an API error occurred

CompareSkillsToProfession(ParsedResume, int, string, bool)

Compare the skills of a candidate to the skills related to a job using the Ontology API.

Task<CompareSkillsToProfessionResponse> CompareSkillsToProfession(ParsedResume resume, int professionCodeId, string outputLanguage = null, bool weightSkillsByExperience = true)

Parameters

resume ParsedResume

The resume containing the skills of the candidate

professionCodeId int

The code ID of the profession to compare the skills of the candidate to

outputLanguage string

The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes.

weightSkillsByExperience bool

Whether or not to give a higher weight to skills that the candidate has more experience with. Default is true.

Returns

Task<CompareSkillsToProfessionResponse>

Skills that are common between the candidate and the job, as well as what skills are missing

Exceptions

TxException

Thrown when an API error occurred

ExtractSkills(string, string, string, float)

Extracts known skills from the given text.

Task<ExtractSkillsResponse> ExtractSkills(string text, string language = "en", string outputLanguage = null, float threshold = 0.5)

Parameters

text string

The text to extract skills from. There is a 24,000 character limit.

language string

The language of the input text. Must be one of the supported ISO codes.
Default is 'en'.

outputLanguage string

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.

threshold float

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

Task<ExtractSkillsResponse>

A list of extracted skills.

Exceptions

TxException

Thrown when an API error occurred

GenerateJobDescription(GenerateJobRequest)

Generates a job description based on specified parameters.

Task<GenerateJobResponse> GenerateJobDescription(GenerateJobRequest request)

Parameters

request GenerateJobRequest

The request body

Returns

Task<GenerateJobResponse>

Exceptions

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.

Task<GetProfessionsTaxonomyResponse> GetProfessionsTaxonomy(string language = null, TaxonomyFormat format = TaxonomyFormat.json)

Parameters

language string

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.

format TaxonomyFormat

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

Returns

Task<GetProfessionsTaxonomyResponse>

The full structure of the Professions Taxonomy

Exceptions

TxException

Thrown when an API error occurred

GetProfessionsTaxonomyMetadata()

Get metadata about the professions taxonomy/service.

Task<GetMetadataResponse> GetProfessionsTaxonomyMetadata()

Returns

Task<GetMetadataResponse>

Metadata related to the professions taxonomy.

Exceptions

TxException

Thrown when an API error occurred

GetSkillsTaxonomy(TaxonomyFormat)

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

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

Parameters

format TaxonomyFormat

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

Returns

Task<GetSkillsTaxonomyResponse>

The full structure of the Skills Taxonomy.

Exceptions

TxException

Thrown when an API error occurred

GetSkillsTaxonomyMetadata()

Get metadata about the skills taxonomy/service.

Task<GetMetadataResponse> GetSkillsTaxonomyMetadata()

Returns

Task<GetMetadataResponse>

The skills taxonomy metadata

Exceptions

TxException

Thrown when an API error occurred

LookupProfessions(IEnumerable<int>, string)

Get details for the given professions in the taxonomy.

Task<LookupProfessionCodesResponse> LookupProfessions(IEnumerable<int> codeIds, string outputLanguage = null)

Parameters

codeIds IEnumerable<int>

The profession code IDs to get details about from the Professions Taxonomy.

outputLanguage string

The language to use for professions descriptions (default is en). Must be an allowed ISO code.
Default is 'en'.

Returns

Task<LookupProfessionCodesResponse>

A list of returned professions.

Exceptions

TxException

Thrown when an API error occurred

LookupSkills(IEnumerable<string>, string)

Get the details associated with given skills in the taxonomy.

Task<LookupSkillCodesResponse> LookupSkills(IEnumerable<string> skillIds, string outputLanguage = null)

Parameters

skillIds IEnumerable<string>

outputLanguage string

The language to use for the output skill descriptions. Must be one of the supported ISO codes.
Default is 'en'.

Returns

Task<LookupSkillCodesResponse>

An array of skills objects.

Exceptions

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.

Task<NormalizeProfessionsResponse> NormalizeProfessions(IEnumerable<string> jobTitles, string language = null, string outputLanguage = null)

Parameters

jobTitles IEnumerable<string>

The list of job titles to normalize (up to 10 job titles, each job title may not exceed 400 characters).

language string

The language of the input job titles. Must be one of the supported ISO codes.
Default is 'en'.

outputLanguage string

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

Task<NormalizeProfessionsResponse>

A list of returned professions.

Exceptions

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.

Task<NormalizeSkillsResponse> NormalizeSkills(IEnumerable<string> skills, string language = "en", string outputLanguage = null)

Parameters

skills IEnumerable<string>

The list of skills to normalize (up to 50 skills, each skill may not exceed 100 characters).

language string

The language of the given skills. Must be one of the supported ISO codes.
Default is 'en'.

outputLanguage string

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

Task<NormalizeSkillsResponse>

An array of skills objects.

Exceptions

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.

Task<SkillsSimilarityScoreResponse> SkillsSimilarityScore(IEnumerable<SkillScore> skillSetA, IEnumerable<SkillScore> skillSetB)

Parameters

skillSetA IEnumerable<SkillScore>

A set of skills (and optionally, scores) to score against the other set of skills. The list can contain up to 50 skills.

skillSetB IEnumerable<SkillScore>

A set of skills (and optionally, scores) to score against the other set of skills. The list can contain up to 50 skills.

Returns

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

TxException

Thrown when an API error occurred

SuggestProfessionsFromSkills(IEnumerable<SkillScore>, int, bool, string)

Suggest professions based on a given set of skill IDs.

Task<SuggestProfessionsResponse> SuggestProfessionsFromSkills(IEnumerable<SkillScore> skills, int limit = 10, bool returnMissingSkills = false, string outputLanguage = null)

Parameters

skills IEnumerable<SkillScore>

The skill IDs (and optionally, scores) used to return the most relevant professions. The list can contain up to 50 skill IDs.

limit int

The maximum amount of professions returned. If not specified this parameter defaults to 10.

returnMissingSkills bool

Flag to enable returning a list of missing skills per suggested profession.

outputLanguage string

The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes.

Returns

Task<SuggestProfessionsResponse>

A list of professions most relevant to the given skills.

Exceptions

TxException

Thrown when an API error occurred

SuggestProfessionsFromSkills(ParsedJob, int, bool, string)

Suggest professions based on the skills within a given job.

Task<SuggestProfessionsResponse> SuggestProfessionsFromSkills(ParsedJob job, int limit = 10, bool returnMissingSkills = false, string outputLanguage = null)

Parameters

job ParsedJob

The professions are suggested based on the skills within this job.

limit int

The maximum amount of professions returned. If not specified this parameter defaults to 10.

returnMissingSkills bool

Flag to enable returning a list of missing skills per suggested profession.

outputLanguage string

The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes.

Returns

Task<SuggestProfessionsResponse>

A list of professions most relevant to the given job, based on skills.

Exceptions

TxException

Thrown when an API error occurred

SuggestProfessionsFromSkills(ParsedResume, int, bool, string, bool)

Suggest professions based on the skills within a given resume.

Task<SuggestProfessionsResponse> SuggestProfessionsFromSkills(ParsedResume resume, int limit = 10, bool returnMissingSkills = false, string outputLanguage = null, bool weightSkillsByExperience = true)

Parameters

resume ParsedResume

The professions are suggested based on the skills within this resume.

limit int

The maximum amount of professions returned. If not specified this parameter defaults to 10.

returnMissingSkills bool

Flag to enable returning a list of missing skills per suggested profession.

outputLanguage string

The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes.

weightSkillsByExperience bool

Whether or not to give a higher weight to skills that the candidate has more experience with. Default is true.

Returns

Task<SuggestProfessionsResponse>

A list of professions most relevant to the given resume, based on skills.

Exceptions

TxException

Thrown when an API error occurred

SuggestSkillsFromJobTitle(string, string, int?)

Takes a job title and suggests relevant skills.

Task<SuggestSkillsFromJobTitleResponse> SuggestSkillsFromJobTitle(string jobTitle, string language = "en", int? limit = null)

Parameters

jobTitle string

The title of the job for which skills are being suggested.

language string

Language of the suggested skills in ISO 639-1 code format.

limit int?

Maximum number of skills to suggest. If not specified this parameter defaults to 10. This value cannot exceed 50.

Returns

Task<SuggestSkillsFromJobTitleResponse>

Exceptions

TxException

Thrown when an API error occurred

SuggestSkillsFromProfessions(IEnumerable<int>, int, string)

Suggests skills related to given professions. The service returns salient skills that are strongly associated with the professions.

Task<SuggestSkillsResponse> SuggestSkillsFromProfessions(IEnumerable<int> professionCodeIDs, int limit = 10, string outputLanguage = null)

Parameters

professionCodeIDs IEnumerable<int>

The code IDs of the professions to suggest skills for.

limit int

The maximum amount of suggested skills returned. The default is 10.

outputLanguage string

The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes.

Returns

Task<SuggestSkillsResponse>

A list of suggested skills.

Exceptions

TxException

Thrown when an API error occurred

SuggestSkillsFromProfessions(ParsedJob, int, string)

Suggests skills related to a job based on the profession title in the job.

Task<SuggestSkillsResponse> SuggestSkillsFromProfessions(ParsedJob job, int limit = 10, string outputLanguage = null)

Parameters

job ParsedJob

The job to suggest skills for (based on the profession in the job)

limit int

The maximum amount of suggested skills returned. The default is 10.

outputLanguage string

The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes.

Returns

Task<SuggestSkillsResponse>

A list of suggested skills.

Exceptions

TxException

Thrown when an API error occurred

SuggestSkillsFromProfessions(ParsedResume, int, string)

Suggests skills related to a resume based on the recent professions in the resume.

Task<SuggestSkillsResponse> SuggestSkillsFromProfessions(ParsedResume resume, int limit = 10, string outputLanguage = null)

Parameters

resume ParsedResume

The resume to suggest skills for (based on the professions in the resume)

limit int

The maximum amount of suggested skills returned. The default is 10.

outputLanguage string

The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes.

Returns

Task<SuggestSkillsResponse>

A list of suggested skills.

Exceptions

TxException

Thrown when an API error occurred

SuggestSkillsFromSkills(IEnumerable<SkillScore>, int, 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.

Task<SuggestSkillsResponse> SuggestSkillsFromSkills(IEnumerable<SkillScore> skills, int limit = 25, string outputLanguage = null)

Parameters

skills IEnumerable<SkillScore>

The skills (and optionally, scores) for which the service should return related skills. The list can contain up to 50 skills.

limit int

The maximum amount of suggested skills returned. The maximum and default is 25.

outputLanguage string

The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes.

Returns

Task<SuggestSkillsResponse>

A list of suggested skills.

Exceptions

TxException

Thrown when an API error occurred

SuggestSkillsFromSkills(ParsedJob, int, 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.

Task<SuggestSkillsResponse> SuggestSkillsFromSkills(ParsedJob job, int limit = 10, string outputLanguage = null)

Parameters

job ParsedJob

The job to suggest skills for (based on the skills in the job)

limit int

The maximum amount of suggested skills returned. The maximum and default is 25.

outputLanguage string

The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes.

Returns

Task<SuggestSkillsResponse>

A list of suggested skills.

Exceptions

TxException

Thrown when an API error occurred

SuggestSkillsFromSkills(ParsedResume, int, string, bool)

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.

Task<SuggestSkillsResponse> SuggestSkillsFromSkills(ParsedResume resume, int limit = 10, string outputLanguage = null, bool weightSkillsByExperience = true)

Parameters

resume ParsedResume

The resume to suggest skills for (based on the skills in the resume)

limit int

The maximum amount of suggested skills returned. The maximum and default is 10.

outputLanguage string

The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes.

weightSkillsByExperience bool

Whether or not to give a higher weight to skills that the candidate has more experience with. Default is true.

Returns

Task<SuggestSkillsResponse>

A list of suggested skills.

Exceptions

TxException

Thrown when an API error occurred