com.textkernel.tx.models.api.formatter

Class FormatResumeRequest

java.lang.Object

com.textkernel.tx.models.api.formatter.FormatResumeRequest

public class FormatResumeRequest
extends Object

Request body for the Format Resume With Template endpoint

Field Summary

Fields

Modifier and Type	Field and Description
Object	CustomData Any data that the template needs that is not in the extracted CV data.
OutputDocumentFormat	OutputType The output document type
ParsedResume	ResumeData The resume to use to populate the template
String	Template A base64-encoded string of the DOCX template document file bytes.

Constructor Summary

Constructors

Constructor and Description
FormatResumeRequest(ParsedResume resume, byte[] templateFileBytes, OutputDocumentFormat docType) Creates a request to use when calling the Resume Formatter endpoint with a provided template document.
FormatResumeRequest(ParsedResume resume, String templatePath, OutputDocumentFormat docType) Creates a request to use when calling the Resume Formatter endpoint with a provided template document.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

ResumeData

public ParsedResume ResumeData

The resume to use to populate the template

Template

public String Template

A base64-encoded string of the DOCX template 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.Encoder.encodeToString(byte[])

For more information on creating custom templates, see here

OutputType

public OutputDocumentFormat OutputType

The output document type

CustomData

public Object CustomData

Any data that the template needs that is not in the extracted CV data. For example:

JSONObject myCustomData = new JSONObject();
myCustomData.put("CandidateId", "12345");
myCustomData.put("DateApplied", LocalDate.now());
formatRequest.CustomData = myCustomData;

Constructor Detail

FormatResumeRequest

public FormatResumeRequest(ParsedResume resume,
                           String templatePath,
                           OutputDocumentFormat docType)
                    throws IOException

Creates a request to use when calling the Resume Formatter endpoint with a provided template document.

Parameters:

resume - The resume to use to populate the template

templatePath - The path to the template DOCX file on disk

docType - The output document type

Throws:

IOException - if an error occurs reading the file contents

FormatResumeRequest

public FormatResumeRequest(ParsedResume resume,
                           byte[] templateFileBytes,
                           OutputDocumentFormat docType)

Creates a request to use when calling the Resume Formatter endpoint with a provided template document.

Parameters:

resume - The resume to use to populate the template

templateFileBytes - The bytes of the template DOCX file

docType - The output document type