Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3WebhookRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v3beta1/classes.rb,
lib/google/apis/dialogflow_v3beta1/representations.rb,
lib/google/apis/dialogflow_v3beta1/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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3WebhookRequest

Returns a new instance of GoogleCloudDialogflowCxV3WebhookRequest.



2521
2522
2523
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2521

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) 


2454
2455
2456
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2454

def detect_intent_response_id
  @detect_intent_response_id
end

#fulfillment_info ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo

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

Returns:



2459
2460
2461
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2459

def fulfillment_info
  @fulfillment_info
end

#intent_info ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3WebhookRequestIntentInfo

Represents intent information communicated to the webhook. Corresponds to the JSON property intentInfo

Returns:



2464
2465
2466
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2464

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) 


2469
2470
2471
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2469

def language_code
  @language_code
end

#messages ⇒ Array<Google::Apis::DialogflowV3beta1::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:



2475
2476
2477
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2475

def messages
  @messages
end

#page_info ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3PageInfo

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

Returns:



2480
2481
2482
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2480

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


2485
2486
2487
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2485

def payload
  @payload
end

#sentiment_analysis_result ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3WebhookRequestSentimentAnalysisResult

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

Returns:



2490
2491
2492
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2490

def sentiment_analysis_result
  @sentiment_analysis_result
end

#session_info ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3SessionInfo

Represents session information communicated to and from the webhook. Corresponds to the JSON property sessionInfo

Returns:



2495
2496
2497
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2495

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) 


2501
2502
2503
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2501

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) 


2507
2508
2509
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2507

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) 


2513
2514
2515
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2513

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) 


2519
2520
2521
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2519

def trigger_intent
  @trigger_intent
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2526

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