/*
 * Copyright (c) 2015-2020, Oracle and/or its affiliates. All rights reserved.
 *
 * 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 implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.tribuo.data.text;

import com.oracle.labs.mlrg.olcut.config.Configurable;
import com.oracle.labs.mlrg.olcut.provenance.ConfiguredObjectProvenance;
import com.oracle.labs.mlrg.olcut.provenance.Provenancable;
import org.tribuo.Feature;

import java.util.List;

/**
 * A TextProcessor takes some text and optionally a feature tag and generates a list of {@link Feature}s from that text.
 */
public interface TextProcessor extends Configurable, Provenancable<ConfiguredObjectProvenance> {

    /**
     * Extracts features from the supplied text.
     * @param text The text to extract.
     * @return The extracted features.
     * @throws TextProcessingException If an error occurred during extraction (usually from tokenization).
     */
    public List<Feature> process(String text) throws TextProcessingException;

    /**
     * Extracts features from the supplied text.
     * @param tag The feature name tag.
     * @param text The text to extract.
     * @return The extracted features.
     * @throws TextProcessingException If an error occurred during extraction (usually from tokenization).
     */
    public List<Feature> process(String tag, String text) throws TextProcessingException;

}
