Table of Contents

Class ParseRequest

Namespace
Textkernel.Tx.Models.API.Parsing
Assembly
Textkernel.Tx.SDK.dll

The request body for a Parse request

public class ParseRequest : ParseOptions
Inheritance
ParseRequest
Inherited Members

Constructors

ParseRequest(Document, ParseOptions)

Create a parse request containing a document to parse and any options/settings

public ParseRequest(Document doc, ParseOptions optionsToUse = null)

Parameters

doc Document

The document (resume or job) to parse

optionsToUse ParseOptions

Any non-default options to use

Properties

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).

.NET users can use the ToBase64String(byte[]) method.

public string DocumentAsBase64String { get; protected set; }

Property Value

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.

public string DocumentLastModified { get; protected set; }

Property Value

string