Class: Google::Cloud::Dialogflow::CX::V3::WebhookRequest

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

You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.

Defined Under Namespace

Classes: FulfillmentInfo, IntentInfo, SentimentAnalysisResult

Instance Attribute Summary collapse

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.

Returns:

  • (::String) —

    Always present. The unique identifier of the DetectIntentResponse that will be returned to the API caller.



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 406

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 value of the
  #     {::Google::Cloud::Dialogflow::CX::V3::Fulfillment#tag Fulfillment.tag} field
  #     will be populated in this field by Dialogflow when the associated webhook
  #     is called. The tag is typically used by the webhook service to identify
  #     which fulfillment is being called, but it could be used for other
  #     purposes.
  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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
  # @!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

#dtmf_digits ⇒ ::String

Returns If DTMF was provided as input, this field will contain the DTMF digits.

Returns:

  • (::String) —

    If DTMF was provided as input, this field will contain the DTMF digits.



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 406

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 value of the
  #     {::Google::Cloud::Dialogflow::CX::V3::Fulfillment#tag Fulfillment.tag} field
  #     will be populated in this field by Dialogflow when the associated webhook
  #     is called. The tag is typically used by the webhook service to identify
  #     which fulfillment is being called, but it could be used for other
  #     purposes.
  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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
  # @!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.

Returns:



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 406

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 value of the
  #     {::Google::Cloud::Dialogflow::CX::V3::Fulfillment#tag Fulfillment.tag} field
  #     will be populated in this field by Dialogflow when the associated webhook
  #     is called. The tag is typically used by the webhook service to identify
  #     which fulfillment is being called, but it could be used for other
  #     purposes.
  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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
  # @!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.

Returns:



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 406

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 value of the
  #     {::Google::Cloud::Dialogflow::CX::V3::Fulfillment#tag Fulfillment.tag} field
  #     will be populated in this field by Dialogflow when the associated webhook
  #     is called. The tag is typically used by the webhook service to identify
  #     which fulfillment is being called, but it could be used for other
  #     purposes.
  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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
  # @!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].

Returns:

  • (::String) —

    The language code specified in the [original request][QueryInput.language_code].



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 406

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 value of the
  #     {::Google::Cloud::Dialogflow::CX::V3::Fulfillment#tag Fulfillment.tag} field
  #     will be populated in this field by Dialogflow when the associated webhook
  #     is called. The tag is typically used by the webhook service to identify
  #     which fulfillment is being called, but it could be used for other
  #     purposes.
  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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
  # @!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_info ⇒ ::Google::Cloud::Dialogflow::CX::V3::LanguageInfo

Returns Information about the language of the request.

Returns:



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 406

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 value of the
  #     {::Google::Cloud::Dialogflow::CX::V3::Fulfillment#tag Fulfillment.tag} field
  #     will be populated in this field by Dialogflow when the associated webhook
  #     is called. The tag is typically used by the webhook service to identify
  #     which fulfillment is being called, but it could be used for other
  #     purposes.
  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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
  # @!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;.

Returns:



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 406

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 value of the
  #     {::Google::Cloud::Dialogflow::CX::V3::Fulfillment#tag Fulfillment.tag} field
  #     will be populated in this field by Dialogflow when the associated webhook
  #     is called. The tag is typically used by the webhook service to identify
  #     which fulfillment is being called, but it could be used for other
  #     purposes.
  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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
  # @!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.

Returns:



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 406

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 value of the
  #     {::Google::Cloud::Dialogflow::CX::V3::Fulfillment#tag Fulfillment.tag} field
  #     will be populated in this field by Dialogflow when the associated webhook
  #     is called. The tag is typically used by the webhook service to identify
  #     which fulfillment is being called, but it could be used for other
  #     purposes.
  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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
  # @!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.

Returns:



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 406

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 value of the
  #     {::Google::Cloud::Dialogflow::CX::V3::Fulfillment#tag Fulfillment.tag} field
  #     will be populated in this field by Dialogflow when the associated webhook
  #     is called. The tag is typically used by the webhook service to identify
  #     which fulfillment is being called, but it could be used for other
  #     purposes.
  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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
  # @!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.

Returns:



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 406

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 value of the
  #     {::Google::Cloud::Dialogflow::CX::V3::Fulfillment#tag Fulfillment.tag} field
  #     will be populated in this field by Dialogflow when the associated webhook
  #     is called. The tag is typically used by the webhook service to identify
  #     which fulfillment is being called, but it could be used for other
  #     purposes.
  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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
  # @!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.

Returns:



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 406

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 value of the
  #     {::Google::Cloud::Dialogflow::CX::V3::Fulfillment#tag Fulfillment.tag} field
  #     will be populated in this field by Dialogflow when the associated webhook
  #     is called. The tag is typically used by the webhook service to identify
  #     which fulfillment is being called, but it could be used for other
  #     purposes.
  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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
  # @!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.

Returns:

  • (::String) —

    If natural language text was provided as input, this field will contain a copy of the text.



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 406

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 value of the
  #     {::Google::Cloud::Dialogflow::CX::V3::Fulfillment#tag Fulfillment.tag} field
  #     will be populated in this field by Dialogflow when the associated webhook
  #     is called. The tag is typically used by the webhook service to identify
  #     which fulfillment is being called, but it could be used for other
  #     purposes.
  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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
  # @!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][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input, this field will contain the transcript for the audio.

Returns:

  • (::String) —

    If [natural language speech audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input, this field will contain the transcript for the audio.



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 406

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 value of the
  #     {::Google::Cloud::Dialogflow::CX::V3::Fulfillment#tag Fulfillment.tag} field
  #     will be populated in this field by Dialogflow when the associated webhook
  #     is called. The tag is typically used by the webhook service to identify
  #     which fulfillment is being called, but it could be used for other
  #     purposes.
  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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
  # @!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.

Returns:

  • (::String) —

    If an event was provided as input, this field will contain the name of the event.



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 406

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 value of the
  #     {::Google::Cloud::Dialogflow::CX::V3::Fulfillment#tag Fulfillment.tag} field
  #     will be populated in this field by Dialogflow when the associated webhook
  #     is called. The tag is typically used by the webhook service to identify
  #     which fulfillment is being called, but it could be used for other
  #     purposes.
  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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
  # @!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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>.

Returns:

  • (::String) —

    If an intent was provided as input, this field will contain a copy of the intent identifier. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>.



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 406

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 value of the
  #     {::Google::Cloud::Dialogflow::CX::V3::Fulfillment#tag Fulfillment.tag} field
  #     will be populated in this field by Dialogflow when the associated webhook
  #     is called. The tag is typically used by the webhook service to identify
  #     which fulfillment is being called, but it could be used for other
  #     purposes.
  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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
  # @!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