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.
6459 6460 6461 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6459 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
6387 6388 6389 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6387 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
6392 6393 6394 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6392 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
6397 6398 6399 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6397 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
6402 6403 6404 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6402 def intent_info @intent_info end |
#language_code ⇒ String
The language code specified in the original request.
Corresponds to the JSON property languageCode
6407 6408 6409 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6407 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
6413 6414 6415 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6413 def @messages end |
#page_info ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3PageInfo
Represents page information communicated to and from the webhook.
Corresponds to the JSON property pageInfo
6418 6419 6420 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6418 def page_info @page_info end |
#payload ⇒ Hash<String,Object>
Custom data set in QueryParameters.payload.
Corresponds to the JSON property payload
6423 6424 6425 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6423 def payload @payload end |
#sentiment_analysis_result ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3WebhookRequestSentimentAnalysisResult
Represents the result of sentiment analysis.
Corresponds to the JSON property sentimentAnalysisResult
6428 6429 6430 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6428 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
6433 6434 6435 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6433 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
6439 6440 6441 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6439 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
6445 6446 6447 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6445 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
6451 6452 6453 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6451 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
6457 6458 6459 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6457 def trigger_intent @trigger_intent end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6464 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 |