com.basistech.rosette.apimodel.Label Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rosette-api-model Show documentation

Rosette API data models

There is a newer version: 1.31.0

/*
* Copyright 2017 Basis Technology Corp.
*
* 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 com.basistech.rosette.apimodel;

import com.basistech.rosette.annotations.JacksonMixin;
import lombok.Builder;
import lombok.Value;

/**
 * Sentiment Analysis and Categorization return labels. A label is
 * a category name, a confidence value,
 * that contributed to the determination.
 * For Sentiment, the label strings are items like 'pos' or 'neg';
 * for Categorization, 'sports' or 'news'.
 */
@Value
@Builder
@JacksonMixin
public class Label {

    /**
     * @return the label.
     */
    private final String label;

    /**
     * @return the confidence score  (0.0-1.0)
     */
    private final Double confidence;
}