Group
Show / Hide Table of Contents

Class ParsedResume

All of the information extracted while parsing a resume

Inheritance
System.Object
ParsedDocument
ParsedResume
Inherited Members
ParsedDocument.ToString()
ParsedDocument.ToFile(String, Boolean)
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Textkernel.Tx.Models.Resume
Assembly: Textkernel.Tx.SDK.dll
Syntax
public class ParsedResume : ParsedDocument

Constructors

| Improve this Doc View Source

ParsedResume()

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 Source

Achievements

Any achievements listed on the resume

Declaration
public List<string> Achievements { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.String>
| Improve this Doc View Source

Associations

Associations/organizations found on a resume

Declaration
public List<Association> Associations { get; set; }
Property Value
Type Description
System.Collections.Generic.List<Association>
| Improve this Doc View Source

Certifications

Certifications found on a resume.

Declaration
public List<Certification> Certifications { get; set; }
Property Value
Type Description
System.Collections.Generic.List<Certification>
| Improve this Doc View Source

ContactInformation

The candidate's contact information found on the resume

Declaration
public ContactInformation ContactInformation { get; set; }
Property Value
Type Description
ContactInformation
| Improve this Doc View Source

CoverLetter

The cover letter, if present.

Declaration
public string CoverLetter { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Education

The candidate's education history found on the resume

Declaration
public EducationHistory Education { get; set; }
Property Value
Type Description
EducationHistory
| Improve this Doc View Source

EmploymentHistory

The candidate's employment/work history found on the resume

Declaration
public EmploymentHistory EmploymentHistory { get; set; }
Property Value
Type Description
EmploymentHistory
| Improve this Doc View Source

Hobbies

Any hobbies listed on the resume

Declaration
public string Hobbies { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

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>
| Improve this Doc View Source

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>
| Improve this Doc View Source

MilitaryExperience

Any military experience listed on the resume

Declaration
public List<MilitaryDetails> MilitaryExperience { get; set; }
Property Value
Type Description
System.Collections.Generic.List<MilitaryDetails>
| Improve this Doc View Source

Objective

The candidate's written objective

Declaration
public string Objective { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Patents

Any patents listed on the resume

Declaration
public string Patents { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

PersonalAttributes

Personal information provided by the candidate on the resume

Declaration
public PersonalAttributes PersonalAttributes { get; set; }
Property Value
Type Description
PersonalAttributes
| Improve this Doc View Source

ProfessionalSummary

The professional summary from the resume

Declaration
public string ProfessionalSummary { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Publications

Any publications listed on the resume

Declaration
public string Publications { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

QualificationsSummary

A standalone 'skills' section, if listed on the resume

Declaration
public string QualificationsSummary { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

References

References listed on a resume.

Declaration
public List<CandidateReference> References { get; set; }
Property Value
Type Description
System.Collections.Generic.List<CandidateReference>
| Improve this Doc View Source

ResumeMetadata

Metadata about the parsed resume

Declaration
public ResumeMetadata ResumeMetadata { get; set; }
Property Value
Type Description
ResumeMetadata
| Improve this Doc View Source

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>
| Improve this Doc View Source

Skills

Skills output when TaxonomyVersion is set to (or defaults to) "V2".

Declaration
public ResumeV2Skills Skills { get; set; }
Property Value
Type Description
ResumeV2Skills
| Improve this Doc View Source

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>
| Improve this Doc View Source

SpeakingEngagements

Any speaking engagements/appearances listed on the resume

Declaration
public string SpeakingEngagements { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Training

Any training listed on the resume

Declaration
public TrainingHistory Training { get; set; }
Property Value
Type Description
TrainingHistory
| Improve this Doc View Source

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 Source

FromFile(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
| Improve this Doc View Source

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
| Improve this Doc View Source

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
Overrides
ParsedDocument.ToJson(Boolean)
  • Improve this Doc
  • View Source
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾