Class FilterCriteria
Criteria for filtering search/match results
Inheritance
Inherited Members
Namespace: Textkernel.Tx.Models.API.Matching.Request
Assembly: Textkernel.Tx.SDK.dll
Syntax
public class FilterCriteria
Properties
| Improve this Doc View SourceAverageMonthsPerEmployer
Results much have AverageMonthsPerEmployer within this range. Only applicable for resumes; setting this when filtering jobs will cause an error.
Declaration
public IntegerRange AverageMonthsPerEmployer { get; set; }
Property Value
Type | Description |
---|---|
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
Declaration
public List<string> Certifications { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<System.String> |
CurrentManagementLevel
Results must currently have at least one of the following management levels:
None
Low
Mid
High
Declaration
public string CurrentManagementLevel { get; set; }
Property Value
Type | Description |
---|---|
System.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
Declaration
public List<string> DegreeNames { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<System.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
Declaration
public List<string> DegreeTypes { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<System.String> |
DocumentIds
Results must have one of the specified document ids (case-insensitive).
Declaration
public List<string> DocumentIds { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<System.String> |
DocumentLanguages
Results must be written in one of the specified languages. (2-letter ISO 639-1 language codes)
Declaration
public List<string> DocumentLanguages { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<System.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
Declaration
public List<string> Employers { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<System.String> |
EmployersMustAllBeCurrentEmployer
When true, at least one employer in Employers must be found in the current time frame.
Declaration
public bool EmployersMustAllBeCurrentEmployer { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
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
Declaration
public List<string> ExecutiveType { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<System.String> |
HasPatents
If true, results must have/require patent experience.
Declaration
public bool HasPatents { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
HasSecurityCredentials
If true, results must have/require security credentials.
Declaration
public bool HasSecurityCredentials { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsAuthor
If true, results must have/require experience as an author.
Declaration
public bool IsAuthor { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsCurrentStudent
Results must have an education section listed as '- current'.
Declaration
public bool IsCurrentStudent { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsMilitary
If true, results must have/require military experience.
Declaration
public bool IsMilitary { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsPublicSpeaker
If true, results must have/require public speaking experience.
Declaration
public bool IsPublicSpeaker { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsRecentGraduate
Results must have graduated within the last 18 months.
Declaration
public bool IsRecentGraduate { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsTopStudent
Results must have an education with a normalized GPA of .75 or higher (for example, 3.0/4.0 or higher).
Declaration
public bool IsTopStudent { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
JobPredictiveIndex
Results much have FulltimeDirectHirePredictiveIndex within this range. Only applicable for resumes; setting this when filtering jobs will cause an error.
Declaration
public IntegerRange JobPredictiveIndex { get; set; }
Property Value
Type | Description |
---|---|
IntegerRange |
JobTitles
Results must have at least one of the specified job titles.
Declaration
public List<JobTitleFilter> JobTitles { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.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
Declaration
public List<string> LanguagesKnown { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<System.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.
Declaration
public bool LanguagesKnownMustAllExist { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
LocationCriteria
Use to filter results based on location.
Declaration
public LocationCriteria LocationCriteria { get; set; }
Property Value
Type | Description |
---|---|
LocationCriteria |
MonthsExperience
When specified, total work experience must fall within this range.
Declaration
public IntegerRange MonthsExperience { get; set; }
Property Value
Type | Description |
---|---|
IntegerRange |
MonthsManagementExperience
Results must have management experience within this months range.
Declaration
public IntegerRange MonthsManagementExperience { get; set; }
Property Value
Type | Description |
---|---|
IntegerRange |
RevisionDateRange
When specified, the revision date of documents must fall within this range.
Declaration
public RevisionDateRange RevisionDateRange { get; set; }
Property Value
Type | Description |
---|---|
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
Declaration
public List<string> SchoolNames { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<System.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
Declaration
public string SearchExpression { get; set; }
Property Value
Type | Description |
---|---|
System.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
Declaration
public List<string> SecurityCredentials { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<System.String> |
Skills
Results must have/require at least one of the specified skills.
Declaration
public List<SkillFilter> Skills { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.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.
Declaration
public bool SkillsMustAllExist { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Taxonomies
Results must contain at least one of the specified best-fit taxonomy IDs or best-fit subtaxonomy IDs.
See TxDefaults
Declaration
public List<string> Taxonomies { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<System.String> |
UserDefinedTags
List of user-defined tags. Either all or at least one are required depending on the value of UserDefinedTagsMustAllExist
Declaration
public List<string> UserDefinedTags { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<System.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.
Declaration
public bool UserDefinedTagsMustAllExist { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |