com.textkernel.tx.models.api.parsing.ParseOptions Maven / Gradle / Ivy

Go to download
// Copyright © 2023 Textkernel BV. All rights reserved.
// This file is provided for use by, or on behalf of, Textkernel licensees
// within the terms of their license of Textkernel products or Textkernel customers
// within the Terms of Service pertaining to the Textkernel SaaS products.

package com.textkernel.tx.models.api.parsing;

import java.util.List;

import com.textkernel.tx.models.api.geocoding.GeocodeOptions;
import com.textkernel.tx.models.api.indexes.IndexSingleDocumentInfo;

/** Options for parsing */
public class ParseOptions extends BasicParseOptions {
    
    //********************************
    //IF YOU ADD ANY PARAMS HERE BE SURE TO ADD THEM IN THE DEEP COPY INSIDE ParseRequest.ctor() !!
    //********************************

    /** {@code true} to output the document converted to HTML*/
    public boolean OutputHtml;

    /** {@code true} to remove any images in the converted HTML*/
    public boolean HideHtmlImages;
    
    /** {@code true} to output the document converted to RTF*/
    public boolean OutputRtf;
    
    /** {@code true} to output the document converted to PDF*/
    public boolean OutputPdf;
    
    /** Only used for resumes. {@code true} to extract/output a candidate's image if it is present in the resume.*/
    public boolean OutputCandidateImage;
    
    /**
     * Use this property to also include geocoding in this parse request. The document will be parsed and then geocoded.
    */
    public GeocodeOptions GeocodeOptions;
    
    /**
     * 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.
    */
    public IndexSingleDocumentInfo IndexingOptions;

    /**
     * Only used for resumes. When {@code true}, and the document is English, the LLM Parser will be used. 
     * See the overview documentation for more information.
     * Additional charges will apply.
    */
    public boolean UseLLMParser;

    /**
     * Only used for resumes. Custom requests to ask during parsing. 
     * See the overview documentation for more information.
     * Additional charges will apply.
    */
    public List FlexRequests;

    //********************************
    //IF YOU ADD ANY PARAMS HERE BE SURE TO ADD THEM IN THE DEEP COPY INSIDE ParseRequest.ctor() !!
    //********************************
}