Skip to content

Commit b3a92d9

Browse files
RD-2360 more doc updates
1 parent c9f20d2 commit b3a92d9

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

model/src/main/java/com/basistech/rosette/apimodel/CategoriesOptions.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public class CategoriesOptions extends Options {
3232

3333
/**
3434
* @deprecated
35-
* users should use {@link singleLabel} to return only one result
35+
* Users should use {@link singleLabel} to return only one result
3636
* or {@link scoreThreshold} to filter results based on raw score
3737
* @return number of categories
3838
*/
@@ -41,6 +41,8 @@ public class CategoriesOptions extends Options {
4141

4242
/**
4343
* Single label mode will return only the highest scoring category
44+
* If singleLabel is false, every category whose score exceeds the default
45+
* (or specified) {@link scoreThreshold} value will be returned
4446
* @return whether or not we are in single label mode
4547
*/
4648
private final Boolean singleLabel;

0 commit comments

Comments
 (0)