Skip to content

Commit c039719

Browse files
committed
chore: rename TEXT metrics to correspond to Python
1 parent 3dbe975 commit c039719

1 file changed

Lines changed: 14 additions & 4 deletions

File tree

src/main/java/io/weaviate/client6/v1/api/collections/aggregate/TextAggregation.java

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,21 +35,31 @@ public Builder(String property) {
3535
super(property);
3636
}
3737

38-
public final Builder count() {
38+
/**
39+
* Include the number of occurrences (frequency count) for each top most
40+
* occuring value in the results.
41+
*/
42+
public final Builder topOccurrencesCount() {
3943
return addMetric(WeaviateProtoAggregate.AggregateRequest.Aggregation.Text.Builder::setCount);
4044
}
4145

4246
public Builder type() {
4347
return addMetric(WeaviateProtoAggregate.AggregateRequest.Aggregation.Text.Builder::setType);
4448
}
4549

46-
public Builder topOccurences() {
50+
/**
51+
* Include the value of the top occurrences in the aggregation results.
52+
*/
53+
public Builder topOccurrencesValue() {
4754
return addMetric(WeaviateProtoAggregate.AggregateRequest.Aggregation.Text.Builder::setTopOccurences);
4855
}
4956

50-
public Builder topOccurencesCutoff(int cutoff) {
57+
/**
58+
* Set a <i>minimum</i> cutoff point after which groups should be discarded.
59+
*/
60+
public Builder minOccurrences(int cutoff) {
5161
this.topOccurrencesCutoff = cutoff;
52-
return topOccurences();
62+
return topOccurrencesCount();
5363
}
5464

5565
@Override

0 commit comments

Comments
 (0)