Skip to content

Commit b8acf8b

Browse files
committed
docs(Discovery): Update method comments
1 parent 5280419 commit b8acf8b

File tree

3 files changed

+8
-3
lines changed

3 files changed

+8
-3
lines changed

discovery/src/main/java/com/ibm/watson/developer_cloud/discovery/v1/model/QueryResponse.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,8 @@ public Long getDuplicatesRemoved() {
8383
* The session token for this query. The session token can be used to add events associated with this query to the
8484
* query and event log.
8585
*
86+
* **Important:** Session tokens are case sensitive.
87+
*
8688
* @return the sessionToken
8789
*/
8890
public String getSessionToken() {

discovery/src/main/java/com/ibm/watson/developer_cloud/discovery/v1/model/QueryResultResultMetadata.java

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ public class QueryResultResultMetadata extends GenericModel {
2525
/**
2626
* Gets the score.
2727
*
28-
* The raw score of the result. A higher score indicates a greater match to the query parameters.
28+
* An unbounded measure of the relevance of a particular result, dependent on the query and matching document. A
29+
* higher score indicates a greater match to the query parameters.
2930
*
3031
* @return the score
3132
*/
@@ -36,7 +37,9 @@ public Double getScore() {
3637
/**
3738
* Gets the confidence.
3839
*
39-
* The confidence score of the result's analysis. A higher score indicates greater confidence.
40+
* The confidence score for the given result. Calculated based on how relevant the result is estimated to be, compared
41+
* to a trained relevancy model. confidence can range from `0.0` to `1.0`. The higher the number, the more relevant
42+
* the document.
4043
*
4144
* @return the confidence
4245
*/

discovery/src/main/java/com/ibm/watson/developer_cloud/discovery/v1/model/Timeslice.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ public String getInterval() {
4747
/**
4848
* Gets the anomaly.
4949
*
50-
* Used to inducate that anomaly detection should be performed. Anomaly detection is used to locate unusual datapoints
50+
* Used to indicate that anomaly detection should be performed. Anomaly detection is used to locate unusual datapoints
5151
* within a time series.
5252
*
5353
* @return the anomaly

0 commit comments

Comments
 (0)