com.basistech.rosette.apimodel

Class Label

java.lang.Object

com.basistech.rosette.apimodel.Label

public final class Label
extends Object

Sentiment Analysis and Categorization return labels. A label is a category name, a confidence value, and some 'explanation' tokens that contributed to the determination. For Sentiment, the label strings are items like 'pos' or 'neg'; for Categorization, 'sports' or 'news'.

Constructor Summary

Constructors

Constructor and Description
Label(String label, Double confidence, List<String> explanations) Constructor for Category

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) if the param is a Category, compare contents for equality
Double	getConfidence()
List<String>	getExplanations() get the list of explanation strings contributing to this label.
String	getLabel()
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Label

public Label(String label,
             Double confidence,
             List<String> explanations)

Constructor for Category

Parameters:

label - label for contextual category

confidence - confidence score (0.0-1.0)

explanations - list of input text elements

Method Detail

getLabel

public String getLabel()

Returns:

the label.

getConfidence

public Double getConfidence()

Returns:

the confidence score (0.0-1.0)

getExplanations

public List<String> getExplanations()

get the list of explanation strings contributing to this label.

Returns:

the list of strings.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

if the param is a Category, compare contents for equality

Overrides:

equals in class Object

Parameters:

o - the object

Returns:

whether or not the param object is equal to this object