Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1WebhookRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v3/classes.rb,
lib/google/apis/dialogflow_v3/representations.rb,
lib/google/apis/dialogflow_v3/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.



10505
10506
10507
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10505

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) 


10433
10434
10435
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10433

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) 


10438
10439
10440
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10438

def dtmf_digits
  @dtmf_digits
end

#fulfillment_info ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo

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

Returns:



10443
10444
10445
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10443

def fulfillment_info
  @fulfillment_info
end

#intent_info ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo

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

Returns:



10448
10449
10450
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10448

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) 


10453
10454
10455
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10453

def language_code
  @language_code
end

#messages ⇒ Array<Google::Apis::DialogflowV3::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:



10459
10460
10461
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10459

def messages
  @messages
end

#page_info ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1PageInfo

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

Returns:



10464
10465
10466
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10464

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>) 


10469
10470
10471
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10469

def payload
  @payload
end

#sentiment_analysis_result ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1WebhookRequestSentimentAnalysisResult

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

Returns:



10474
10475
10476
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10474

def sentiment_analysis_result
  @sentiment_analysis_result
end

#session_info ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1SessionInfo

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

Returns:



10479
10480
10481
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10479

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) 


10485
10486
10487
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10485

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) 


10491
10492
10493
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10491

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) 


10497
10498
10499
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10497

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) 


10503
10504
10505
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10503

def trigger_intent
  @trigger_intent
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10510

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)
  @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