Skip to content

Commit b71b3f8

Browse files
committed
docs(Speech to Text): Add generated comment updates
1 parent bb57cc7 commit b71b3f8

File tree

6 files changed

+30
-30
lines changed

6 files changed

+30
-30
lines changed

speech-to-text/src/main/java/com/ibm/watson/developer_cloud/speech_to_text/v1/model/AddAudioOptions.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -312,8 +312,8 @@ public String containedContentType() {
312312
* Gets the allowOverwrite.
313313
*
314314
* If `true`, the specified corpus or audio resource overwrites an existing corpus or audio resource with the same
315-
* name. If `false` (the default), the request fails if a corpus or audio resource with the same name already exists.
316-
* The parameter has no effect if a corpus or audio resource with the same name does not already exist.
315+
* name. If `false`, the request fails if a corpus or audio resource with the same name already exists. The parameter
316+
* has no effect if a corpus or audio resource with the same name does not already exist.
317317
*
318318
* @return the allowOverwrite
319319
*/

speech-to-text/src/main/java/com/ibm/watson/developer_cloud/speech_to_text/v1/model/CreateJobOptions.java

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -685,10 +685,10 @@ public Long inactivityTimeout() {
685685
/**
686686
* Gets the keywords.
687687
*
688-
* An array of keyword strings to spot in the audio. Each keyword string can include one or more tokens. Keywords are
689-
* spotted only in the final results, not in interim hypotheses. If you specify any keywords, you must also specify a
690-
* keywords threshold. You can spot a maximum of 1000 keywords. Omit the parameter or specify an empty array if you do
691-
* not need to spot keywords.
688+
* An array of keyword strings to spot in the audio. Each keyword string can include one or more string tokens.
689+
* Keywords are spotted only in the final results, not in interim hypotheses. If you specify any keywords, you must
690+
* also specify a keywords threshold. You can spot a maximum of 1000 keywords. Omit the parameter or specify an empty
691+
* array if you do not need to spot keywords.
692692
*
693693
* @return the keywords
694694
*/
@@ -700,7 +700,7 @@ public List<String> keywords() {
700700
* Gets the keywordsThreshold.
701701
*
702702
* A confidence value that is the lower bound for spotting a keyword. A word is considered to match a keyword if its
703-
* confidence is greater than or equal to the threshold. Specify a probability between 0 and 1 inclusive. No keyword
703+
* confidence is greater than or equal to the threshold. Specify a probability between 0.0 and 1.0. No keyword
704704
* spotting is performed if you omit the parameter. If you specify a threshold, you must also specify one or more
705705
* keywords.
706706
*
@@ -713,7 +713,8 @@ public Float keywordsThreshold() {
713713
/**
714714
* Gets the maxAlternatives.
715715
*
716-
* The maximum number of alternative transcripts to be returned. By default, a single transcription is returned.
716+
* The maximum number of alternative transcripts that the service is to return. By default, a single transcription is
717+
* returned.
717718
*
718719
* @return the maxAlternatives
719720
*/
@@ -726,8 +727,7 @@ public Long maxAlternatives() {
726727
*
727728
* A confidence value that is the lower bound for identifying a hypothesis as a possible word alternative (also known
728729
* as "Confusion Networks"). An alternative word is considered if its confidence is greater than or equal to the
729-
* threshold. Specify a probability between 0 and 1 inclusive. No alternative words are computed if you omit the
730-
* parameter.
730+
* threshold. Specify a probability between 0.0 and 1.0. No alternative words are computed if you omit the parameter.
731731
*
732732
* @return the wordAlternativesThreshold
733733
*/
@@ -738,8 +738,8 @@ public Float wordAlternativesThreshold() {
738738
/**
739739
* Gets the wordConfidence.
740740
*
741-
* If `true`, a confidence measure in the range of 0 to 1 is returned for each word. By default, no word confidence
742-
* measures are returned.
741+
* If `true`, the service returns a confidence measure in the range of 0.0 to 1.0 for each word. By default, no word
742+
* confidence measures are returned.
743743
*
744744
* @return the wordConfidence
745745
*/
@@ -750,7 +750,7 @@ public Boolean wordConfidence() {
750750
/**
751751
* Gets the timestamps.
752752
*
753-
* If `true`, time alignment is returned for each word. By default, no timestamps are returned.
753+
* If `true`, the service returns time alignment for each word. By default, no timestamps are returned.
754754
*
755755
* @return the timestamps
756756
*/
@@ -761,7 +761,7 @@ public Boolean timestamps() {
761761
/**
762762
* Gets the profanityFilter.
763763
*
764-
* If `true` (the default), filters profanity from all output except for keyword results by replacing inappropriate
764+
* If `true`, the service filters profanity from all output except for keyword results by replacing inappropriate
765765
* words with a series of asterisks. Set the parameter to `false` to return results with no censoring. Applies to US
766766
* English transcription only.
767767
*
@@ -774,10 +774,10 @@ public Boolean profanityFilter() {
774774
/**
775775
* Gets the smartFormatting.
776776
*
777-
* If `true`, converts dates, times, series of digits and numbers, phone numbers, currency values, and internet
778-
* addresses into more readable, conventional representations in the final transcript of a recognition request. For US
779-
* English, also converts certain keyword strings to punctuation symbols. By default, no smart formatting is
780-
* performed. Applies to US English and Spanish transcription only.
777+
* If `true`, the service converts dates, times, series of digits and numbers, phone numbers, currency values, and
778+
* internet addresses into more readable, conventional representations in the final transcript of a recognition
779+
* request. For US English, the service also converts certain keyword strings to punctuation symbols. By default, no
780+
* smart formatting is performed. Applies to US English and Spanish transcription only.
781781
*
782782
* @return the smartFormatting
783783
*/

speech-to-text/src/main/java/com/ibm/watson/developer_cloud/speech_to_text/v1/model/KeywordResult.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ public Double getEndTime() {
6464
/**
6565
* Gets the confidence.
6666
*
67-
* A confidence score for the keyword match in the range of 0 to 1.
67+
* A confidence score for the keyword match in the range of 0.0 to 1.0.
6868
*
6969
* @return the confidence
7070
*/

speech-to-text/src/main/java/com/ibm/watson/developer_cloud/speech_to_text/v1/model/SpeakerLabelsResult.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ public Long getSpeaker() {
6666
/**
6767
* Gets the confidence.
6868
*
69-
* A score that indicates the service's confidence in its identification of the speaker in the range of 0 to 1.
69+
* A score that indicates the service's confidence in its identification of the speaker in the range of 0.0 to 1.0.
7070
*
7171
* @return the confidence
7272
*/

speech-to-text/src/main/java/com/ibm/watson/developer_cloud/speech_to_text/v1/model/SpeechRecognitionAlternative.java

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ public class SpeechRecognitionAlternative extends GenericModel {
2424

2525
private String transcript;
2626
private Double confidence;
27-
private List<SpeechTimestamp> timestamps;
27+
private List<String> timestamps;
2828
@SerializedName("word_confidence")
29-
private List<SpeechWordConfidence> wordConfidence;
29+
private List<String> wordConfidence;
3030

3131
/**
3232
* Gets the transcript.
@@ -42,7 +42,7 @@ public String getTranscript() {
4242
/**
4343
* Gets the confidence.
4444
*
45-
* A score that indicates the service's confidence in the transcript in the range of 0 to 1. Returned only for the
45+
* A score that indicates the service's confidence in the transcript in the range of 0.0 to 1.0. Returned only for the
4646
* best alternative and only with results marked as final.
4747
*
4848
* @return the confidence
@@ -55,25 +55,25 @@ public Double getConfidence() {
5555
* Gets the timestamps.
5656
*
5757
* Time alignments for each word from the transcript as a list of lists. Each inner list consists of three elements:
58-
* the word followed by its start and end time in seconds. Example: `[["hello",0.0,1.2],["world",1.2,2.5]]`. Returned
59-
* only for the best alternative.
58+
* the word followed by its start and end time in seconds, for example: `[["hello",0.0,1.2],["world",1.2,2.5]]`.
59+
* Returned only for the best alternative.
6060
*
6161
* @return the timestamps
6262
*/
63-
public List<SpeechTimestamp> getTimestamps() {
63+
public List<String> getTimestamps() {
6464
return timestamps;
6565
}
6666

6767
/**
6868
* Gets the wordConfidence.
6969
*
7070
* A confidence score for each word of the transcript as a list of lists. Each inner list consists of two elements:
71-
* the word and its confidence score in the range of 0 to 1. Example: `[["hello",0.95],["world",0.866]]`. Returned
72-
* only for the best alternative and only with results marked as final.
71+
* the word and its confidence score in the range of 0.0 to 1.0, for example: `[["hello",0.95],["world",0.866]]`.
72+
* Returned only for the best alternative and only with results marked as final.
7373
*
7474
* @return the wordConfidence
7575
*/
76-
public List<SpeechWordConfidence> getWordConfidence() {
76+
public List<String> getWordConfidence() {
7777
return wordConfidence;
7878
}
7979
}

speech-to-text/src/main/java/com/ibm/watson/developer_cloud/speech_to_text/v1/model/WordAlternativeResult.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ public class WordAlternativeResult extends GenericModel {
2525
/**
2626
* Gets the confidence.
2727
*
28-
* A confidence score for the word alternative hypothesis in the range of 0 to 1.
28+
* A confidence score for the word alternative hypothesis in the range of 0.0 to 1.0.
2929
*
3030
* @return the confidence
3131
*/

0 commit comments

Comments
 (0)