Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3WebhookRequest

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3WebhookRequest

Returns a new instance of GoogleCloudDialogflowCxV3WebhookRequest.



6325
6326
6327
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6325

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) 


6258
6259
6260
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6258

def detect_intent_response_id
  @detect_intent_response_id
end

#fulfillment_info ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo

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

Returns:



6263
6264
6265
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6263

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

Returns:



6268
6269
6270
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6268

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) 


6273
6274
6275
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6273

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

Returns:



6279
6280
6281
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6279

def messages
  @messages
end

#page_info ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3PageInfo

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

Returns:



6284
6285
6286
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6284

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


6289
6290
6291
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6289

def payload
  @payload
end

#sentiment_analysis_result ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3WebhookRequestSentimentAnalysisResult

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

Returns:



6294
6295
6296
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6294

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

Returns:



6299
6300
6301
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6299

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) 


6305
6306
6307
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6305

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) 


6311
6312
6313
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6311

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) 


6317
6318
6319
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6317

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) 


6323
6324
6325
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6323

def trigger_intent
  @trigger_intent
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 6330

def update!(**args)
  @detect_intent_response_id = args[:detect_intent_response_id] if args.key?(:detect_intent_response_id)
  @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