Package com.basistech.rosette.apimodel

Class CategoriesOptions.CategoriesOptionsBuilder

java.lang.Object

com.basistech.rosette.apimodel.CategoriesOptions.CategoriesOptionsBuilder

Enclosing class:

CategoriesOptions

public static class CategoriesOptions.CategoriesOptionsBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
CategoriesOptions	build()
CategoriesOptions.CategoriesOptionsBuilder	numCategories(Integer numCategories)	Deprecated. Users should use singleLabel to return only one result or scoreThreshold to filter results based on raw score
CategoriesOptions.CategoriesOptionsBuilder	scoreThreshold(Float scoreThreshold)	threshold against the category's raw score, whose value can be any real number.
CategoriesOptions.CategoriesOptionsBuilder	singleLabel(Boolean singleLabel)	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
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

numCategories

@Deprecated
public CategoriesOptions.CategoriesOptionsBuilder numCategories(Integer numCategories)

Deprecated.

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

Returns:

this.

singleLabel

public CategoriesOptions.CategoriesOptionsBuilder singleLabel(Boolean singleLabel)

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:

this.

scoreThreshold

public CategoriesOptions.CategoriesOptionsBuilder scoreThreshold(Float scoreThreshold)

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

Returns:

this.

build

public CategoriesOptions build()

toString

public String toString()

Overrides:

toString in class Object