Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1WebhookRequest

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

Returns a new instance of GoogleCloudDialogflowCxV3beta1WebhookRequest.



5933
5934
5935
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5933

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) 


5861
5862
5863
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5861

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

Returns:

  • (String) 


5866
5867
5868
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5866

def dtmf_digits
  @dtmf_digits
end

#fulfillment_info ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo

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

Returns:



5871
5872
5873
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5871

def fulfillment_info
  @fulfillment_info
end

#intent_info ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo

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

Returns:



5876
5877
5878
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5876

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) 


5881
5882
5883
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5881

def language_code
  @language_code
end

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

Returns:



5887
5888
5889
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5887

def messages
  @messages
end

#page_info ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1PageInfo

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

Returns:



5892
5893
5894
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5892

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


5897
5898
5899
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5897

def payload
  @payload
end

#sentiment_analysis_result ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1WebhookRequestSentimentAnalysisResult

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

Returns:



5902
5903
5904
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5902

def sentiment_analysis_result
  @sentiment_analysis_result
end

#session_info ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1SessionInfo

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

Returns:



5907
5908
5909
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5907

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) 


5913
5914
5915
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5913

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) 


5919
5920
5921
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5919

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) 


5925
5926
5927
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5925

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) 


5931
5932
5933
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5931

def trigger_intent
  @trigger_intent
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5938

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