com.textkernel.tx.models.api.parsing

Class ParseRequest

java.lang.Object

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

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

com.textkernel.tx.models.api.parsing.ParseRequest

public class ParseRequest
extends ParseOptions

The request body for a Parse request

Field Summary

Fields

Modifier and Type	Field and Description
String	DocumentAsBase64String A Base64 encoded string of the document file bytes.
String	DocumentLastModified Mandatory date - in ISO 8601 (yyyy-MM-dd) format - so that the Parser knows how to interpret dates in the document that are expressed as "current" or "as of" or similar.

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

FlexRequests, GeocodeOptions, HideHtmlImages, IndexingOptions, OutputCandidateImage, OutputHtml, OutputPdf, OutputRtf, UseLLMParser

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

Configuration, NormalizerData, ProfessionsSettings, SkillsData, SkillsSettings

Constructor Summary

Constructors

Constructor and Description
ParseRequest(Document doc, ParseOptions optionsToUse)

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

DocumentAsBase64String

public String DocumentAsBase64String

A Base64 encoded string of the document file bytes. This should use the standard 'base64' encoding as defined in RFC 4648 Section 4 (not the 'base64url' variant).

Java users can use Base64.getEncoder() and then Base64.Encoder.encodeToString(byte[])

DocumentLastModified

public String DocumentLastModified

Mandatory date - in ISO 8601 (yyyy-MM-dd) format - so that the Parser knows how to interpret dates in the document that are expressed as "current" or "as of" or similar. It is crucial that we know the date of the resume/CV so that we can correctly calculate date spans. For example, a resume received on January 5, 2019 should be passed with a DocumentLastModified of "2019-01-05"; if, however, it was modified on May 7, 2019, the DocumentLastModified should be passed as "2019-05-07". Failing to pass a DocumentLastModified, or passing DocumentLastModified that are clearly improbable, may result in rejection of data and/or additional charges, and will utterly decimate the usefulness of AI Matching and any generated metadata.

Constructor Detail

ParseRequest

public ParseRequest(Document doc,
                    ParseOptions optionsToUse)

Parameters:

doc - The document (resume or job) to parse

optionsToUse - Any non-default options to use (null for default)

Throws:

IllegalArgumentException - if the document is null