org.nlpcraft.model.NCVariant Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nlpcraft Show documentation

An API to convert natural language into actions.

There is a newer version: 0.8.2

/*
 * “Commons Clause” License, https://commonsclause.com/
 *
 * The Software is provided to you by the Licensor under the License,
 * as defined below, subject to the following condition.
 *
 * Without limiting other conditions in the License, the grant of rights
 * under the License will not include, and the License does not grant to
 * you, the right to Sell the Software.
 *
 * For purposes of the foregoing, “Sell” means practicing any or all of
 * the rights granted to you under the License to provide to third parties,
 * for a fee or other consideration (including without limitation fees for
 * hosting or consulting/support services related to the Software), a
 * product or service whose value derives, entirely or substantially, from
 * the functionality of the Software. Any license notice or attribution
 * required by the License must also include this Commons Clause License
 * Condition notice.
 *
 * Software:    NLPCraft
 * License:     Apache 2.0, https://www.apache.org/licenses/LICENSE-2.0
 * Licensor:    Copyright (C) 2018 DataLingvo, Inc. https://www.datalingvo.com
 *
 *     _   ____      ______           ______
 *    / | / / /___  / ____/________ _/ __/ /_
 *   /  |/ / / __ \/ /   / ___/ __ `/ /_/ __/
 *  / /|  / / /_/ / /___/ /  / /_/ / __/ /_
 * /_/ |_/_/ .___/\____/_/   \__,_/_/  \__/
 *        /_/
 */

package org.nlpcraft.model;

import java.io.Serializable;
import java.util.List;

/**
 * Sentence variant is a list of {@link NCToken tokens}. This class is used throughout the
 * API as a container of tokens. Note that a given user input can have one or more possible different
 * parsing variants (i.e. set of tokens representing that parsed input). Note also that variants support
 * natural ordering from best to worst fitness.
 *
 * @see NCSentence#getVariants()
 */
public interface NCVariant extends Serializable, Comparable {
    /**
     * Gets this variant tokens.
     *
     * @return List of tokens.
     */
    List getTokens();
}