Class ParsedJob
All of the information extracted while parsing a job
Inherited Members
Namespace: Textkernel.Tx.Models.Job
Assembly: Textkernel.Tx.SDK.dll
Syntax
public class ParsedJob : ParsedDocument
Constructors
| Improve this Doc View SourceParsedJob()
You should never create one of these. Instead, these are output by the Job Parser.
The API does not support manually created jobs to be used in the AI Matching engine.
To create a job from a json string, use FromJson(String) or FromFile(String)
Declaration
[Obsolete("You should never create one of these. Instead, these are output by the Job Parser")]
public ParsedJob()
Properties
| Improve this Doc View SourceApplicationDetails
Information about the application process.
Declaration
public ApplicationDetails ApplicationDetails { get; set; }
Property Value
Type | Description |
---|---|
ApplicationDetails |
Benefits
Full text of any benefits listed by the job.
Declaration
public string Benefits { get; set; }
Property Value
Type | Description |
---|---|
System.String |
CertificationsAndLicenses
Any certifications/licenses listed in the job. Used for AI Matching
Declaration
public List<string> CertificationsAndLicenses { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<System.String> |
ContractType
The contract type. One of:
unspecified
permanent
temporary
possibly_permanent
interim
franchise
side
internship
voluntary
freelance
apprenticeship
assisted
Declaration
public string ContractType { get; set; }
Property Value
Type | Description |
---|---|
System.String |
CurrentJobIsManagement
Whether or not the job is a management position. Used for AI Matching
Declaration
public bool CurrentJobIsManagement { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
CurrentLocation
The location of the job, if listed. If no job location is found, this is the location of the company, if listed.
Declaration
public Location CurrentLocation { get; set; }
Property Value
Type | Description |
---|---|
Location |
Degrees
The educational degrees found listed in the job. Used for AI Matching
Declaration
public List<JobDegree> Degrees { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<JobDegree> |
DriversLicenses
Any drivers license requirements
Declaration
public List<string> DriversLicenses { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<System.String> |
EmployerDescription
Full text of any employer description listed by the job.
Declaration
public string EmployerDescription { get; set; }
Property Value
Type | Description |
---|---|
System.String |
EmployerNames
The employer names found in the job.
Declaration
public EmployerNames EmployerNames { get; set; }
Property Value
Type | Description |
---|---|
EmployerNames |
EmploymentType
The type of employment. One of:
unspecified
fulltime
parttime
fulltime/parttime
Declaration
public string EmploymentType { get; set; }
Property Value
Type | Description |
---|---|
System.String |
EndDate
The end date for the job, if listed.
Declaration
public TxPrimitive<DateTime> EndDate { get; set; }
Property Value
Type | Description |
---|---|
TxPrimitive<System.DateTime> |
ExecutiveType
What kind of executive position the job is, if any. Used for AI Matching
Declaration
public string ExecutiveType { get; set; }
Property Value
Type | Description |
---|---|
System.String |
HighestManagementScore
The management score. Used for AI Matching
Declaration
public TxPrimitive<int> HighestManagementScore { get; set; }
Property Value
Type | Description |
---|---|
TxPrimitive<System.Int32> |
IsRemote
Whether or not the position is remote. Includes fulltime, partial and temporary remote working opportunities.
Declaration
public bool IsRemote { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
JobDescription
Section containing information about the job. Job description strictly includes duties, tasks, and responsibilities for the role with as little irrelevant text as possible.
Declaration
public string JobDescription { get; set; }
Property Value
Type | Description |
---|---|
System.String |
JobMetadata
Metadata about the parsed job
Declaration
public JobMetadata JobMetadata { get; set; }
Property Value
Type | Description |
---|---|
JobMetadata |
JobRequirements
Full text of any requirements listed by the job.
Declaration
public string JobRequirements { get; set; }
Property Value
Type | Description |
---|---|
System.String |
JobTitles
The job titles found in the job. Used for AI Matching
Declaration
public JobTitles JobTitles { get; set; }
Property Value
Type | Description |
---|---|
JobTitles |
LanguageCodes
Any languages listed in the job. Used for AI Matching
Declaration
public List<string> LanguageCodes { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<System.String> |
ManagementLevel
The management level. Used for AI Matching
Declaration
public string ManagementLevel { get; set; }
Property Value
Type | Description |
---|---|
System.String |
MaximumWorkingHours
The maximum number of working hours per week
Declaration
public TxPrimitive<int> MaximumWorkingHours { get; set; }
Property Value
Type | Description |
---|---|
TxPrimitive<System.Int32> |
MaximumYears
The maximum years experience for the job, if listed. Used for AI Matching
Declaration
public TxPrimitive<int> MaximumYears { get; set; }
Property Value
Type | Description |
---|---|
TxPrimitive<System.Int32> |
MaximumYearsManagement
The maximum years of management experience, if listed. Used for AI Matching
Declaration
public TxPrimitive<int> MaximumYearsManagement { get; set; }
Property Value
Type | Description |
---|---|
TxPrimitive<System.Int32> |
MinimumWorkingHours
The minimum number of working hours per week
Declaration
public TxPrimitive<int> MinimumWorkingHours { get; set; }
Property Value
Type | Description |
---|---|
TxPrimitive<System.Int32> |
MinimumYears
The minimum years experience for the job, if listed. Used for AI Matching
Declaration
public TxPrimitive<int> MinimumYears { get; set; }
Property Value
Type | Description |
---|---|
TxPrimitive<System.Int32> |
MinimumYearsManagement
The minimum years of management experience, if listed. Used for AI Matching
Declaration
public TxPrimitive<int> MinimumYearsManagement { get; set; }
Property Value
Type | Description |
---|---|
TxPrimitive<System.Int32> |
Owners
Any owners of the job posting, if listed.
Declaration
public List<string> Owners { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<System.String> |
RequiredDegree
The required educational degree, if listed. Used for AI Matching
Declaration
public string RequiredDegree { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Salary
The salary found for the position
Declaration
public PayRange Salary { get; set; }
Property Value
Type | Description |
---|---|
PayRange |
SchoolNames
Any school names listed in the job
Declaration
public List<string> SchoolNames { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<System.String> |
Skills
Skills output when TaxonomyVersion is set to (or defaults to) "V2".
Declaration
public JobV2Skills Skills { get; set; }
Property Value
Type | Description |
---|---|
JobV2Skills |
SkillsData
The skills found in the job when TaxonomyVersion is set to (or defaults to) "V1".
Declaration
[Obsolete("You should use the V2 skills taxonomy instead.")]
public List<JobTaxonomyRoot> SkillsData { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<JobTaxonomyRoot> |
StartDate
The start date of the job.
Declaration
public TxPrimitive<DateTime> StartDate { get; set; }
Property Value
Type | Description |
---|---|
TxPrimitive<System.DateTime> |
TermsOfInterest
Terms of interest listed in the job
Declaration
public List<string> TermsOfInterest { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<System.String> |
UserDefinedTags
A list of user-defined tags
that are assigned to this job. These are used to filter search/match queries in the AI Matching Engine.
NOTE: you may add/remove these prior to indexing. This is the only property you may modify prior to indexing.
Declaration
public List<string> UserDefinedTags { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<System.String> |
WorkingHours
The type of working hours. One of:
regular
irregular
Declaration
public string WorkingHours { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Methods
| Improve this Doc View SourceFromFile(String)
Load a parsed job from a json file using UTF-8 encoding. This is useful when you have stored parse results to disk for use later.
Declaration
public static ParsedJob FromFile(string path)
Parameters
Type | Name | Description |
---|---|---|
System.String | path | The full path to the json file |
Returns
Type | Description |
---|---|
ParsedJob |
FromJson(String)
Create a parsed job from json. This is useful when you have stored parse results to disk for use later.
Declaration
public static ParsedJob FromJson(string utf8json)
Parameters
Type | Name | Description |
---|---|---|
System.String | utf8json | The UTF-8 encoded json string |
Returns
Type | Description |
---|---|
ParsedJob |
ToJson(Boolean)
Outputs a JSON string that can be saved to disk or any other data storage.
NOTE: be sure to save with UTF-8 encoding!
Declaration
public override string ToJson(bool formatted)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | formatted | true for pretty-printing |
Returns
Type | Description |
---|---|
System.String |