| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_131-google-v7) on Thu Apr 19 15:01:45 PDT 2018 --> |
| <title>RecognitionConfigOrBuilder (java API)</title> |
| <meta name="date" content="2018-04-19"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="RecognitionConfigOrBuilder (java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfig.Builder.html" title="class in com.google.cloud.speech.v1p1beta1"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionMetadata.html" title="class in com.google.cloud.speech.v1p1beta1"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html" target="_top">Frames</a></li> |
| <li><a href="RecognitionConfigOrBuilder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">com.google.cloud.speech.v1p1beta1</div> |
| <h2 title="Interface RecognitionConfigOrBuilder" class="title">Interface RecognitionConfigOrBuilder</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageLiteOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageLiteOrBuilder</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageOrBuilder</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfig.html" title="class in com.google.cloud.speech.v1p1beta1">RecognitionConfig</a>, <a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfig.Builder.html" title="class in com.google.cloud.speech.v1p1beta1">RecognitionConfig.Builder</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">RecognitionConfigOrBuilder</span> |
| extends <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageOrBuilder</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html#getEnableAutomaticPunctuation--">getEnableAutomaticPunctuation</a></span>()</code> |
| <div class="block"> |
| *Optional* If 'true', adds punctuation to recognition result hypotheses.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html#getEnableWordTimeOffsets--">getEnableWordTimeOffsets</a></span>()</code> |
| <div class="block"> |
| *Optional* If `true`, the top result includes a list of words and |
| the start and end time offsets (timestamps) for those words.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfig.AudioEncoding.html" title="enum in com.google.cloud.speech.v1p1beta1">RecognitionConfig.AudioEncoding</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html#getEncoding--">getEncoding</a></span>()</code> |
| <div class="block"> |
| Encoding of audio data sent in all `RecognitionAudio` messages.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html#getEncodingValue--">getEncodingValue</a></span>()</code> |
| <div class="block"> |
| Encoding of audio data sent in all `RecognitionAudio` messages.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../com/google/cloud/speech/v1p1beta1/GoogleDataCollectionConfig.html" title="class in com.google.cloud.speech.v1p1beta1">GoogleDataCollectionConfig</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html#getGoogleDataCollectionOptIn--">getGoogleDataCollectionOptIn</a></span>()</code> |
| <div class="block"> |
| *Optional* Contains settings to opt-in to allow Google to |
| collect and use data from this request to improve Google's products and |
| services.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../com/google/cloud/speech/v1p1beta1/GoogleDataCollectionConfigOrBuilder.html" title="interface in com.google.cloud.speech.v1p1beta1">GoogleDataCollectionConfigOrBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html#getGoogleDataCollectionOptInOrBuilder--">getGoogleDataCollectionOptInOrBuilder</a></span>()</code> |
| <div class="block"> |
| *Optional* Contains settings to opt-in to allow Google to |
| collect and use data from this request to improve Google's products and |
| services.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html#getLanguageCode--">getLanguageCode</a></span>()</code> |
| <div class="block"> |
| *Required* The language of the supplied audio as a |
| [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html#getLanguageCodeBytes--">getLanguageCodeBytes</a></span>()</code> |
| <div class="block"> |
| *Required* The language of the supplied audio as a |
| [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html#getMaxAlternatives--">getMaxAlternatives</a></span>()</code> |
| <div class="block"> |
| *Optional* Maximum number of recognition hypotheses to be returned.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionMetadata.html" title="class in com.google.cloud.speech.v1p1beta1">RecognitionMetadata</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html#getMetadata--">getMetadata</a></span>()</code> |
| <div class="block"> |
| *Optional* Metadata regarding this request.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionMetadataOrBuilder.html" title="interface in com.google.cloud.speech.v1p1beta1">RecognitionMetadataOrBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html#getMetadataOrBuilder--">getMetadataOrBuilder</a></span>()</code> |
| <div class="block"> |
| *Optional* Metadata regarding this request.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html#getModel--">getModel</a></span>()</code> |
| <div class="block"> |
| *Optional* Which model to select for the given request.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html#getModelBytes--">getModelBytes</a></span>()</code> |
| <div class="block"> |
| *Optional* Which model to select for the given request.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html#getProfanityFilter--">getProfanityFilter</a></span>()</code> |
| <div class="block"> |
| *Optional* If set to `true`, the server will attempt to filter out |
| profanities, replacing all but the initial character in each filtered word |
| with asterisks, e.g.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html#getSampleRateHertz--">getSampleRateHertz</a></span>()</code> |
| <div class="block"> |
| Sample rate in Hertz of the audio data sent in all |
| `RecognitionAudio` messages.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../com/google/cloud/speech/v1p1beta1/SpeechContext.html" title="class in com.google.cloud.speech.v1p1beta1">SpeechContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html#getSpeechContexts-int-">getSpeechContexts</a></span>(int index)</code> |
| <div class="block"> |
| *Optional* A means to provide context to assist the speech recognition.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html#getSpeechContextsCount--">getSpeechContextsCount</a></span>()</code> |
| <div class="block"> |
| *Optional* A means to provide context to assist the speech recognition.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<<a href="../../../../../com/google/cloud/speech/v1p1beta1/SpeechContext.html" title="class in com.google.cloud.speech.v1p1beta1">SpeechContext</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html#getSpeechContextsList--">getSpeechContextsList</a></span>()</code> |
| <div class="block"> |
| *Optional* A means to provide context to assist the speech recognition.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../com/google/cloud/speech/v1p1beta1/SpeechContextOrBuilder.html" title="interface in com.google.cloud.speech.v1p1beta1">SpeechContextOrBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html#getSpeechContextsOrBuilder-int-">getSpeechContextsOrBuilder</a></span>(int index)</code> |
| <div class="block"> |
| *Optional* A means to provide context to assist the speech recognition.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<? extends <a href="../../../../../com/google/cloud/speech/v1p1beta1/SpeechContextOrBuilder.html" title="interface in com.google.cloud.speech.v1p1beta1">SpeechContextOrBuilder</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html#getSpeechContextsOrBuilderList--">getSpeechContextsOrBuilderList</a></span>()</code> |
| <div class="block"> |
| *Optional* A means to provide context to assist the speech recognition.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html#getUseEnhanced--">getUseEnhanced</a></span>()</code> |
| <div class="block"> |
| *Optional* Set to true to use an enhanced model for speech recognition.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html#hasGoogleDataCollectionOptIn--">hasGoogleDataCollectionOptIn</a></span>()</code> |
| <div class="block"> |
| *Optional* Contains settings to opt-in to allow Google to |
| collect and use data from this request to improve Google's products and |
| services.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html#hasMetadata--">hasMetadata</a></span>()</code> |
| <div class="block"> |
| *Optional* Metadata regarding this request.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.com.google.protobuf.MessageOrBuilder"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface com.google.protobuf.<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageOrBuilder</a></h3> |
| <code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#findInitializationErrors--" title="class or interface in com.google.protobuf">findInitializationErrors</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getAllFields--" title="class or interface in com.google.protobuf">getAllFields</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getDefaultInstanceForType--" title="class or interface in com.google.protobuf">getDefaultInstanceForType</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getDescriptorForType--" title="class or interface in com.google.protobuf">getDescriptorForType</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getField-com.google.protobuf.Descriptors.FieldDescriptor-" title="class or interface in com.google.protobuf">getField</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getInitializationErrorString--" title="class or interface in com.google.protobuf">getInitializationErrorString</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getOneofFieldDescriptor-com.google.protobuf.Descriptors.OneofDescriptor-" title="class or interface in com.google.protobuf">getOneofFieldDescriptor</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getRepeatedField-com.google.protobuf.Descriptors.FieldDescriptor-int-" title="class or interface in com.google.protobuf">getRepeatedField</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getRepeatedFieldCount-com.google.protobuf.Descriptors.FieldDescriptor-" title="class or interface in com.google.protobuf">getRepeatedFieldCount</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getUnknownFields--" title="class or interface in com.google.protobuf">getUnknownFields</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#hasField-com.google.protobuf.Descriptors.FieldDescriptor-" title="class or interface in com.google.protobuf">hasField</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#hasOneof-com.google.protobuf.Descriptors.OneofDescriptor-" title="class or interface in com.google.protobuf">hasOneof</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.com.google.protobuf.MessageLiteOrBuilder"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface com.google.protobuf.<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageLiteOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageLiteOrBuilder</a></h3> |
| <code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageLiteOrBuilder.html?is-external=true#isInitialized--" title="class or interface in com.google.protobuf">isInitialized</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getEncodingValue--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEncodingValue</h4> |
| <pre>int getEncodingValue()</pre> |
| <div class="block"><pre> |
| Encoding of audio data sent in all `RecognitionAudio` messages. |
| This field is optional for `FLAC` and `WAV` audio files and required |
| for all other audio formats. For details, see [AudioEncoding][google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding]. |
| </pre> |
| |
| <code>.google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding encoding = 1;</code></div> |
| </li> |
| </ul> |
| <a name="getEncoding--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEncoding</h4> |
| <pre><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfig.AudioEncoding.html" title="enum in com.google.cloud.speech.v1p1beta1">RecognitionConfig.AudioEncoding</a> getEncoding()</pre> |
| <div class="block"><pre> |
| Encoding of audio data sent in all `RecognitionAudio` messages. |
| This field is optional for `FLAC` and `WAV` audio files and required |
| for all other audio formats. For details, see [AudioEncoding][google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding]. |
| </pre> |
| |
| <code>.google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding encoding = 1;</code></div> |
| </li> |
| </ul> |
| <a name="getSampleRateHertz--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSampleRateHertz</h4> |
| <pre>int getSampleRateHertz()</pre> |
| <div class="block"><pre> |
| Sample rate in Hertz of the audio data sent in all |
| `RecognitionAudio` messages. Valid values are: 8000-48000. |
| 16000 is optimal. For best results, set the sampling rate of the audio |
| source to 16000 Hz. If that's not possible, use the native sample rate of |
| the audio source (instead of re-sampling). |
| This field is optional for `FLAC` and `WAV` audio files and required |
| for all other audio formats. For details, see [AudioEncoding][google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding]. |
| </pre> |
| |
| <code>int32 sample_rate_hertz = 2;</code></div> |
| </li> |
| </ul> |
| <a name="getLanguageCode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLanguageCode</h4> |
| <pre>java.lang.String getLanguageCode()</pre> |
| <div class="block"><pre> |
| *Required* The language of the supplied audio as a |
| [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. |
| Example: "en-US". |
| See [Language Support](https://cloud.google.com/speech/docs/languages) |
| for a list of the currently supported language codes. |
| </pre> |
| |
| <code>string language_code = 3;</code></div> |
| </li> |
| </ul> |
| <a name="getLanguageCodeBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLanguageCodeBytes</h4> |
| <pre><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a> getLanguageCodeBytes()</pre> |
| <div class="block"><pre> |
| *Required* The language of the supplied audio as a |
| [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. |
| Example: "en-US". |
| See [Language Support](https://cloud.google.com/speech/docs/languages) |
| for a list of the currently supported language codes. |
| </pre> |
| |
| <code>string language_code = 3;</code></div> |
| </li> |
| </ul> |
| <a name="getMaxAlternatives--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxAlternatives</h4> |
| <pre>int getMaxAlternatives()</pre> |
| <div class="block"><pre> |
| *Optional* Maximum number of recognition hypotheses to be returned. |
| Specifically, the maximum number of `SpeechRecognitionAlternative` messages |
| within each `SpeechRecognitionResult`. |
| The server may return fewer than `max_alternatives`. |
| Valid values are `0`-`30`. A value of `0` or `1` will return a maximum of |
| one. If omitted, will return a maximum of one. |
| </pre> |
| |
| <code>int32 max_alternatives = 4;</code></div> |
| </li> |
| </ul> |
| <a name="getProfanityFilter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProfanityFilter</h4> |
| <pre>boolean getProfanityFilter()</pre> |
| <div class="block"><pre> |
| *Optional* If set to `true`, the server will attempt to filter out |
| profanities, replacing all but the initial character in each filtered word |
| with asterisks, e.g. "f***". If set to `false` or omitted, profanities |
| won't be filtered out. |
| </pre> |
| |
| <code>bool profanity_filter = 5;</code></div> |
| </li> |
| </ul> |
| <a name="getSpeechContextsList--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSpeechContextsList</h4> |
| <pre>java.util.List<<a href="../../../../../com/google/cloud/speech/v1p1beta1/SpeechContext.html" title="class in com.google.cloud.speech.v1p1beta1">SpeechContext</a>> getSpeechContextsList()</pre> |
| <div class="block"><pre> |
| *Optional* A means to provide context to assist the speech recognition. |
| </pre> |
| |
| <code>repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;</code></div> |
| </li> |
| </ul> |
| <a name="getSpeechContexts-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSpeechContexts</h4> |
| <pre><a href="../../../../../com/google/cloud/speech/v1p1beta1/SpeechContext.html" title="class in com.google.cloud.speech.v1p1beta1">SpeechContext</a> getSpeechContexts(int index)</pre> |
| <div class="block"><pre> |
| *Optional* A means to provide context to assist the speech recognition. |
| </pre> |
| |
| <code>repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;</code></div> |
| </li> |
| </ul> |
| <a name="getSpeechContextsCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSpeechContextsCount</h4> |
| <pre>int getSpeechContextsCount()</pre> |
| <div class="block"><pre> |
| *Optional* A means to provide context to assist the speech recognition. |
| </pre> |
| |
| <code>repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;</code></div> |
| </li> |
| </ul> |
| <a name="getSpeechContextsOrBuilderList--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSpeechContextsOrBuilderList</h4> |
| <pre>java.util.List<? extends <a href="../../../../../com/google/cloud/speech/v1p1beta1/SpeechContextOrBuilder.html" title="interface in com.google.cloud.speech.v1p1beta1">SpeechContextOrBuilder</a>> getSpeechContextsOrBuilderList()</pre> |
| <div class="block"><pre> |
| *Optional* A means to provide context to assist the speech recognition. |
| </pre> |
| |
| <code>repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;</code></div> |
| </li> |
| </ul> |
| <a name="getSpeechContextsOrBuilder-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSpeechContextsOrBuilder</h4> |
| <pre><a href="../../../../../com/google/cloud/speech/v1p1beta1/SpeechContextOrBuilder.html" title="interface in com.google.cloud.speech.v1p1beta1">SpeechContextOrBuilder</a> getSpeechContextsOrBuilder(int index)</pre> |
| <div class="block"><pre> |
| *Optional* A means to provide context to assist the speech recognition. |
| </pre> |
| |
| <code>repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;</code></div> |
| </li> |
| </ul> |
| <a name="getEnableWordTimeOffsets--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEnableWordTimeOffsets</h4> |
| <pre>boolean getEnableWordTimeOffsets()</pre> |
| <div class="block"><pre> |
| *Optional* If `true`, the top result includes a list of words and |
| the start and end time offsets (timestamps) for those words. If |
| `false`, no word-level time offset information is returned. The default is |
| `false`. |
| </pre> |
| |
| <code>bool enable_word_time_offsets = 8;</code></div> |
| </li> |
| </ul> |
| <a name="getEnableAutomaticPunctuation--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEnableAutomaticPunctuation</h4> |
| <pre>boolean getEnableAutomaticPunctuation()</pre> |
| <div class="block"><pre> |
| *Optional* If 'true', adds punctuation to recognition result hypotheses. |
| This feature is only available in select languages. Setting this for |
| requests in other languages has no effect at all. |
| The default 'false' value does not add punctuation to result hypotheses. |
| NOTE: "This is currently offered as an experimental service, complimentary |
| to all users. In the future this may be exclusively available as a |
| premium feature." |
| </pre> |
| |
| <code>bool enable_automatic_punctuation = 11;</code></div> |
| </li> |
| </ul> |
| <a name="hasMetadata--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasMetadata</h4> |
| <pre>boolean hasMetadata()</pre> |
| <div class="block"><pre> |
| *Optional* Metadata regarding this request. |
| </pre> |
| |
| <code>.google.cloud.speech.v1p1beta1.RecognitionMetadata metadata = 9;</code></div> |
| </li> |
| </ul> |
| <a name="getMetadata--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMetadata</h4> |
| <pre><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionMetadata.html" title="class in com.google.cloud.speech.v1p1beta1">RecognitionMetadata</a> getMetadata()</pre> |
| <div class="block"><pre> |
| *Optional* Metadata regarding this request. |
| </pre> |
| |
| <code>.google.cloud.speech.v1p1beta1.RecognitionMetadata metadata = 9;</code></div> |
| </li> |
| </ul> |
| <a name="getMetadataOrBuilder--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMetadataOrBuilder</h4> |
| <pre><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionMetadataOrBuilder.html" title="interface in com.google.cloud.speech.v1p1beta1">RecognitionMetadataOrBuilder</a> getMetadataOrBuilder()</pre> |
| <div class="block"><pre> |
| *Optional* Metadata regarding this request. |
| </pre> |
| |
| <code>.google.cloud.speech.v1p1beta1.RecognitionMetadata metadata = 9;</code></div> |
| </li> |
| </ul> |
| <a name="getModel--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getModel</h4> |
| <pre>java.lang.String getModel()</pre> |
| <div class="block"><pre> |
| *Optional* Which model to select for the given request. Select the model |
| best suited to your domain to get best results. If a model is not |
| explicitly specified, then we auto-select a model based on the parameters |
| in the RecognitionConfig. |
| <table> |
| <tr> |
| <td><b>Model</b></td> |
| <td><b>Description</b></td> |
| </tr> |
| <tr> |
| <td><code>command_and_search</code></td> |
| <td>Best for short queries such as voice commands or voice search.</td> |
| </tr> |
| <tr> |
| <td><code>phone_call</code></td> |
| <td>Best for audio that originated from a phone call (typically |
| recorded at an 8khz sampling rate).</td> |
| </tr> |
| <tr> |
| <td><code>video</code></td> |
| <td>Best for audio that originated from from video or includes multiple |
| speakers. Ideally the audio is recorded at a 16khz or greater |
| sampling rate. This is a premium model that costs more than the |
| standard rate.</td> |
| </tr> |
| <tr> |
| <td><code>default</code></td> |
| <td>Best for audio that is not one of the specific audio models. |
| For example, long-form audio. Ideally the audio is high-fidelity, |
| recorded at a 16khz or greater sampling rate.</td> |
| </tr> |
| </table> |
| </pre> |
| |
| <code>string model = 13;</code></div> |
| </li> |
| </ul> |
| <a name="getModelBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getModelBytes</h4> |
| <pre><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a> getModelBytes()</pre> |
| <div class="block"><pre> |
| *Optional* Which model to select for the given request. Select the model |
| best suited to your domain to get best results. If a model is not |
| explicitly specified, then we auto-select a model based on the parameters |
| in the RecognitionConfig. |
| <table> |
| <tr> |
| <td><b>Model</b></td> |
| <td><b>Description</b></td> |
| </tr> |
| <tr> |
| <td><code>command_and_search</code></td> |
| <td>Best for short queries such as voice commands or voice search.</td> |
| </tr> |
| <tr> |
| <td><code>phone_call</code></td> |
| <td>Best for audio that originated from a phone call (typically |
| recorded at an 8khz sampling rate).</td> |
| </tr> |
| <tr> |
| <td><code>video</code></td> |
| <td>Best for audio that originated from from video or includes multiple |
| speakers. Ideally the audio is recorded at a 16khz or greater |
| sampling rate. This is a premium model that costs more than the |
| standard rate.</td> |
| </tr> |
| <tr> |
| <td><code>default</code></td> |
| <td>Best for audio that is not one of the specific audio models. |
| For example, long-form audio. Ideally the audio is high-fidelity, |
| recorded at a 16khz or greater sampling rate.</td> |
| </tr> |
| </table> |
| </pre> |
| |
| <code>string model = 13;</code></div> |
| </li> |
| </ul> |
| <a name="getUseEnhanced--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUseEnhanced</h4> |
| <pre>boolean getUseEnhanced()</pre> |
| <div class="block"><pre> |
| *Optional* Set to true to use an enhanced model for speech recognition. |
| You must also set the `model` field to a valid, enhanced model. If |
| `use_enhanced` is set to true and the `model` field is not set, then |
| `use_enhanced` is ignored. 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 enable audio logging for |
| your request. To enable audio logging, set the `loggingConsentState` field |
| to ENABLED in the [GoogleDataCollectionConfig][google.cloud.speech.v1p1beta1.GoogleDataCollectionConfig] section of your request. |
| You must also opt-in to the audio logging alpha using the instructions in |
| the [alpha documentation](/speech/data-sharing). If you set `use_enhanced` |
| to true and you have not enabled audio logging, then you will receive |
| an error. |
| </pre> |
| |
| <code>bool use_enhanced = 14;</code></div> |
| </li> |
| </ul> |
| <a name="hasGoogleDataCollectionOptIn--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasGoogleDataCollectionOptIn</h4> |
| <pre>boolean hasGoogleDataCollectionOptIn()</pre> |
| <div class="block"><pre> |
| *Optional* Contains settings to opt-in to allow Google to |
| collect and use data from this request to improve Google's products and |
| services. |
| </pre> |
| |
| <code>.google.cloud.speech.v1p1beta1.GoogleDataCollectionConfig google_data_collection_opt_in = 10;</code></div> |
| </li> |
| </ul> |
| <a name="getGoogleDataCollectionOptIn--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGoogleDataCollectionOptIn</h4> |
| <pre><a href="../../../../../com/google/cloud/speech/v1p1beta1/GoogleDataCollectionConfig.html" title="class in com.google.cloud.speech.v1p1beta1">GoogleDataCollectionConfig</a> getGoogleDataCollectionOptIn()</pre> |
| <div class="block"><pre> |
| *Optional* Contains settings to opt-in to allow Google to |
| collect and use data from this request to improve Google's products and |
| services. |
| </pre> |
| |
| <code>.google.cloud.speech.v1p1beta1.GoogleDataCollectionConfig google_data_collection_opt_in = 10;</code></div> |
| </li> |
| </ul> |
| <a name="getGoogleDataCollectionOptInOrBuilder--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getGoogleDataCollectionOptInOrBuilder</h4> |
| <pre><a href="../../../../../com/google/cloud/speech/v1p1beta1/GoogleDataCollectionConfigOrBuilder.html" title="interface in com.google.cloud.speech.v1p1beta1">GoogleDataCollectionConfigOrBuilder</a> getGoogleDataCollectionOptInOrBuilder()</pre> |
| <div class="block"><pre> |
| *Optional* Contains settings to opt-in to allow Google to |
| collect and use data from this request to improve Google's products and |
| services. |
| </pre> |
| |
| <code>.google.cloud.speech.v1p1beta1.GoogleDataCollectionConfig google_data_collection_opt_in = 10;</code></div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfig.Builder.html" title="class in com.google.cloud.speech.v1p1beta1"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionMetadata.html" title="class in com.google.cloud.speech.v1p1beta1"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html" target="_top">Frames</a></li> |
| <li><a href="RecognitionConfigOrBuilder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
