Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1WebhookRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v2beta1/classes.rb,
lib/google/apis/dialogflow_v2beta1/representations.rb,
lib/google/apis/dialogflow_v2beta1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3beta1WebhookRequest

Returns a new instance of GoogleCloudDialogflowCxV3beta1WebhookRequest.



7442
7443
7444
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7442

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#detect_intent_response_id ⇒ String

Always present. The unique identifier of the DetectIntentResponse that will be returned to the API caller. Corresponds to the JSON property detectIntentResponseId

Returns:

  • (String) 


7365
7366
7367
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7365

def detect_intent_response_id
  @detect_intent_response_id
end

#dtmf_digits ⇒ String

If DTMF was provided as input, this field will contain the DTMF digits. Corresponds to the JSON property dtmfDigits

Returns:

  • (String) 


7370
7371
7372
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7370

def dtmf_digits
  @dtmf_digits
end

#fulfillment_info ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo

Represents fulfillment information communicated to the webhook. Corresponds to the JSON property fulfillmentInfo

Returns:



7375
7376
7377
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7375

def fulfillment_info
  @fulfillment_info
end

#intent_info ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo

Represents intent information communicated to the webhook. Corresponds to the JSON property intentInfo

Returns:



7380
7381
7382
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7380

def intent_info
  @intent_info
end

#language_code ⇒ String

The language code specified in the original request. Corresponds to the JSON property languageCode

Returns:

  • (String) 


7385
7386
7387
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7385

def language_code
  @language_code
end

#language_info ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1LanguageInfo

Represents the language information of the request. Corresponds to the JSON property languageInfo

Returns:



7390
7391
7392
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7390

def language_info
  @language_info
end

#messages ⇒ Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessage>

The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response; Corresponds to the JSON property messages

Returns:



7396
7397
7398
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7396

def messages
  @messages
end

#page_info ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1PageInfo

Represents page information communicated to and from the webhook. Corresponds to the JSON property pageInfo

Returns:



7401
7402
7403
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7401

def page_info
  @page_info
end

#payload ⇒ Hash<String,Object>

Custom data set in QueryParameters.payload. Corresponds to the JSON property payload

Returns:

  • (Hash<String,Object>) 


7406
7407
7408
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7406

def payload
  @payload
end

#sentiment_analysis_result ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1WebhookRequestSentimentAnalysisResult

Represents the result of sentiment analysis. Corresponds to the JSON property sentimentAnalysisResult

Returns:



7411
7412
7413
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7411

def sentiment_analysis_result
  @sentiment_analysis_result
end

#session_info ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1SessionInfo

Represents session information communicated to and from the webhook. Corresponds to the JSON property sessionInfo

Returns:



7416
7417
7418
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7416

def session_info
  @session_info
end

#text ⇒ String

If natural language text was provided as input, this field will contain a copy of the text. Corresponds to the JSON property text

Returns:

  • (String) 


7422
7423
7424
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7422

def text
  @text
end

#transcript ⇒ String

If natural language speech audio was provided as input, this field will contain the transcript for the audio. Corresponds to the JSON property transcript

Returns:

  • (String) 


7428
7429
7430
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7428

def transcript
  @transcript
end

#trigger_event ⇒ String

If an event was provided as input, this field will contain the name of the event. Corresponds to the JSON property triggerEvent

Returns:

  • (String) 


7434
7435
7436
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7434

def trigger_event
  @trigger_event
end

#trigger_intent ⇒ String

If an intent was provided as input, this field will contain a copy of the intent identifier. Format: projects//locations//agents//intents/. Corresponds to the JSON property triggerIntent

Returns:

  • (String) 


7440
7441
7442
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7440

def trigger_intent
  @trigger_intent
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7447

def update!(**args)
  @detect_intent_response_id = args[:detect_intent_response_id] if args.key?(:detect_intent_response_id)
  @dtmf_digits = args[:dtmf_digits] if args.key?(:dtmf_digits)
  @fulfillment_info = args[:fulfillment_info] if args.key?(:fulfillment_info)
  @intent_info = args[:intent_info] if args.key?(:intent_info)
  @language_code = args[:language_code] if args.key?(:language_code)
  @language_info = args[:language_info] if args.key?(:language_info)
  @messages = args[:messages] if args.key?(:messages)
  @page_info = args[:page_info] if args.key?(:page_info)
  @payload = args[:payload] if args.key?(:payload)
  @sentiment_analysis_result = args[:sentiment_analysis_result] if args.key?(:sentiment_analysis_result)
  @session_info = args[:session_info] if args.key?(:session_info)
  @text = args[:text] if args.key?(:text)
  @transcript = args[:transcript] if args.key?(:transcript)
  @trigger_event = args[:trigger_event] if args.key?(:trigger_event)
  @trigger_intent = args[:trigger_intent] if args.key?(:trigger_intent)
end