eu.trentorise.opendata.semantics.services.INLPService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openentity-api Show documentation
Api to access semantic services of open data in trentino project
The newest version!
/* 
 * Copyright 2013-2015   Trento Rise   trentorise.eu
 *
 * Licensed 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 eu.trentorise.opendata.semantics.services;

import eu.trentorise.opendata.semantics.model.knowledge.IResourceContext;
import eu.trentorise.opendata.semantics.model.knowledge.ISemanticText;
import eu.trentorise.opendata.semantics.model.knowledge.ITableResource;
import eu.trentorise.opendata.semantics.services.model.IWordSearchResult;
import java.util.List;
import java.util.Locale;
import javax.annotation.Nullable;

/**
 * The NLP interface provides natural language processing services such as named
 * entity recognition and word sense disambiguation
 *
 * @author Juan Pane 
 * @author Moaz Reyad 
 * @author David Leoni 
 * @date Oct 08, 2014
 */
public interface INLPService {

    /**
     * Disambiguates the column header names of a resource that typically comes
     * from a catalog.
     *
     * @param table the content of the resource
     * @param context the metadata of the resource, typically found in the
     * catalog
     * @return the column names enriched with the meaning, ranked by confidence
     */
    List disambiguateColumns(ITableResource table, IResourceContext context);

    /**
     * Guesses the datatype common to a list of strings passed as input. Todo
     * for now types are expressed as String, maybe we can do an enum
     *
     * @return the guessed type
     * @param cellList a list of strings
     */
    String guessType(List cellList);

    /**
     * Takes natural language strings and assigns to each string candidate
     * concept or entity meanings according to the domainURL. If a concept domain
     * is provided, all the candidate meanings will be concepts descending from
     * the provided concept. If an entity type domain is provided, all the candidate
     * meanings will be entities having as ancestor type the provided etype.
     *
     * @param texts an input natural language string
     * @param domainURL Either null, an entity type URL or a concept URL. 
     * @return the list of enriched strings, one for each of the provided texts.
     * Each enriched string will be a semantic text of only one word.
     */
    List runNLP(List texts, @Nullable String domainURL);

    /** 
     * Searches for concepts or entities 
     * 
     * @param partialName a partial entity or concept name. It is assumed to be in the provided locale.
     * @return a list of candidate entities and/or concepts, ordered by probability. The first one is the most probable.
     */
    List freeSearch(String partialName, Locale locale);          
}