QueryInput

Represents the query input. It can contain either:

  1. An audio config which instructs the speech recognizer how to process the speech audio.

  2. A conversational query in the form of text.

  3. An event that specifies which intent to trigger.

JSON representation 
{

  // Union field input can be only one of the following:
  "audioConfig": {
    object (InputAudioConfig)
  },
  "text": {
    object (TextInput)
  },
  "event": {
    object (EventInput)
  },
  "dtmf": {
    object (TelephonyDtmfEvents)
  }
  // End of list of possible types for union field input.
}
Fields
Union field input. Required. The input specification. input can be only one of the following:
audioConfig

object (InputAudioConfig)

Instructs the speech recognizer how to process the speech audio.
text

object (TextInput)

The natural language text to be processed.
event

object (EventInput)

The event to be processed.
dtmf

object (TelephonyDtmfEvents)

The DTMF digits used to invoke intent and fill in parameter value.

InputAudioConfig

Instructs the speech recognizer on how to process the audio content.

JSON representation 
{
  "audioEncoding": enum (AudioEncoding),
  "sampleRateHertz": integer,
  "languageCode": string,
  "enableWordInfo": boolean,
  "phraseHints": [
    string
  ],
  "speechContexts": [
    {
      object (SpeechContext)
    }
  ],
  "model": string,
  "modelVariant": enum (SpeechModelVariant),
  "singleUtterance": boolean,
  "disableNoSpeechRecognizedEvent": boolean
}
Fields
audioEncoding

enum (AudioEncoding)

Required. Audio encoding of the audio content to process.
sampleRateHertz

integer

Required. Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details.
languageCode

string

Required. The language of the supplied audio. Dialogflow does not do translations. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.
enableWordInfo

boolean

If true, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.
phraseHints[]
(deprecated)

string

A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood.

See the Cloud Speech documentation for more details.

This field is deprecated. Please use speechContexts instead. If you specify both phraseHints and speechContexts, Dialogflow will treat the phraseHints as a single additional SpeechContext.
speechContexts[]

object (SpeechContext)

Context information to assist speech recognition.

See the Cloud Speech documentation for more details.
model

string

Which Speech 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 InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to Cloud Speech API documentation for more details.
modelVariant

enum (SpeechModelVariant)

Which variant of the Speech model to use.
singleUtterance

boolean

If false (default), recognition does not cease until the client closes the stream. If true, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods. Note: When specified, InputAudioConfig.single_utterance takes precedence over StreamingDetectIntentRequest.single_utterance.
disableNoSpeechRecognizedEvent

boolean

Only used in Participants.AnalyzeContent and Participants.StreamingAnalyzeContent. If false and recognition doesn't return any result, trigger NO_SPEECH_RECOGNIZED event to Dialogflow agent.

AudioEncoding

Audio encoding of the audio content sent in the conversational query request. Refer to the Cloud Speech API documentation for more details.

Enums
AUDIO_ENCODING_UNSPECIFIED Not specified.
AUDIO_ENCODING_LINEAR_16 Uncompressed 16-bit signed little-endian samples (Linear PCM).
AUDIO_ENCODING_FLAC FLAC (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of LINEAR16. FLAC stream encoding supports 16-bit and 24-bit samples, however, not all fields in STREAMINFO are supported.
AUDIO_ENCODING_MULAW 8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.
AUDIO_ENCODING_AMR Adaptive Multi-Rate Narrowband codec. sampleRateHertz must be 8000.
AUDIO_ENCODING_AMR_WB Adaptive Multi-Rate Wideband codec. sampleRateHertz must be 16000.
AUDIO_ENCODING_OGG_OPUS Opus encoded audio frames in Ogg container (OggOpus). sampleRateHertz must be 16000.
AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, OGG_OPUS is highly preferred over Speex encoding. The Speex encoding supported by Dialogflow API has a header byte in each block, as in MIME type audio/x-speex-with-header-byte. It is a variant of the RTP Speex encoding defined in RFC 5574. The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. sampleRateHertz must be 16000.

SpeechContext

Hints for the speech recognizer to help with recognition in a specific conversation state.

JSON representation 
{
  "phrases": [
    string
  ],
  "boost": number
}
Fields
phrases[]

string

Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood.

This list can be used to:

  • improve accuracy for words and phrases you expect the user to say, e.g. typical commands for your Dialogflow agent
  • add additional words to the speech recognizer vocabulary
  • ...

See the Cloud Speech documentation for usage limits.
boost

number

Optional. Boost for this context compared to other contexts:

  • If the boost is positive, Dialogflow will increase the probability that the phrases in this context are recognized over similar sounding phrases.
  • If the boost is unspecified or non-positive, Dialogflow will not apply any boost.

Dialogflow recommends that you use boosts in the range (0, 20] and that you find a value that fits your use case with binary search.

TelephonyDtmfEvents

A wrapper of repeated TelephonyDtmf digits.

JSON representation 
{
  "dtmfEvents": [
    enum (TelephonyDtmf)
  ]
}
Fields
dtmfEvents[]

enum (TelephonyDtmf)

A sequence of TelephonyDtmf digits.

TelephonyDtmf

DTMF digit in Telephony Gateway.

Enums
TELEPHONY_DTMF_UNSPECIFIED Not specified. This value may be used to indicate an absent digit.
DTMF_ONE Number: '1'.
DTMF_TWO Number: '2'.
DTMF_THREE Number: '3'.
DTMF_FOUR Number: '4'.
DTMF_FIVE Number: '5'.
DTMF_SIX Number: '6'.
DTMF_SEVEN Number: '7'.
DTMF_EIGHT Number: '8'.
DTMF_NINE Number: '9'.
DTMF_ZERO Number: '0'.
DTMF_A Letter: 'A'.
DTMF_B Letter: 'B'.
DTMF_C Letter: 'C'.
DTMF_D Letter: 'D'.
DTMF_STAR Asterisk/star: '*'.
DTMF_POUND Pound/diamond/hash/square/gate/octothorpe: '#'.