Class: Google::Cloud::Dialogflow::CX::V3::WebhookRequest
- Inherits:
-
Object
- Object
- Google::Cloud::Dialogflow::CX::V3::WebhookRequest
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/dialogflow/cx/v3/webhook.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.
Defined Under Namespace
Classes: FulfillmentInfo, IntentInfo, SentimentAnalysisResult
Instance Attribute Summary collapse
-
#detect_intent_response_id ⇒ ::String
Always present.
-
#fulfillment_info ⇒ ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::FulfillmentInfo
Always present.
-
#intent_info ⇒ ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo
Information about the last matched intent.
-
#language_code ⇒ ::String
The language code specified in the [original request][QueryInput.language_code].
-
#messages ⇒ ::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>
The list of rich message responses to present to the user.
-
#page_info ⇒ ::Google::Cloud::Dialogflow::CX::V3::PageInfo
Information about page status.
-
#payload ⇒ ::Google::Protobuf::Struct
Custom data set in QueryParameters.payload.
-
#sentiment_analysis_result ⇒ ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::SentimentAnalysisResult
The sentiment analysis result of the current user request.
-
#session_info ⇒ ::Google::Cloud::Dialogflow::CX::V3::SessionInfo
Information about session status.
-
#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 Attribute Details
#detect_intent_response_id ⇒ ::String
Returns Always present. The unique identifier of the DetectIntentResponse that will be returned to the API caller.
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 261 class WebhookRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents fulfillment information communicated to the webhook. # @!attribute [rw] tag # @return [::String] # Always present. The tag used to identify which fulfillment is being # called. class FulfillmentInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Represents intent information communicated to the webhook. # @!attribute [rw] last_matched_intent # @return [::String] # Always present. The unique identifier of the last matched # {::Google::Cloud::Dialogflow::CX::V3::Intent intent}. # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent # ID>/intents/<Intent ID>`. # @!attribute [rw] display_name # @return [::String] # Always present. The display name of the last matched {::Google::Cloud::Dialogflow::CX::V3::Intent intent}. # @!attribute [rw] parameters # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue}] # Parameters identified as a result of intent matching. This is a map of # the name of the identified parameter to the value of the parameter # identified from the user's utterance. All parameters defined in the # matched intent that are identified will be surfaced here. # @!attribute [rw] confidence # @return [::Float] # The confidence of the matched intent. Values range from 0.0 (completely # uncertain) to 1.0 (completely certain). class IntentInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents a value for an intent parameter. # @!attribute [rw] original_value # @return [::String] # Always present. Original text value extracted from user utterance. # @!attribute [rw] resolved_value # @return [::Google::Protobuf::Value] # Always present. Structured value for the parameter extracted from user # utterance. class IntentParameterValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue] class ParametersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Represents the result of sentiment analysis. # @!attribute [rw] score # @return [::Float] # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive # sentiment). # @!attribute [rw] magnitude # @return [::Float] # A non-negative number in the [0, +inf) range, which represents the # absolute magnitude of sentiment, regardless of score (positive or # negative). class SentimentAnalysisResult include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#fulfillment_info ⇒ ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::FulfillmentInfo
Returns Always present. Information about the fulfillment that triggered this webhook call.
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 261 class WebhookRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents fulfillment information communicated to the webhook. # @!attribute [rw] tag # @return [::String] # Always present. The tag used to identify which fulfillment is being # called. class FulfillmentInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Represents intent information communicated to the webhook. # @!attribute [rw] last_matched_intent # @return [::String] # Always present. The unique identifier of the last matched # {::Google::Cloud::Dialogflow::CX::V3::Intent intent}. # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent # ID>/intents/<Intent ID>`. # @!attribute [rw] display_name # @return [::String] # Always present. The display name of the last matched {::Google::Cloud::Dialogflow::CX::V3::Intent intent}. # @!attribute [rw] parameters # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue}] # Parameters identified as a result of intent matching. This is a map of # the name of the identified parameter to the value of the parameter # identified from the user's utterance. All parameters defined in the # matched intent that are identified will be surfaced here. # @!attribute [rw] confidence # @return [::Float] # The confidence of the matched intent. Values range from 0.0 (completely # uncertain) to 1.0 (completely certain). class IntentInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents a value for an intent parameter. # @!attribute [rw] original_value # @return [::String] # Always present. Original text value extracted from user utterance. # @!attribute [rw] resolved_value # @return [::Google::Protobuf::Value] # Always present. Structured value for the parameter extracted from user # utterance. class IntentParameterValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue] class ParametersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Represents the result of sentiment analysis. # @!attribute [rw] score # @return [::Float] # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive # sentiment). # @!attribute [rw] magnitude # @return [::Float] # A non-negative number in the [0, +inf) range, which represents the # absolute magnitude of sentiment, regardless of score (positive or # negative). class SentimentAnalysisResult include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#intent_info ⇒ ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo
Returns Information about the last matched intent.
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 261 class WebhookRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents fulfillment information communicated to the webhook. # @!attribute [rw] tag # @return [::String] # Always present. The tag used to identify which fulfillment is being # called. class FulfillmentInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Represents intent information communicated to the webhook. # @!attribute [rw] last_matched_intent # @return [::String] # Always present. The unique identifier of the last matched # {::Google::Cloud::Dialogflow::CX::V3::Intent intent}. # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent # ID>/intents/<Intent ID>`. # @!attribute [rw] display_name # @return [::String] # Always present. The display name of the last matched {::Google::Cloud::Dialogflow::CX::V3::Intent intent}. # @!attribute [rw] parameters # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue}] # Parameters identified as a result of intent matching. This is a map of # the name of the identified parameter to the value of the parameter # identified from the user's utterance. All parameters defined in the # matched intent that are identified will be surfaced here. # @!attribute [rw] confidence # @return [::Float] # The confidence of the matched intent. Values range from 0.0 (completely # uncertain) to 1.0 (completely certain). class IntentInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents a value for an intent parameter. # @!attribute [rw] original_value # @return [::String] # Always present. Original text value extracted from user utterance. # @!attribute [rw] resolved_value # @return [::Google::Protobuf::Value] # Always present. Structured value for the parameter extracted from user # utterance. class IntentParameterValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue] class ParametersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Represents the result of sentiment analysis. # @!attribute [rw] score # @return [::Float] # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive # sentiment). # @!attribute [rw] magnitude # @return [::Float] # A non-negative number in the [0, +inf) range, which represents the # absolute magnitude of sentiment, regardless of score (positive or # negative). class SentimentAnalysisResult include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#language_code ⇒ ::String
Returns The language code specified in the [original request][QueryInput.language_code].
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 261 class WebhookRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents fulfillment information communicated to the webhook. # @!attribute [rw] tag # @return [::String] # Always present. The tag used to identify which fulfillment is being # called. class FulfillmentInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Represents intent information communicated to the webhook. # @!attribute [rw] last_matched_intent # @return [::String] # Always present. The unique identifier of the last matched # {::Google::Cloud::Dialogflow::CX::V3::Intent intent}. # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent # ID>/intents/<Intent ID>`. # @!attribute [rw] display_name # @return [::String] # Always present. The display name of the last matched {::Google::Cloud::Dialogflow::CX::V3::Intent intent}. # @!attribute [rw] parameters # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue}] # Parameters identified as a result of intent matching. This is a map of # the name of the identified parameter to the value of the parameter # identified from the user's utterance. All parameters defined in the # matched intent that are identified will be surfaced here. # @!attribute [rw] confidence # @return [::Float] # The confidence of the matched intent. Values range from 0.0 (completely # uncertain) to 1.0 (completely certain). class IntentInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents a value for an intent parameter. # @!attribute [rw] original_value # @return [::String] # Always present. Original text value extracted from user utterance. # @!attribute [rw] resolved_value # @return [::Google::Protobuf::Value] # Always present. Structured value for the parameter extracted from user # utterance. class IntentParameterValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue] class ParametersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Represents the result of sentiment analysis. # @!attribute [rw] score # @return [::Float] # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive # sentiment). # @!attribute [rw] magnitude # @return [::Float] # A non-negative number in the [0, +inf) range, which represents the # absolute magnitude of sentiment, regardless of score (positive or # negative). class SentimentAnalysisResult include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#messages ⇒ ::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>
Returns The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response;.
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 261 class WebhookRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents fulfillment information communicated to the webhook. # @!attribute [rw] tag # @return [::String] # Always present. The tag used to identify which fulfillment is being # called. class FulfillmentInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Represents intent information communicated to the webhook. # @!attribute [rw] last_matched_intent # @return [::String] # Always present. The unique identifier of the last matched # {::Google::Cloud::Dialogflow::CX::V3::Intent intent}. # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent # ID>/intents/<Intent ID>`. # @!attribute [rw] display_name # @return [::String] # Always present. The display name of the last matched {::Google::Cloud::Dialogflow::CX::V3::Intent intent}. # @!attribute [rw] parameters # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue}] # Parameters identified as a result of intent matching. This is a map of # the name of the identified parameter to the value of the parameter # identified from the user's utterance. All parameters defined in the # matched intent that are identified will be surfaced here. # @!attribute [rw] confidence # @return [::Float] # The confidence of the matched intent. Values range from 0.0 (completely # uncertain) to 1.0 (completely certain). class IntentInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents a value for an intent parameter. # @!attribute [rw] original_value # @return [::String] # Always present. Original text value extracted from user utterance. # @!attribute [rw] resolved_value # @return [::Google::Protobuf::Value] # Always present. Structured value for the parameter extracted from user # utterance. class IntentParameterValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue] class ParametersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Represents the result of sentiment analysis. # @!attribute [rw] score # @return [::Float] # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive # sentiment). # @!attribute [rw] magnitude # @return [::Float] # A non-negative number in the [0, +inf) range, which represents the # absolute magnitude of sentiment, regardless of score (positive or # negative). class SentimentAnalysisResult include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#page_info ⇒ ::Google::Cloud::Dialogflow::CX::V3::PageInfo
Returns Information about page status.
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 261 class WebhookRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents fulfillment information communicated to the webhook. # @!attribute [rw] tag # @return [::String] # Always present. The tag used to identify which fulfillment is being # called. class FulfillmentInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Represents intent information communicated to the webhook. # @!attribute [rw] last_matched_intent # @return [::String] # Always present. The unique identifier of the last matched # {::Google::Cloud::Dialogflow::CX::V3::Intent intent}. # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent # ID>/intents/<Intent ID>`. # @!attribute [rw] display_name # @return [::String] # Always present. The display name of the last matched {::Google::Cloud::Dialogflow::CX::V3::Intent intent}. # @!attribute [rw] parameters # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue}] # Parameters identified as a result of intent matching. This is a map of # the name of the identified parameter to the value of the parameter # identified from the user's utterance. All parameters defined in the # matched intent that are identified will be surfaced here. # @!attribute [rw] confidence # @return [::Float] # The confidence of the matched intent. Values range from 0.0 (completely # uncertain) to 1.0 (completely certain). class IntentInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents a value for an intent parameter. # @!attribute [rw] original_value # @return [::String] # Always present. Original text value extracted from user utterance. # @!attribute [rw] resolved_value # @return [::Google::Protobuf::Value] # Always present. Structured value for the parameter extracted from user # utterance. class IntentParameterValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue] class ParametersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Represents the result of sentiment analysis. # @!attribute [rw] score # @return [::Float] # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive # sentiment). # @!attribute [rw] magnitude # @return [::Float] # A non-negative number in the [0, +inf) range, which represents the # absolute magnitude of sentiment, regardless of score (positive or # negative). class SentimentAnalysisResult include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#payload ⇒ ::Google::Protobuf::Struct
Returns Custom data set in QueryParameters.payload.
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 261 class WebhookRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents fulfillment information communicated to the webhook. # @!attribute [rw] tag # @return [::String] # Always present. The tag used to identify which fulfillment is being # called. class FulfillmentInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Represents intent information communicated to the webhook. # @!attribute [rw] last_matched_intent # @return [::String] # Always present. The unique identifier of the last matched # {::Google::Cloud::Dialogflow::CX::V3::Intent intent}. # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent # ID>/intents/<Intent ID>`. # @!attribute [rw] display_name # @return [::String] # Always present. The display name of the last matched {::Google::Cloud::Dialogflow::CX::V3::Intent intent}. # @!attribute [rw] parameters # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue}] # Parameters identified as a result of intent matching. This is a map of # the name of the identified parameter to the value of the parameter # identified from the user's utterance. All parameters defined in the # matched intent that are identified will be surfaced here. # @!attribute [rw] confidence # @return [::Float] # The confidence of the matched intent. Values range from 0.0 (completely # uncertain) to 1.0 (completely certain). class IntentInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents a value for an intent parameter. # @!attribute [rw] original_value # @return [::String] # Always present. Original text value extracted from user utterance. # @!attribute [rw] resolved_value # @return [::Google::Protobuf::Value] # Always present. Structured value for the parameter extracted from user # utterance. class IntentParameterValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue] class ParametersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Represents the result of sentiment analysis. # @!attribute [rw] score # @return [::Float] # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive # sentiment). # @!attribute [rw] magnitude # @return [::Float] # A non-negative number in the [0, +inf) range, which represents the # absolute magnitude of sentiment, regardless of score (positive or # negative). class SentimentAnalysisResult include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#sentiment_analysis_result ⇒ ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::SentimentAnalysisResult
Returns The sentiment analysis result of the current user request. The field is filled when sentiment analysis is configured to be enabled for the request.
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 261 class WebhookRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents fulfillment information communicated to the webhook. # @!attribute [rw] tag # @return [::String] # Always present. The tag used to identify which fulfillment is being # called. class FulfillmentInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Represents intent information communicated to the webhook. # @!attribute [rw] last_matched_intent # @return [::String] # Always present. The unique identifier of the last matched # {::Google::Cloud::Dialogflow::CX::V3::Intent intent}. # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent # ID>/intents/<Intent ID>`. # @!attribute [rw] display_name # @return [::String] # Always present. The display name of the last matched {::Google::Cloud::Dialogflow::CX::V3::Intent intent}. # @!attribute [rw] parameters # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue}] # Parameters identified as a result of intent matching. This is a map of # the name of the identified parameter to the value of the parameter # identified from the user's utterance. All parameters defined in the # matched intent that are identified will be surfaced here. # @!attribute [rw] confidence # @return [::Float] # The confidence of the matched intent. Values range from 0.0 (completely # uncertain) to 1.0 (completely certain). class IntentInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents a value for an intent parameter. # @!attribute [rw] original_value # @return [::String] # Always present. Original text value extracted from user utterance. # @!attribute [rw] resolved_value # @return [::Google::Protobuf::Value] # Always present. Structured value for the parameter extracted from user # utterance. class IntentParameterValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue] class ParametersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Represents the result of sentiment analysis. # @!attribute [rw] score # @return [::Float] # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive # sentiment). # @!attribute [rw] magnitude # @return [::Float] # A non-negative number in the [0, +inf) range, which represents the # absolute magnitude of sentiment, regardless of score (positive or # negative). class SentimentAnalysisResult include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#session_info ⇒ ::Google::Cloud::Dialogflow::CX::V3::SessionInfo
Returns Information about session status.
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 261 class WebhookRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents fulfillment information communicated to the webhook. # @!attribute [rw] tag # @return [::String] # Always present. The tag used to identify which fulfillment is being # called. class FulfillmentInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Represents intent information communicated to the webhook. # @!attribute [rw] last_matched_intent # @return [::String] # Always present. The unique identifier of the last matched # {::Google::Cloud::Dialogflow::CX::V3::Intent intent}. # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent # ID>/intents/<Intent ID>`. # @!attribute [rw] display_name # @return [::String] # Always present. The display name of the last matched {::Google::Cloud::Dialogflow::CX::V3::Intent intent}. # @!attribute [rw] parameters # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue}] # Parameters identified as a result of intent matching. This is a map of # the name of the identified parameter to the value of the parameter # identified from the user's utterance. All parameters defined in the # matched intent that are identified will be surfaced here. # @!attribute [rw] confidence # @return [::Float] # The confidence of the matched intent. Values range from 0.0 (completely # uncertain) to 1.0 (completely certain). class IntentInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents a value for an intent parameter. # @!attribute [rw] original_value # @return [::String] # Always present. Original text value extracted from user utterance. # @!attribute [rw] resolved_value # @return [::Google::Protobuf::Value] # Always present. Structured value for the parameter extracted from user # utterance. class IntentParameterValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue] class ParametersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Represents the result of sentiment analysis. # @!attribute [rw] score # @return [::Float] # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive # sentiment). # @!attribute [rw] magnitude # @return [::Float] # A non-negative number in the [0, +inf) range, which represents the # absolute magnitude of sentiment, regardless of score (positive or # negative). class SentimentAnalysisResult include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#text ⇒ ::String
Returns If natural language text was provided as input, this field will contain a copy of the text.
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 261 class WebhookRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents fulfillment information communicated to the webhook. # @!attribute [rw] tag # @return [::String] # Always present. The tag used to identify which fulfillment is being # called. class FulfillmentInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Represents intent information communicated to the webhook. # @!attribute [rw] last_matched_intent # @return [::String] # Always present. The unique identifier of the last matched # {::Google::Cloud::Dialogflow::CX::V3::Intent intent}. # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent # ID>/intents/<Intent ID>`. # @!attribute [rw] display_name # @return [::String] # Always present. The display name of the last matched {::Google::Cloud::Dialogflow::CX::V3::Intent intent}. # @!attribute [rw] parameters # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue}] # Parameters identified as a result of intent matching. This is a map of # the name of the identified parameter to the value of the parameter # identified from the user's utterance. All parameters defined in the # matched intent that are identified will be surfaced here. # @!attribute [rw] confidence # @return [::Float] # The confidence of the matched intent. Values range from 0.0 (completely # uncertain) to 1.0 (completely certain). class IntentInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents a value for an intent parameter. # @!attribute [rw] original_value # @return [::String] # Always present. Original text value extracted from user utterance. # @!attribute [rw] resolved_value # @return [::Google::Protobuf::Value] # Always present. Structured value for the parameter extracted from user # utterance. class IntentParameterValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue] class ParametersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Represents the result of sentiment analysis. # @!attribute [rw] score # @return [::Float] # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive # sentiment). # @!attribute [rw] magnitude # @return [::Float] # A non-negative number in the [0, +inf) range, which represents the # absolute magnitude of sentiment, regardless of score (positive or # negative). class SentimentAnalysisResult include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#transcript ⇒ ::String
Returns If natural language speech audio was provided as input, this field will contain the transcript for the audio.
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 261 class WebhookRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents fulfillment information communicated to the webhook. # @!attribute [rw] tag # @return [::String] # Always present. The tag used to identify which fulfillment is being # called. class FulfillmentInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Represents intent information communicated to the webhook. # @!attribute [rw] last_matched_intent # @return [::String] # Always present. The unique identifier of the last matched # {::Google::Cloud::Dialogflow::CX::V3::Intent intent}. # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent # ID>/intents/<Intent ID>`. # @!attribute [rw] display_name # @return [::String] # Always present. The display name of the last matched {::Google::Cloud::Dialogflow::CX::V3::Intent intent}. # @!attribute [rw] parameters # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue}] # Parameters identified as a result of intent matching. This is a map of # the name of the identified parameter to the value of the parameter # identified from the user's utterance. All parameters defined in the # matched intent that are identified will be surfaced here. # @!attribute [rw] confidence # @return [::Float] # The confidence of the matched intent. Values range from 0.0 (completely # uncertain) to 1.0 (completely certain). class IntentInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents a value for an intent parameter. # @!attribute [rw] original_value # @return [::String] # Always present. Original text value extracted from user utterance. # @!attribute [rw] resolved_value # @return [::Google::Protobuf::Value] # Always present. Structured value for the parameter extracted from user # utterance. class IntentParameterValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue] class ParametersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Represents the result of sentiment analysis. # @!attribute [rw] score # @return [::Float] # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive # sentiment). # @!attribute [rw] magnitude # @return [::Float] # A non-negative number in the [0, +inf) range, which represents the # absolute magnitude of sentiment, regardless of score (positive or # negative). class SentimentAnalysisResult include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#trigger_event ⇒ ::String
Returns If an event was provided as input, this field will contain the name of the event.
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 261 class WebhookRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents fulfillment information communicated to the webhook. # @!attribute [rw] tag # @return [::String] # Always present. The tag used to identify which fulfillment is being # called. class FulfillmentInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Represents intent information communicated to the webhook. # @!attribute [rw] last_matched_intent # @return [::String] # Always present. The unique identifier of the last matched # {::Google::Cloud::Dialogflow::CX::V3::Intent intent}. # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent # ID>/intents/<Intent ID>`. # @!attribute [rw] display_name # @return [::String] # Always present. The display name of the last matched {::Google::Cloud::Dialogflow::CX::V3::Intent intent}. # @!attribute [rw] parameters # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue}] # Parameters identified as a result of intent matching. This is a map of # the name of the identified parameter to the value of the parameter # identified from the user's utterance. All parameters defined in the # matched intent that are identified will be surfaced here. # @!attribute [rw] confidence # @return [::Float] # The confidence of the matched intent. Values range from 0.0 (completely # uncertain) to 1.0 (completely certain). class IntentInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents a value for an intent parameter. # @!attribute [rw] original_value # @return [::String] # Always present. Original text value extracted from user utterance. # @!attribute [rw] resolved_value # @return [::Google::Protobuf::Value] # Always present. Structured value for the parameter extracted from user # utterance. class IntentParameterValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue] class ParametersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Represents the result of sentiment analysis. # @!attribute [rw] score # @return [::Float] # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive # sentiment). # @!attribute [rw] magnitude # @return [::Float] # A non-negative number in the [0, +inf) range, which represents the # absolute magnitude of sentiment, regardless of score (positive or # negative). class SentimentAnalysisResult include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#trigger_intent ⇒ ::String
Returns If an intent was provided as input, this field will
contain a copy of the intent identifier.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/intents/<Intent ID>.
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 261 class WebhookRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents fulfillment information communicated to the webhook. # @!attribute [rw] tag # @return [::String] # Always present. The tag used to identify which fulfillment is being # called. class FulfillmentInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Represents intent information communicated to the webhook. # @!attribute [rw] last_matched_intent # @return [::String] # Always present. The unique identifier of the last matched # {::Google::Cloud::Dialogflow::CX::V3::Intent intent}. # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent # ID>/intents/<Intent ID>`. # @!attribute [rw] display_name # @return [::String] # Always present. The display name of the last matched {::Google::Cloud::Dialogflow::CX::V3::Intent intent}. # @!attribute [rw] parameters # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue}] # Parameters identified as a result of intent matching. This is a map of # the name of the identified parameter to the value of the parameter # identified from the user's utterance. All parameters defined in the # matched intent that are identified will be surfaced here. # @!attribute [rw] confidence # @return [::Float] # The confidence of the matched intent. Values range from 0.0 (completely # uncertain) to 1.0 (completely certain). class IntentInfo include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents a value for an intent parameter. # @!attribute [rw] original_value # @return [::String] # Always present. Original text value extracted from user utterance. # @!attribute [rw] resolved_value # @return [::Google::Protobuf::Value] # Always present. Structured value for the parameter extracted from user # utterance. class IntentParameterValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Cloud::Dialogflow::CX::V3::WebhookRequest::IntentInfo::IntentParameterValue] class ParametersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Represents the result of sentiment analysis. # @!attribute [rw] score # @return [::Float] # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive # sentiment). # @!attribute [rw] magnitude # @return [::Float] # A non-negative number in the [0, +inf) range, which represents the # absolute magnitude of sentiment, regardless of score (positive or # negative). class SentimentAnalysisResult include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |