Class ParseOptions

Options for parsing

Inheritance
System.Object
BasicParseOptions
ParseOptions
ParseRequest
Inherited Members
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)
System.Object.ToString()
Namespace: Textkernel.Tx.Models.API.Parsing
Assembly: Textkernel.Tx.SDK.dll
Syntax
public class ParseOptions : BasicParseOptions

Properties

| Improve this Doc View Source

FlexRequests

Only used for resumes. Custom requests to ask during parsing. See the overview documentation for more details. Additional charges will apply.

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

GeocodeOptions

Use this property to also include geocoding in this parse request. The document will be parsed and then geocoded.

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

IndexingOptions

If you are using Search & Match, use this property to also index/upload the document after it is parsed/geocoded. This means you only need to send the document to our API once instead of twice for parsing+indexing.

Declaration
public IndexingOptionsGeneric IndexingOptions { get; set; }
Property Value
Type Description
IndexingOptionsGeneric
Remarks

NOTE: if you set this while parsing, you should try/catch for TxUsableResumeException or TxUsableJobException that are thrown when parsing was successful but an error occured during indexing

| Improve this Doc View Source

OutputCandidateImage

Only used for resumes. true to extract/output a candidate's image if it is present in the resume.

Declaration
public bool OutputCandidateImage { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

OutputHtml

true to output the document converted to HTML

Declaration
public bool OutputHtml { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

OutputPdf

true to output the document converted to PDF

Declaration
public bool OutputPdf { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

OutputRtf

true to output the document converted to RTF

Declaration
public bool OutputRtf { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

UseLLMParser

Only used for resumes. When true, and the document is English, the LLM Parser will be used. See https://developer.textkernel.com/tx-platform/v10/resume-parser/overview/llm-parser/#overview for more information. Additional charges will apply.

Declaration
public bool UseLLMParser { get; set; }
Property Value
Type Description
System.Boolean