com.textkernel.tx.models.api.parsing

Class ParseOptions

java.lang.Object

com.textkernel.tx.models.api.parsing.BasicParseOptions

com.textkernel.tx.models.api.parsing.ParseOptions

Direct Known Subclasses:

ParseRequest

public class ParseOptions
extends BasicParseOptions

Options for parsing

Field Summary

Fields

Modifier and Type	Field and Description
List<FlexRequest>	FlexRequests Only used for resumes.
GeocodeOptions	GeocodeOptions Use this property to also include geocoding in this parse request.
boolean	HideHtmlImages true to remove any images in the converted HTML
IndexSingleDocumentInfo	IndexingOptions If you are using AI Matching, use this property to also index the document after it is parsed/geocoded.
boolean	OutputCandidateImage Only used for resumes.
boolean	OutputHtml true to output the document converted to HTML
boolean	OutputPdf true to output the document converted to PDF
boolean	OutputRtf true to output the document converted to RTF
boolean	UseLLMParser Only used for resumes.

Fields inherited from class com.textkernel.tx.models.api.parsing.BasicParseOptions

Configuration, NormalizerData, ProfessionsSettings, SkillsData, SkillsSettings

Constructor Summary

Constructors

Constructor and Description
ParseOptions()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OutputHtml

public boolean OutputHtml

true to output the document converted to HTML

HideHtmlImages

public boolean HideHtmlImages

true to remove any images in the converted HTML

OutputRtf

public boolean OutputRtf

true to output the document converted to RTF

OutputPdf

public boolean OutputPdf

true to output the document converted to PDF

OutputCandidateImage

public boolean OutputCandidateImage

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

GeocodeOptions

public GeocodeOptions GeocodeOptions

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

IndexingOptions

public IndexSingleDocumentInfo IndexingOptions

If you are using AI Matching, use this property to also index 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.

UseLLMParser

public boolean UseLLMParser

Only used for resumes. When true, and the document is English, the LLM Parser will be used. See the overview documentation for more information. Additional charges will apply.

FlexRequests

public List<FlexRequest> FlexRequests

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

Constructor Detail

ParseOptions

public ParseOptions()