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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tx-java Show documentation

The official Java SDK for the Textkernel Tx v10 API.

The newest version!

// 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 com.textkernel.tx.models.api.ApiResponseInfo;

/**
* Information about a document conversion
*/
public class ConversionMetadata {
    
    /** The file type that was detected*/
    public String DetectedType;
    
    /** The suggested extension based on the {@link #DetectedType}*/
    public String SuggestedFileExtension;
    
    /** 
     * The computed validity based on the source text. This will indicate whether a document 
     * looks like a legitimate resume/job or not. See https://developer.textkernel.com/tx-platform/v10/resume-parser/overview/document-conversion-code/
    */
    public String OutputValidityCode;
    
    /**
     * How long the document conversion took, in milliseconds.
     * This is a subset of {@link ApiResponseInfo#TotalElapsedMilliseconds}
    */
    public int ElapsedMilliseconds;

    /** The MD5 hash of the document bytes*/
    public String DocumentHash;
}