org.nlpcraft.model.NCQueryContext 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 org.nlpcraft.model.intent.NCIntentSolver;
import org.nlpcraft.model.intent.NCIntentSolverContext;

import java.io.Serializable;

/**
 * Model query context. This context defines fully processed user input and its associated data that the model
 * needs to process and return the result in {@link NCModel#query(NCQueryContext)} method.
 * 


 * See {@link NCIntentSolver} for intent base matching utility.
 *
 * @see NCIntentSolver
 * @see NCIntentSolverContext
 */
public interface NCQueryContext extends Serializable {
    /**
     * Gets ID of the current request. Server request is defined as a processing of a one user input
     * sentence (a session).
     *
     * @return Server request ID.
     * @see NCModel#query(NCQueryContext)
     */
    String getServerRequestId();

    /**
     * Gets model instance for this query.
     * .
     * @return Model.
     */
    NCModel getModel();

    /**
     * Gets descriptor of data source associated with this context.
     *
     * @return Descriptor of data source for the user sentence associated with this context.
     */
    NCDataSource getDataSource();

    /**
     * Gets fully parsed, canonical representation of user input.
     *
     * @return Fully parsed, canonical representation of user input.
     */
    NCSentence getSentence();

    /**
     * Gets current conversation context.
     *
     * @return Current conversation context.
     */
    NCConversationContext getConversationContext();
}