Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3WebhookRequest

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

Returns a new instance of GoogleCloudDialogflowCxV3WebhookRequest.



3614
3615
3616
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3614

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) 


3537
3538
3539
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3537

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) 


3542
3543
3544
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3542

def dtmf_digits
  @dtmf_digits
end

#fulfillment_info ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo

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

Returns:



3547
3548
3549
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3547

def fulfillment_info
  @fulfillment_info
end

#intent_info ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3WebhookRequestIntentInfo

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

Returns:



3552
3553
3554
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3552

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) 


3557
3558
3559
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3557

def language_code
  @language_code
end

#language_info ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3LanguageInfo

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

Returns:



3562
3563
3564
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3562

def language_info
  @language_info
end

#messages ⇒ Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessage>

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:



3568
3569
3570
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3568

def messages
  @messages
end

#page_info ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3PageInfo

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

Returns:



3573
3574
3575
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3573

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


3578
3579
3580
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3578

def payload
  @payload
end

#sentiment_analysis_result ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3WebhookRequestSentimentAnalysisResult

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

Returns:



3583
3584
3585
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3583

def sentiment_analysis_result
  @sentiment_analysis_result
end

#session_info ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3SessionInfo

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

Returns:



3588
3589
3590
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3588

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) 


3594
3595
3596
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3594

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) 


3600
3601
3602
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3600

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) 


3606
3607
3608
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3606

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) 


3612
3613
3614
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3612

def trigger_intent
  @trigger_intent
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3619

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