Skip to content

Commit

Permalink
docs: update jsdoc comments (#395)
Browse files Browse the repository at this point in the history
  • Loading branch information
yoshi-automation authored and JustinBeckwith committed Jun 27, 2019
1 parent 5acfad9 commit c2e2f8a
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 41 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -315,19 +315,12 @@ message RecognitionConfig {

// *Optional* Set to true to use an enhanced model for speech recognition.
// If `use_enhanced` is set to true and the `model` field is not set, then
// an appropriate enhanced model is chosen if:
// 1. project is eligible for requesting enhanced models
// 2. an enhanced model exists for the audio
// an appropriate enhanced model is chosen if an enhanced model exists for
// the audio.
//
// If `use_enhanced` is true and an enhanced version of the specified model
// does not exist, then the speech is recognized using the standard version
// of the specified model.
//
// Enhanced speech models require that you opt-in to data logging using
// instructions in the
// [documentation](/speech-to-text/docs/enable-data-logging). If you set
// `use_enhanced` to true and you have not enabled audio logging, then you
// will receive an error.
bool use_enhanced = 14;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -359,19 +359,12 @@ message RecognitionConfig {

// *Optional* Set to true to use an enhanced model for speech recognition.
// If `use_enhanced` is set to true and the `model` field is not set, then
// an appropriate enhanced model is chosen if:
// 1. project is eligible for requesting enhanced models
// 2. an enhanced model exists for the audio
// an appropriate enhanced model is chosen if an enhanced model exists for
// the audio.
//
// If `use_enhanced` is true and an enhanced version of the specified model
// does not exist, then the speech is recognized using the standard version
// of the specified model.
//
// Enhanced speech models require that you opt-in to data logging using
// instructions in the
// [documentation](/speech-to-text/docs/enable-data-logging). If you set
// `use_enhanced` to true and you have not enabled audio logging, then you
// will receive an error.
bool use_enhanced = 14;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -255,20 +255,13 @@ const StreamingRecognitionConfig = {
* @property {boolean} useEnhanced
* *Optional* Set to true to use an enhanced model for speech recognition.
* If `use_enhanced` is set to true and the `model` field is not set, then
* an appropriate enhanced model is chosen if:
* 1. project is eligible for requesting enhanced models
* 2. an enhanced model exists for the audio
* an appropriate enhanced model is chosen if an enhanced model exists for
* the audio.
*
* If `use_enhanced` is true and an enhanced version of the specified model
* does not exist, then the speech is recognized using the standard version
* of the specified model.
*
* Enhanced speech models require that you opt-in to data logging using
* instructions in the
* [documentation](https://cloud.google.com/speech-to-text/docs/enable-data-logging). If you set
* `use_enhanced` to true and you have not enabled audio logging, then you
* will receive an error.
*
* @typedef RecognitionConfig
* @memberof google.cloud.speech.v1
* @see [google.cloud.speech.v1.RecognitionConfig definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/speech/v1/cloud_speech.proto}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -292,20 +292,13 @@ const StreamingRecognitionConfig = {
* @property {boolean} useEnhanced
* *Optional* Set to true to use an enhanced model for speech recognition.
* If `use_enhanced` is set to true and the `model` field is not set, then
* an appropriate enhanced model is chosen if:
* 1. project is eligible for requesting enhanced models
* 2. an enhanced model exists for the audio
* an appropriate enhanced model is chosen if an enhanced model exists for
* the audio.
*
* If `use_enhanced` is true and an enhanced version of the specified model
* does not exist, then the speech is recognized using the standard version
* of the specified model.
*
* Enhanced speech models require that you opt-in to data logging using
* instructions in the
* [documentation](https://cloud.google.com/speech-to-text/docs/enable-data-logging). If you set
* `use_enhanced` to true and you have not enabled audio logging, then you
* will receive an error.
*
* @typedef RecognitionConfig
* @memberof google.cloud.speech.v1p1beta1
* @see [google.cloud.speech.v1p1beta1.RecognitionConfig definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/speech/v1p1beta1/cloud_speech.proto}
Expand Down
10 changes: 5 additions & 5 deletions packages/google-cloud-node/synth.metadata
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
{
"updateTime": "2019-06-18T01:04:56.951203Z",
"updateTime": "2019-06-27T11:25:50.951785Z",
"sources": [
{
"generator": {
"name": "artman",
"version": "0.26.0",
"dockerImage": "googleapis/artman@sha256:6db0735b0d3beec5b887153a2a7c7411fc7bb53f73f6f389a822096bd14a3a15"
"version": "0.29.1",
"dockerImage": "googleapis/artman@sha256:b2a73f4dda03ef8fcaa973e3ba26d0cf34091f6c22c70add663af325931aef4d"
}
},
{
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "384aa843867c4d17756d14a01f047b6368494d32",
"internalRef": "253675319"
"sha": "f46206aff84f4b2cde590f1e0791112214f07080",
"internalRef": "255318896"
}
},
{
Expand Down

0 comments on commit c2e2f8a

Please sign in to comment.