Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1WebhookRequest

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



9539
9540
9541
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9539

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) 


9467
9468
9469
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9467

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) 


9472
9473
9474
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9472

def dtmf_digits
  @dtmf_digits
end

#fulfillment_info ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo

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

Returns:



9477
9478
9479
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9477

def fulfillment_info
  @fulfillment_info
end

#intent_info ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo

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

Returns:



9482
9483
9484
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9482

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) 


9487
9488
9489
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9487

def language_code
  @language_code
end

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



9493
9494
9495
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9493

def messages
  @messages
end

#page_info ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PageInfo

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

Returns:



9498
9499
9500
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9498

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


9503
9504
9505
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9503

def payload
  @payload
end

#sentiment_analysis_result ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1WebhookRequestSentimentAnalysisResult

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

Returns:



9508
9509
9510
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9508

def sentiment_analysis_result
  @sentiment_analysis_result
end

#session_info ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionInfo

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

Returns:



9513
9514
9515
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9513

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) 


9519
9520
9521
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9519

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) 


9525
9526
9527
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9525

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) 


9531
9532
9533
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9531

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) 


9537
9538
9539
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9537

def trigger_intent
  @trigger_intent
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 9544

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