Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3WebhookRequest
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3WebhookRequest
- 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
-
#detect_intent_response_id ⇒ String
Always present.
-
#dtmf_digits ⇒ String
If DTMF was provided as input, this field will contain the DTMF digits.
-
#fulfillment_info ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo
Represents fulfillment information communicated to the webhook.
-
#intent_info ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3WebhookRequestIntentInfo
Represents intent information communicated to the webhook.
-
#language_code ⇒ String
The language code specified in the original request.
-
#messages ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessage>
The list of rich message responses to present to the user.
-
#page_info ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3PageInfo
Represents page information communicated to and from the webhook.
-
#payload ⇒ Hash<String,Object>
Custom data set in QueryParameters.payload.
-
#sentiment_analysis_result ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3WebhookRequestSentimentAnalysisResult
Represents the result of sentiment analysis.
-
#session_info ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionInfo
Represents session information communicated to and from the webhook.
-
#text ⇒ String
If natural language text was provided as input, this field will contain a copy of the text.
-
#transcript ⇒ String
If natural language speech audio was provided as input, this field will contain the transcript for the audio.
-
#trigger_event ⇒ String
If an event was provided as input, this field will contain the name of the event.
-
#trigger_intent ⇒ String
If an intent was provided as input, this field will contain a copy of the intent identifier.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3WebhookRequest
constructor
A new instance of GoogleCloudDialogflowCxV3WebhookRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3WebhookRequest
Returns a new instance of GoogleCloudDialogflowCxV3WebhookRequest.
7835 7836 7837 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7835 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
7763 7764 7765 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7763 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
7768 7769 7770 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7768 def dtmf_digits @dtmf_digits end |
#fulfillment_info ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo
Represents fulfillment information communicated to the webhook.
Corresponds to the JSON property fulfillmentInfo
7773 7774 7775 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7773 def fulfillment_info @fulfillment_info end |
#intent_info ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3WebhookRequestIntentInfo
Represents intent information communicated to the webhook.
Corresponds to the JSON property intentInfo
7778 7779 7780 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7778 def intent_info @intent_info end |
#language_code ⇒ String
The language code specified in the original request.
Corresponds to the JSON property languageCode
7783 7784 7785 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7783 def language_code @language_code end |
#messages ⇒ Array<Google::Apis::DialogflowV3::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
7789 7790 7791 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7789 def @messages end |
#page_info ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3PageInfo
Represents page information communicated to and from the webhook.
Corresponds to the JSON property pageInfo
7794 7795 7796 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7794 def page_info @page_info end |
#payload ⇒ Hash<String,Object>
Custom data set in QueryParameters.payload.
Corresponds to the JSON property payload
7799 7800 7801 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7799 def payload @payload end |
#sentiment_analysis_result ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3WebhookRequestSentimentAnalysisResult
Represents the result of sentiment analysis.
Corresponds to the JSON property sentimentAnalysisResult
7804 7805 7806 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7804 def sentiment_analysis_result @sentiment_analysis_result end |
#session_info ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SessionInfo
Represents session information communicated to and from the webhook.
Corresponds to the JSON property sessionInfo
7809 7810 7811 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7809 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
7815 7816 7817 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7815 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
7821 7822 7823 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7821 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
7827 7828 7829 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7827 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
7833 7834 7835 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7833 def trigger_intent @trigger_intent end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 7840 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 |