Skip to content

Commit b4a2c6c

Browse files
committed
docs: remove incorrect default descriptions for max_alternatives and word_confidence
1 parent 2d02c13 commit b4a2c6c

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

lib/recognize-stream.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,9 +98,9 @@ class RecognizeStream extends Duplex {
9898
* @param {Object} [options.headers] - Only works in Node.js, not in browsers. Allows for custom headers to be set, including an Authorization header (preventing the need for auth tokens)
9999
* @param {String} [options.content-type='audio/wav'] - content type of audio; can be automatically determined from file header in most cases. only wav, flac, ogg/opus, and webm are supported
100100
* @param {Boolean} [options.interim_results=true] - Send back non-final previews of each "sentence" as it is being processed. These results are ignored in text mode.
101-
* @param {Boolean} [options.word_confidence=false] - include confidence scores with results. Defaults to true when in objectMode.
101+
* @param {Boolean} [options.word_confidence=false] - include confidence scores with results.
102102
* @param {Boolean} [options.timestamps=false] - include timestamps with results.
103-
* @param {Number} [options.max_alternatives=1] - maximum number of alternative transcriptions to include. Defaults to 3 when in objectMode.
103+
* @param {Number} [options.max_alternatives=1] - maximum number of alternative transcriptions to include.
104104
* @param {Array<String>} [options.keywords] - a list of keywords to search for in the audio
105105
* @param {Number} [options.keywords_threshold] - Number between 0 and 1 representing the minimum confidence before including a keyword in the results. Required when options.keywords is set
106106
* @param {Number} [options.word_alternatives_threshold] - Number between 0 and 1 representing the minimum confidence before including an alternative word in the results. Must be set to enable word alternatives,

0 commit comments

Comments
 (0)