com.affinda.api.client.models.DocumentCollectionUpdate Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of affinda-api-client Show documentation
This package contains Java Client Library for the Affinda Resume Parser API. For documentation on how to use this package, please see https://github.com/affinda/affinda-java
There is a newer version: 3.16.0
Show newest version
package com.affinda.api.client.models;

import com.azure.core.annotation.Fluent;
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.List;

/** The DocumentCollectionUpdate model. */
@Fluent
public final class DocumentCollectionUpdate {
    /*
     * The name property.
     */
    @JsonProperty(value = "name")
    private String name;

    /*
     * The autoValidationThreshold property.
     */
    @JsonProperty(value = "autoValidationThreshold")
    private Float autoValidationThreshold;

    /*
     * The fields property.
     */
    @JsonProperty(value = "fields")
    private List fields;

    /*
     * The fieldsLayout property.
     */
    @JsonProperty(value = "fieldsLayout")
    private FieldsLayout fieldsLayout;

    /*
     * The dateFormatPreference property.
     */
    @JsonProperty(value = "dateFormatPreference")
    private DateFormatPreference dateFormatPreference;

    /*
     * Predict the date format from any dates in the document that is not
     * ambiguous.
     */
    @JsonProperty(value = "dateFormatFromDocument")
    private Boolean dateFormatFromDocument;

    /*
     * Extra configurations specific to an extractor.
     */
    @JsonProperty(value = "extractorConfig")
    private ExtractorConfig extractorConfig;

    /*
     * Whether to allow OpenAI API to be used to assist in creating a model for
     * this collection.
     */
    @JsonProperty(value = "allowOpenai")
    private Boolean allowOpenai;

    /*
     * Whether this collection feeds documents into the extractor's training
     * queue. This setting can only be toggled for custom extractors.
     */
    @JsonProperty(value = "trainsExtractor")
    private Boolean trainsExtractor;

    /**
     * Get the name property: The name property.
     *
     * @return the name value.
     */
    public String getName() {
        return this.name;
    }

    /**
     * Set the name property: The name property.
     *
     * @param name the name value to set.
     * @return the DocumentCollectionUpdate object itself.
     */
    public DocumentCollectionUpdate setName(String name) {
        this.name = name;
        return this;
    }

    /**
     * Get the autoValidationThreshold property: The autoValidationThreshold property.
     *
     * @return the autoValidationThreshold value.
     */
    public Float getAutoValidationThreshold() {
        return this.autoValidationThreshold;
    }

    /**
     * Set the autoValidationThreshold property: The autoValidationThreshold property.
     *
     * @param autoValidationThreshold the autoValidationThreshold value to set.
     * @return the DocumentCollectionUpdate object itself.
     */
    public DocumentCollectionUpdate setAutoValidationThreshold(Float autoValidationThreshold) {
        this.autoValidationThreshold = autoValidationThreshold;
        return this;
    }

    /**
     * Get the fields property: The fields property.
     *
     * @return the fields value.
     */
    public List getFields() {
        return this.fields;
    }

    /**
     * Set the fields property: The fields property.
     *
     * @param fields the fields value to set.
     * @return the DocumentCollectionUpdate object itself.
     */
    public DocumentCollectionUpdate setFields(List fields) {
        this.fields = fields;
        return this;
    }

    /**
     * Get the fieldsLayout property: The fieldsLayout property.
     *
     * @return the fieldsLayout value.
     */
    public FieldsLayout getFieldsLayout() {
        return this.fieldsLayout;
    }

    /**
     * Set the fieldsLayout property: The fieldsLayout property.
     *
     * @param fieldsLayout the fieldsLayout value to set.
     * @return the DocumentCollectionUpdate object itself.
     */
    public DocumentCollectionUpdate setFieldsLayout(FieldsLayout fieldsLayout) {
        this.fieldsLayout = fieldsLayout;
        return this;
    }

    /**
     * Get the dateFormatPreference property: The dateFormatPreference property.
     *
     * @return the dateFormatPreference value.
     */
    public DateFormatPreference getDateFormatPreference() {
        return this.dateFormatPreference;
    }

    /**
     * Set the dateFormatPreference property: The dateFormatPreference property.
     *
     * @param dateFormatPreference the dateFormatPreference value to set.
     * @return the DocumentCollectionUpdate object itself.
     */
    public DocumentCollectionUpdate setDateFormatPreference(DateFormatPreference dateFormatPreference) {
        this.dateFormatPreference = dateFormatPreference;
        return this;
    }

    /**
     * Get the dateFormatFromDocument property: Predict the date format from any dates in the document that is not
     * ambiguous.
     *
     * @return the dateFormatFromDocument value.
     */
    public Boolean isDateFormatFromDocument() {
        return this.dateFormatFromDocument;
    }

    /**
     * Set the dateFormatFromDocument property: Predict the date format from any dates in the document that is not
     * ambiguous.
     *
     * @param dateFormatFromDocument the dateFormatFromDocument value to set.
     * @return the DocumentCollectionUpdate object itself.
     */
    public DocumentCollectionUpdate setDateFormatFromDocument(Boolean dateFormatFromDocument) {
        this.dateFormatFromDocument = dateFormatFromDocument;
        return this;
    }

    /**
     * Get the extractorConfig property: Extra configurations specific to an extractor.
     *
     * @return the extractorConfig value.
     */
    public ExtractorConfig getExtractorConfig() {
        return this.extractorConfig;
    }

    /**
     * Set the extractorConfig property: Extra configurations specific to an extractor.
     *
     * @param extractorConfig the extractorConfig value to set.
     * @return the DocumentCollectionUpdate object itself.
     */
    public DocumentCollectionUpdate setExtractorConfig(ExtractorConfig extractorConfig) {
        this.extractorConfig = extractorConfig;
        return this;
    }

    /**
     * Get the allowOpenai property: Whether to allow OpenAI API to be used to assist in creating a model for this
     * collection.
     *
     * @return the allowOpenai value.
     */
    public Boolean isAllowOpenai() {
        return this.allowOpenai;
    }

    /**
     * Set the allowOpenai property: Whether to allow OpenAI API to be used to assist in creating a model for this
     * collection.
     *
     * @param allowOpenai the allowOpenai value to set.
     * @return the DocumentCollectionUpdate object itself.
     */
    public DocumentCollectionUpdate setAllowOpenai(Boolean allowOpenai) {
        this.allowOpenai = allowOpenai;
        return this;
    }

    /**
     * Get the trainsExtractor property: Whether this collection feeds documents into the extractor's training queue.
     * This setting can only be toggled for custom extractors.
     *
     * @return the trainsExtractor value.
     */
    public Boolean isTrainsExtractor() {
        return this.trainsExtractor;
    }

    /**
     * Set the trainsExtractor property: Whether this collection feeds documents into the extractor's training queue.
     * This setting can only be toggled for custom extractors.
     *
     * @param trainsExtractor the trainsExtractor value to set.
     * @return the DocumentCollectionUpdate object itself.
     */
    public DocumentCollectionUpdate setTrainsExtractor(Boolean trainsExtractor) {
        this.trainsExtractor = trainsExtractor;
        return this;
    }
}