Table of Contents

Class FilterCriteria

Namespace
Textkernel.Tx.Models.API.Matching.Request
Assembly
Textkernel.Tx.SDK.dll

Criteria for filtering search/match results

public class FilterCriteria
Inheritance
FilterCriteria
Inherited Members

Properties

AverageMonthsPerEmployer

Results much have AverageMonthsPerEmployer within this range. Only applicable for resumes; setting this when filtering jobs will cause an error.

public IntegerRange AverageMonthsPerEmployer { get; set; }

Property Value

IntegerRange

Certifications

Results must have at least one of the specified certifications. Supports (*, ?) wildcard characters after the third character in the term as defined in https://developer.textkernel.com/tx-platform/v10/ai-matching/overview/querying/#ai-filtering-special-operators

public List<string> Certifications { get; set; }

Property Value

List<string>

CurrentManagementLevel

Results must currently have at least one of the following management levels:
None
Low
Mid
High

public string CurrentManagementLevel { get; set; }

Property Value

string

DegreeNames

Results must have at least one of the specified degree names. Supports (*, ?) wildcard characters after the third character in the term as defined in https://developer.textkernel.com/tx-platform/v10/ai-matching/overview/querying/#ai-filtering-special-operators

public List<string> DegreeNames { get; set; }

Property Value

List<string>

DegreeTypes

Results must have at least one of the specified degree types. One of:
specialeducation
someHighSchoolOrEquivalent
ged
secondary
highSchoolOrEquivalent
certification
vocational
someCollege
HND_HNC_OrEquivalent
associates
international
bachelors
somePostgraduate
masters
intermediategraduate
professional
postprofessional
doctorate
postdoctorate

public List<string> DegreeTypes { get; set; }

Property Value

List<string>

DocumentIds

Results must have one of the specified document ids (case-insensitive).

public List<string> DocumentIds { get; set; }

Property Value

List<string>

DocumentLanguages

Results must be written in one of the specified languages. (2-letter ISO 639-1 language codes)

public List<string> DocumentLanguages { get; set; }

Property Value

List<string>

Employers

Results must have at least one of the specified employers. Supports (*, ?) wildcard characters after the third character in the term as defined in https://developer.textkernel.com/tx-platform/v10/ai-matching/overview/querying/#ai-filtering-special-operators

public List<string> Employers { get; set; }

Property Value

List<string>

EmployersMustAllBeCurrentEmployer

When true, at least one employer in Employers must be found in the current time frame.

public bool EmployersMustAllBeCurrentEmployer { get; set; }

Property Value

bool

ExecutiveType

Results must have at least one of the following types of executive experience:
None
Executive
Admin
Accounting
Operations
Financial
Marketing
Business_Dev
IT
General
Learning

public List<string> ExecutiveType { get; set; }

Property Value

List<string>

HasPatents

If true, results must have/require patent experience.

public bool HasPatents { get; set; }

Property Value

bool

HasSecurityCredentials

If true, results must have/require security credentials.

public bool HasSecurityCredentials { get; set; }

Property Value

bool

IsAuthor

If true, results must have/require experience as an author.

public bool IsAuthor { get; set; }

Property Value

bool

IsCurrentStudent

Results must have an education section listed as '- current'.

public bool IsCurrentStudent { get; set; }

Property Value

bool

IsMilitary

If true, results must have/require military experience.

public bool IsMilitary { get; set; }

Property Value

bool

IsPublicSpeaker

If true, results must have/require public speaking experience.

public bool IsPublicSpeaker { get; set; }

Property Value

bool

IsRecentGraduate

Results must have graduated within the last 18 months.

public bool IsRecentGraduate { get; set; }

Property Value

bool

IsTopStudent

Results must have an education with a normalized GPA of .75 or higher (for example, 3.0/4.0 or higher).

public bool IsTopStudent { get; set; }

Property Value

bool

JobPredictiveIndex

Results much have FulltimeDirectHirePredictiveIndex within this range. Only applicable for resumes; setting this when filtering jobs will cause an error.

public IntegerRange JobPredictiveIndex { get; set; }

Property Value

IntegerRange

JobTitles

Results must have at least one of the specified job titles.

public List<JobTitleFilter> JobTitles { get; set; }

Property Value

List<JobTitleFilter>

LanguagesKnown

Results must have/require these language competencies (2-letter ISO 639-1 language codes).
Either all or at least one are required depending on the value of LanguagesKnownMustAllExist

public List<string> LanguagesKnown { get; set; }

Property Value

List<string>

LanguagesKnownMustAllExist

When true, all of the languages in LanguagesKnown must be found. By default, this is false, which means that only one of the LanguagesKnown must be found.

public bool LanguagesKnownMustAllExist { get; set; }

Property Value

bool

LocationCriteria

Use to filter results based on location.

public LocationCriteria LocationCriteria { get; set; }

Property Value

LocationCriteria

MonthsExperience

When specified, total work experience must fall within this range.

public IntegerRange MonthsExperience { get; set; }

Property Value

IntegerRange

MonthsManagementExperience

Results must have management experience within this months range.

public IntegerRange MonthsManagementExperience { get; set; }

Property Value

IntegerRange

RevisionDateRange

When specified, the revision date of documents must fall within this range.

public RevisionDateRange RevisionDateRange { get; set; }

Property Value

RevisionDateRange

SchoolNames

Results must have at least one of the specified school names. Supports (*, ?) wildcard characters after the third character in the term as defined in https://developer.textkernel.com/tx-platform/v10/ai-matching/overview/querying/#ai-filtering-special-operators

public List<string> SchoolNames { get; set; }

Property Value

List<string>

SearchExpression

Full-text boolean semantic expresion. For full details on the syntax and supported operations refer to https://developer.textkernel.com/tx-platform/v10/ai-matching/overview/querying/#ai-filtering-fulltext

public string SearchExpression { get; set; }

Property Value

string

SecurityCredentials

Results must have/require at least one of the security credentials specified. Supports (*, ?) wildcard characters after the third character in the term as defined in https://developer.textkernel.com/tx-platform/v10/ai-matching/overview/querying/#ai-filtering-special-operators

public List<string> SecurityCredentials { get; set; }

Property Value

List<string>

Skills

Results must have/require at least one of the specified skills.

public List<SkillFilter> Skills { get; set; }

Property Value

List<SkillFilter>

SkillsMustAllExist

When true, all of the skills in Skills must be found. By default, this is false, which means that only one of the Skills must be found.

public bool SkillsMustAllExist { get; set; }

Property Value

bool

Taxonomies

Results must contain at least one of the specified best-fit taxonomy IDs or best-fit subtaxonomy IDs.
See TxDefaults

public List<string> Taxonomies { get; set; }

Property Value

List<string>

UserDefinedTags

List of user-defined tags. Either all or at least one are required depending on the value of UserDefinedTagsMustAllExist

public List<string> UserDefinedTags { get; set; }

Property Value

List<string>

UserDefinedTagsMustAllExist

When true, all of the user-defined tags in UserDefinedTags must be found. By default, this is false, which means that at least one of the UserDefinedTags must be found.

public bool UserDefinedTagsMustAllExist { get; set; }

Property Value

bool