Package com.basistech.rosette.apimodel

Class CategoriesOptions

java.lang.Object

com.basistech.rosette.apimodel.Options

com.basistech.rosette.apimodel.CategoriesOptions

public final class CategoriesOptions
extends Options

Categorization options

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CategoriesOptions.CategoriesOptionsBuilder

Method Summary

Modifier and Type	Method	Description
static CategoriesOptions.CategoriesOptionsBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Integer	getNumCategories()	Deprecated. Users should use singleLabel to return only one result or scoreThreshold to filter results based on raw score
Float	getScoreThreshold()	threshold against the category's raw score, whose value can be any real number.
Boolean	getSingleLabel()	Single label mode will return only the highest scoring category, regardless of score If singleLabel is false, every category whose score exceeds the default (or specified) scoreThreshold value will be returned
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

builder

public static CategoriesOptions.CategoriesOptionsBuilder builder()

getNumCategories

@Deprecated
public Integer getNumCategories()

Deprecated.

Users should use singleLabel to return only one result or scoreThreshold to filter results based on raw score

Returns:

number of categories

getSingleLabel

public Boolean getSingleLabel()

Single label mode will return only the highest scoring category, regardless of score If singleLabel is false, every category whose score exceeds the default (or specified) scoreThreshold value will be returned

Returns:

whether or not we are in single label mode

getScoreThreshold

public Float getScoreThreshold()

threshold against the category's raw score, whose value can be any real number.

Returns:

the score threshold

equals

public boolean equals(Object o)

Overrides:

equals in class Options

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class Options

hashCode

public int hashCode()

Overrides:

hashCode in class Options

toString

public String toString()

Overrides:

toString in class Object