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.



7696
7697
7698
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7696

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) 


7619
7620
7621
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7619

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) 


7624
7625
7626
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7624

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:



7629
7630
7631
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7629

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:



7634
7635
7636
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7634

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) 


7639
7640
7641
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7639

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:



7644
7645
7646
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7644

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:



7650
7651
7652
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7650

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:



7655
7656
7657
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7655

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


7660
7661
7662
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7660

def payload
  @payload
end

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

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

Returns:



7665
7666
7667
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7665

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:



7670
7671
7672
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7670

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) 


7676
7677
7678
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7676

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) 


7682
7683
7684
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7682

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) 


7688
7689
7690
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7688

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) 


7694
7695
7696
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7694

def trigger_intent
  @trigger_intent
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 7701

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