Class ParsedResume
All of the information extracted while parsing a resume
Inherited Members
Namespace: Textkernel.Tx.Models.Resume
Assembly: Textkernel.Tx.SDK.dll
Syntax
public class ParsedResume : ParsedDocument
Constructors
| Improve this Doc View SourceParsedResume()
You should never create one of these. Instead, these are output by the Resume Parser.
The API does not support manually-created resumes to be used in the AI Matching engine.
To create a resume 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 Resume Parser")]
public ParsedResume()
Properties
| Improve this Doc View SourceAchievements
Any achievements listed on the resume
Declaration
public List<string> Achievements { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<System.String> |
Associations
Associations/organizations found on a resume
Declaration
public List<Association> Associations { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<Association> |
Certifications
Certifications found on a resume.
Declaration
public List<Certification> Certifications { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<Certification> |
ContactInformation
The candidate's contact information found on the resume
Declaration
public ContactInformation ContactInformation { get; set; }
Property Value
Type | Description |
---|---|
ContactInformation |
CoverLetter
The cover letter, if present.
Declaration
public string CoverLetter { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Education
The candidate's education history found on the resume
Declaration
public EducationHistory Education { get; set; }
Property Value
Type | Description |
---|---|
EducationHistory |
EmploymentHistory
The candidate's employment/work history found on the resume
Declaration
public EmploymentHistory EmploymentHistory { get; set; }
Property Value
Type | Description |
---|---|
EmploymentHistory |
Hobbies
Any hobbies listed on the resume
Declaration
public string Hobbies { get; set; }
Property Value
Type | Description |
---|---|
System.String |
LanguageCompetencies
Any language competencies (fluent in, can read, can write, etc) found in the resume.
Declaration
public List<LanguageCompetency> LanguageCompetencies { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<LanguageCompetency> |
Licenses
Licenses found on a resume. These are professional licenses, not driving licenses. For driving licenses, see DrivingLicense
Declaration
public List<LicenseDetails> Licenses { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<LicenseDetails> |
MilitaryExperience
Any military experience listed on the resume
Declaration
public List<MilitaryDetails> MilitaryExperience { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<MilitaryDetails> |
Objective
The candidate's written objective
Declaration
public string Objective { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Patents
Any patents listed on the resume
Declaration
public string Patents { get; set; }
Property Value
Type | Description |
---|---|
System.String |
PersonalAttributes
Personal information provided by the candidate on the resume
Declaration
public PersonalAttributes PersonalAttributes { get; set; }
Property Value
Type | Description |
---|---|
PersonalAttributes |
ProfessionalSummary
The professional summary from the resume
Declaration
public string ProfessionalSummary { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Publications
Any publications listed on the resume
Declaration
public string Publications { get; set; }
Property Value
Type | Description |
---|---|
System.String |
QualificationsSummary
A standalone 'skills' section, if listed on the resume
Declaration
public string QualificationsSummary { get; set; }
Property Value
Type | Description |
---|---|
System.String |
References
References listed on a resume.
Declaration
public List<CandidateReference> References { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<CandidateReference> |
ResumeMetadata
Metadata about the parsed resume
Declaration
public ResumeMetadata ResumeMetadata { get; set; }
Property Value
Type | Description |
---|---|
ResumeMetadata |
SecurityCredentials
Any security credentials/clearances listed on the resume
Declaration
public List<SecurityCredential> SecurityCredentials { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<SecurityCredential> |
Skills
Skills output when TaxonomyVersion is set to (or defaults to) "V2".
Declaration
public ResumeV2Skills Skills { get; set; }
Property Value
Type | Description |
---|---|
ResumeV2Skills |
SkillsData
All the skills found in the resume when TaxonomyVersion is set to (or defaults to) "V1".
Declaration
[Obsolete("You should use the V2 skills taxonomy instead.")]
public List<ResumeTaxonomyRoot> SkillsData { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<ResumeTaxonomyRoot> |
SpeakingEngagements
Any speaking engagements/appearances listed on the resume
Declaration
public string SpeakingEngagements { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Training
Any training listed on the resume
Declaration
public TrainingHistory Training { get; set; }
Property Value
Type | Description |
---|---|
TrainingHistory |
UserDefinedTags
A list of user-defined tags
that are assigned to this resume. 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> |
Methods
| Improve this Doc View SourceFromFile(String)
Load a parsed resume 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 ParsedResume FromFile(string path)
Parameters
Type | Name | Description |
---|---|---|
System.String | path | The full path to the json file |
Returns
Type | Description |
---|---|
ParsedResume |
FromJson(String)
Create a parsed resume from json. This is useful when you have stored parse results to disk for use later.
Declaration
public static ParsedResume FromJson(string utf8json)
Parameters
Type | Name | Description |
---|---|---|
System.String | utf8json | The UTF-8 encoded json string |
Returns
Type | Description |
---|---|
ParsedResume |
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 |