Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::QueryInput (v1.4.0)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::QueryInput.

Represents the query input. It can contain one of:

  1. A conversational query in the form of text.

  2. An intent query that specifies which intent to trigger.

  3. Natural language speech audio to be processed.

  4. An event to be triggered.

  5. DTMF digits to invoke an intent and fill in parameter value.

  6. The results of a tool executed by the client.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#audio

def audio() -> ::Google::Cloud::Dialogflow::CX::V3::AudioInput
Returns
  • (::Google::Cloud::Dialogflow::CX::V3::AudioInput) — The natural language speech audio to be processed.

    Note: The following fields are mutually exclusive: audio, text, intent, event, dtmf. If a field in that set is populated, all other fields in the set will automatically be cleared.

#audio=

def audio=(value) -> ::Google::Cloud::Dialogflow::CX::V3::AudioInput
Parameter
  • value (::Google::Cloud::Dialogflow::CX::V3::AudioInput) — The natural language speech audio to be processed.

    Note: The following fields are mutually exclusive: audio, text, intent, event, dtmf. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Dialogflow::CX::V3::AudioInput) — The natural language speech audio to be processed.

    Note: The following fields are mutually exclusive: audio, text, intent, event, dtmf. If a field in that set is populated, all other fields in the set will automatically be cleared.

#dtmf

def dtmf() -> ::Google::Cloud::Dialogflow::CX::V3::DtmfInput
Returns
  • (::Google::Cloud::Dialogflow::CX::V3::DtmfInput) — The DTMF event to be handled.

    Note: The following fields are mutually exclusive: dtmf, text, intent, audio, event. If a field in that set is populated, all other fields in the set will automatically be cleared.

#dtmf=

def dtmf=(value) -> ::Google::Cloud::Dialogflow::CX::V3::DtmfInput
Parameter
  • value (::Google::Cloud::Dialogflow::CX::V3::DtmfInput) — The DTMF event to be handled.

    Note: The following fields are mutually exclusive: dtmf, text, intent, audio, event. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Dialogflow::CX::V3::DtmfInput) — The DTMF event to be handled.

    Note: The following fields are mutually exclusive: dtmf, text, intent, audio, event. If a field in that set is populated, all other fields in the set will automatically be cleared.

#event

def event() -> ::Google::Cloud::Dialogflow::CX::V3::EventInput
Returns
  • (::Google::Cloud::Dialogflow::CX::V3::EventInput) — The event to be triggered.

    Note: The following fields are mutually exclusive: event, text, intent, audio, dtmf. If a field in that set is populated, all other fields in the set will automatically be cleared.

#event=

def event=(value) -> ::Google::Cloud::Dialogflow::CX::V3::EventInput
Parameter
  • value (::Google::Cloud::Dialogflow::CX::V3::EventInput) — The event to be triggered.

    Note: The following fields are mutually exclusive: event, text, intent, audio, dtmf. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Dialogflow::CX::V3::EventInput) — The event to be triggered.

    Note: The following fields are mutually exclusive: event, text, intent, audio, dtmf. If a field in that set is populated, all other fields in the set will automatically be cleared.

#intent

def intent() -> ::Google::Cloud::Dialogflow::CX::V3::IntentInput
Returns
  • (::Google::Cloud::Dialogflow::CX::V3::IntentInput) — The intent to be triggered.

    Note: The following fields are mutually exclusive: intent, text, audio, event, dtmf. If a field in that set is populated, all other fields in the set will automatically be cleared.

#intent=

def intent=(value) -> ::Google::Cloud::Dialogflow::CX::V3::IntentInput
Parameter
  • value (::Google::Cloud::Dialogflow::CX::V3::IntentInput) — The intent to be triggered.

    Note: The following fields are mutually exclusive: intent, text, audio, event, dtmf. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Dialogflow::CX::V3::IntentInput) — The intent to be triggered.

    Note: The following fields are mutually exclusive: intent, text, audio, event, dtmf. If a field in that set is populated, all other fields in the set will automatically be cleared.

#language_code

def language_code() -> ::String
Returns
  • (::String) — Required. The language of the input. 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.

#language_code=

def language_code=(value) -> ::String
Parameter
  • value (::String) — Required. The language of the input. 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.
Returns
  • (::String) — Required. The language of the input. 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.

#text

def text() -> ::Google::Cloud::Dialogflow::CX::V3::TextInput
Returns
  • (::Google::Cloud::Dialogflow::CX::V3::TextInput) — The natural language text to be processed.

    Note: The following fields are mutually exclusive: text, intent, audio, event, dtmf. If a field in that set is populated, all other fields in the set will automatically be cleared.

#text=

def text=(value) -> ::Google::Cloud::Dialogflow::CX::V3::TextInput
Parameter
  • value (::Google::Cloud::Dialogflow::CX::V3::TextInput) — The natural language text to be processed.

    Note: The following fields are mutually exclusive: text, intent, audio, event, dtmf. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Dialogflow::CX::V3::TextInput) — The natural language text to be processed.

    Note: The following fields are mutually exclusive: text, intent, audio, event, dtmf. If a field in that set is populated, all other fields in the set will automatically be cleared.