Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1WebhookRequest
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1WebhookRequest
- 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::GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo
Represents fulfillment information communicated to the webhook.
-
#intent_info ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo
Represents intent information communicated to the webhook.
-
#language_code ⇒ String
The language code specified in the original request.
-
#messages ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1ResponseMessage>
The list of rich message responses to present to the user.
-
#page_info ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1PageInfo
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::GoogleCloudDialogflowCxV3beta1WebhookRequestSentimentAnalysisResult
Represents the result of sentiment analysis.
-
#session_info ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1SessionInfo
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) ⇒ GoogleCloudDialogflowCxV3beta1WebhookRequest
constructor
A new instance of GoogleCloudDialogflowCxV3beta1WebhookRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3beta1WebhookRequest
Returns a new instance of GoogleCloudDialogflowCxV3beta1WebhookRequest.
11930 11931 11932 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 11930 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
11858 11859 11860 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 11858 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
11863 11864 11865 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 11863 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
11868 11869 11870 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 11868 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
11873 11874 11875 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 11873 def intent_info @intent_info end |
#language_code ⇒ String
The language code specified in the original request.
Corresponds to the JSON property languageCode
11878 11879 11880 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 11878 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
11884 11885 11886 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 11884 def @messages end |
#page_info ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1PageInfo
Represents page information communicated to and from the webhook.
Corresponds to the JSON property pageInfo
11889 11890 11891 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 11889 def page_info @page_info end |
#payload ⇒ Hash<String,Object>
Custom data set in QueryParameters.payload.
Corresponds to the JSON property payload
11894 11895 11896 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 11894 def payload @payload end |
#sentiment_analysis_result ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1WebhookRequestSentimentAnalysisResult
Represents the result of sentiment analysis.
Corresponds to the JSON property sentimentAnalysisResult
11899 11900 11901 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 11899 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
11904 11905 11906 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 11904 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
11910 11911 11912 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 11910 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
11916 11917 11918 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 11916 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
11922 11923 11924 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 11922 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
11928 11929 11930 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 11928 def trigger_intent @trigger_intent end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 11935 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 |