Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::WebhookRequest (v0.21.0)

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

The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases.

You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#detect_intent_response_id

def detect_intent_response_id() -> ::String
Returns
  • (::String) — Always present. The unique identifier of the DetectIntentResponse that will be returned to the API caller.

#detect_intent_response_id=

def detect_intent_response_id=(value) -> ::String
Parameter
  • value (::String) — Always present. The unique identifier of the DetectIntentResponse that will be returned to the API caller.
Returns
  • (::String) — Always present. The unique identifier of the DetectIntentResponse that will be returned to the API caller.

#dtmf_digits

def dtmf_digits() -> ::String
Returns
  • (::String) — If DTMF was provided as input, this field will contain the DTMF digits.

#dtmf_digits=

def dtmf_digits=(value) -> ::String
Parameter
  • value (::String) — If DTMF was provided as input, this field will contain the DTMF digits.
Returns
  • (::String) — If DTMF was provided as input, this field will contain the DTMF digits.

#fulfillment_info

def fulfillment_info() -> ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::FulfillmentInfo
Returns

#fulfillment_info=

def fulfillment_info=(value) -> ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::FulfillmentInfo
Parameter
Returns

#intent_info

def intent_info() -> ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo
Returns

#intent_info=

def intent_info=(value) -> ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo
Parameter
Returns

#language_code

def language_code() -> ::String
Returns
  • (::String) — The language code specified in the [original request][QueryInput.language_code].

#language_code=

def language_code=(value) -> ::String
Parameter
  • value (::String) — The language code specified in the [original request][QueryInput.language_code].
Returns
  • (::String) — The language code specified in the [original request][QueryInput.language_code].

#messages

def messages() -> ::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>
Returns

#messages=

def messages=(value) -> ::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>
Parameter
Returns

#page_info

def page_info() -> ::Google::Cloud::Dialogflow::CX::V3::PageInfo
Returns

#page_info=

def page_info=(value) -> ::Google::Cloud::Dialogflow::CX::V3::PageInfo
Parameter
Returns

#payload

def payload() -> ::Google::Protobuf::Struct
Returns

#payload=

def payload=(value) -> ::Google::Protobuf::Struct
Parameter
Returns

#sentiment_analysis_result

def sentiment_analysis_result() -> ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::SentimentAnalysisResult
Returns

#sentiment_analysis_result=

def sentiment_analysis_result=(value) -> ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::SentimentAnalysisResult
Parameter
Returns

#session_info

def session_info() -> ::Google::Cloud::Dialogflow::CX::V3::SessionInfo
Returns

#session_info=

def session_info=(value) -> ::Google::Cloud::Dialogflow::CX::V3::SessionInfo
Parameter
Returns

#text

def text() -> ::String
Returns
  • (::String) — If natural language text was provided as input, this field will contain a copy of the text.

#text=

def text=(value) -> ::String
Parameter
  • value (::String) — If natural language text was provided as input, this field will contain a copy of the text.
Returns
  • (::String) — If natural language text was provided as input, this field will contain a copy of the text.

#transcript

def transcript() -> ::String
Returns
  • (::String) — If [natural language speech audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input, this field will contain the transcript for the audio.

#transcript=

def transcript=(value) -> ::String
Parameter
  • value (::String) — If [natural language speech audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input, this field will contain the transcript for the audio.
Returns
  • (::String) — If [natural language speech audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input, this field will contain the transcript for the audio.

#trigger_event

def trigger_event() -> ::String
Returns
  • (::String) — If an event was provided as input, this field will contain the name of the event.

#trigger_event=

def trigger_event=(value) -> ::String
Parameter
  • value (::String) — If an event was provided as input, this field will contain the name of the event.
Returns
  • (::String) — If an event was provided as input, this field will contain the name of the event.

#trigger_intent

def trigger_intent() -> ::String
Returns
  • (::String) — If an intent was provided as input, this field will contain a copy of the intent identifier. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.

#trigger_intent=

def trigger_intent=(value) -> ::String
Parameter
  • value (::String) — If an intent was provided as input, this field will contain a copy of the intent identifier. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.
Returns
  • (::String) — If an intent was provided as input, this field will contain a copy of the intent identifier. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.