src/main/java/org/apache/nlpcraft/client/NCSuggestion.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.nlpcraft.client;

/**
 * Individual synonym suggestion.
 *
 * @see <a href="https://nlpcraft.apache.org/tools/syn_tool.html">Synonym suggestion tool</a>.
 * @see NCSuggestionData#getSynonyms()
 */
public interface NCSuggestion {
    /**
     * Gets score of the suggested synonym.
     *
     * @return Score of the suggested synonym.
     */
    double getScore();

    /**
     * Gets synonym.
     *
     * @return A synonym.
     */
    String getSynonym();
}