Class: Google::Cloud::Dialogflow::V2::Fulfillment

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/v2/fulfillment.rb

Overview

By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday.

For more information, see the fulfillment guide.

Defined Under Namespace

Classes: Feature, GenericWebService

Instance Attribute Summary collapse

Instance Attribute Details

#display_name ⇒ ::String

Returns Optional. The human-readable name of the fulfillment, unique within the agent.

This field is not used for Fulfillment in an Environment.

Returns:

  • (::String) —

    Optional. The human-readable name of the fulfillment, unique within the agent.

    This field is not used for Fulfillment in an Environment.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'proto_docs/google/cloud/dialogflow/v2/fulfillment.rb', line 59

class Fulfillment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents configuration for a generic web service.
  # Dialogflow supports two mechanisms for authentications:
  #
  # - Basic authentication with username and password.
  # - Authentication with additional authentication headers.
  #
  # More information could be found at:
  # https://cloud.google.com/dialogflow/docs/fulfillment-configure.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Required. The fulfillment URI for receiving POST requests.
  #     It must use https protocol.
  # @!attribute [rw] username
  #   @return [::String]
  #     Optional. The user name for HTTP Basic authentication.
  # @!attribute [rw] password
  #   @return [::String]
  #     Optional. The password for HTTP Basic authentication.
  # @!attribute [rw] request_headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The HTTP request headers to send together with fulfillment
  #     requests.
  # @!attribute [rw] is_cloud_function
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. Indicates if generic web service is created through Cloud
  #     Functions integration. Defaults to false.
  #
  #     is_cloud_function is deprecated. Cloud functions can be configured by
  #     its uri as a regular web service now.
  class GenericWebService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class RequestHeadersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Whether fulfillment is enabled for the specific feature.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Dialogflow::V2::Fulfillment::Feature::Type]
  #     The type of the feature that enabled for fulfillment.
  class Feature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of the feature.
    module Type
      # Feature type not specified.
      TYPE_UNSPECIFIED = 0

      # Fulfillment is enabled for SmallTalk.
      SMALLTALK = 1
    end
  end
end

#enabled ⇒ ::Boolean

Returns Optional. Whether fulfillment is enabled.

Returns:

  • (::Boolean) —

    Optional. Whether fulfillment is enabled.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'proto_docs/google/cloud/dialogflow/v2/fulfillment.rb', line 59

class Fulfillment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents configuration for a generic web service.
  # Dialogflow supports two mechanisms for authentications:
  #
  # - Basic authentication with username and password.
  # - Authentication with additional authentication headers.
  #
  # More information could be found at:
  # https://cloud.google.com/dialogflow/docs/fulfillment-configure.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Required. The fulfillment URI for receiving POST requests.
  #     It must use https protocol.
  # @!attribute [rw] username
  #   @return [::String]
  #     Optional. The user name for HTTP Basic authentication.
  # @!attribute [rw] password
  #   @return [::String]
  #     Optional. The password for HTTP Basic authentication.
  # @!attribute [rw] request_headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The HTTP request headers to send together with fulfillment
  #     requests.
  # @!attribute [rw] is_cloud_function
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. Indicates if generic web service is created through Cloud
  #     Functions integration. Defaults to false.
  #
  #     is_cloud_function is deprecated. Cloud functions can be configured by
  #     its uri as a regular web service now.
  class GenericWebService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class RequestHeadersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Whether fulfillment is enabled for the specific feature.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Dialogflow::V2::Fulfillment::Feature::Type]
  #     The type of the feature that enabled for fulfillment.
  class Feature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of the feature.
    module Type
      # Feature type not specified.
      TYPE_UNSPECIFIED = 0

      # Fulfillment is enabled for SmallTalk.
      SMALLTALK = 1
    end
  end
end

#features ⇒ ::Array<::Google::Cloud::Dialogflow::V2::Fulfillment::Feature>

Returns Optional. The field defines whether the fulfillment is enabled for certain features.

Returns:



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'proto_docs/google/cloud/dialogflow/v2/fulfillment.rb', line 59

class Fulfillment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents configuration for a generic web service.
  # Dialogflow supports two mechanisms for authentications:
  #
  # - Basic authentication with username and password.
  # - Authentication with additional authentication headers.
  #
  # More information could be found at:
  # https://cloud.google.com/dialogflow/docs/fulfillment-configure.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Required. The fulfillment URI for receiving POST requests.
  #     It must use https protocol.
  # @!attribute [rw] username
  #   @return [::String]
  #     Optional. The user name for HTTP Basic authentication.
  # @!attribute [rw] password
  #   @return [::String]
  #     Optional. The password for HTTP Basic authentication.
  # @!attribute [rw] request_headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The HTTP request headers to send together with fulfillment
  #     requests.
  # @!attribute [rw] is_cloud_function
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. Indicates if generic web service is created through Cloud
  #     Functions integration. Defaults to false.
  #
  #     is_cloud_function is deprecated. Cloud functions can be configured by
  #     its uri as a regular web service now.
  class GenericWebService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class RequestHeadersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Whether fulfillment is enabled for the specific feature.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Dialogflow::V2::Fulfillment::Feature::Type]
  #     The type of the feature that enabled for fulfillment.
  class Feature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of the feature.
    module Type
      # Feature type not specified.
      TYPE_UNSPECIFIED = 0

      # Fulfillment is enabled for SmallTalk.
      SMALLTALK = 1
    end
  end
end

#generic_web_service ⇒ ::Google::Cloud::Dialogflow::V2::Fulfillment::GenericWebService

Returns Configuration for a generic web service.

Returns:



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'proto_docs/google/cloud/dialogflow/v2/fulfillment.rb', line 59

class Fulfillment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents configuration for a generic web service.
  # Dialogflow supports two mechanisms for authentications:
  #
  # - Basic authentication with username and password.
  # - Authentication with additional authentication headers.
  #
  # More information could be found at:
  # https://cloud.google.com/dialogflow/docs/fulfillment-configure.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Required. The fulfillment URI for receiving POST requests.
  #     It must use https protocol.
  # @!attribute [rw] username
  #   @return [::String]
  #     Optional. The user name for HTTP Basic authentication.
  # @!attribute [rw] password
  #   @return [::String]
  #     Optional. The password for HTTP Basic authentication.
  # @!attribute [rw] request_headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The HTTP request headers to send together with fulfillment
  #     requests.
  # @!attribute [rw] is_cloud_function
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. Indicates if generic web service is created through Cloud
  #     Functions integration. Defaults to false.
  #
  #     is_cloud_function is deprecated. Cloud functions can be configured by
  #     its uri as a regular web service now.
  class GenericWebService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class RequestHeadersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Whether fulfillment is enabled for the specific feature.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Dialogflow::V2::Fulfillment::Feature::Type]
  #     The type of the feature that enabled for fulfillment.
  class Feature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of the feature.
    module Type
      # Feature type not specified.
      TYPE_UNSPECIFIED = 0

      # Fulfillment is enabled for SmallTalk.
      SMALLTALK = 1
    end
  end
end

#name ⇒ ::String

Returns Required. The unique identifier of the fulfillment. Supported formats:

  • projects/<Project ID>/agent/fulfillment
  • projects/<Project ID>/locations/<Location ID>/agent/fulfillment

This field is not used for Fulfillment in an Environment.

Returns:

  • (::String) —

    Required. The unique identifier of the fulfillment. Supported formats:

    • projects/<Project ID>/agent/fulfillment
    • projects/<Project ID>/locations/<Location ID>/agent/fulfillment

    This field is not used for Fulfillment in an Environment.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'proto_docs/google/cloud/dialogflow/v2/fulfillment.rb', line 59

class Fulfillment
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents configuration for a generic web service.
  # Dialogflow supports two mechanisms for authentications:
  #
  # - Basic authentication with username and password.
  # - Authentication with additional authentication headers.
  #
  # More information could be found at:
  # https://cloud.google.com/dialogflow/docs/fulfillment-configure.
  # @!attribute [rw] uri
  #   @return [::String]
  #     Required. The fulfillment URI for receiving POST requests.
  #     It must use https protocol.
  # @!attribute [rw] username
  #   @return [::String]
  #     Optional. The user name for HTTP Basic authentication.
  # @!attribute [rw] password
  #   @return [::String]
  #     Optional. The password for HTTP Basic authentication.
  # @!attribute [rw] request_headers
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. The HTTP request headers to send together with fulfillment
  #     requests.
  # @!attribute [rw] is_cloud_function
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. Indicates if generic web service is created through Cloud
  #     Functions integration. Defaults to false.
  #
  #     is_cloud_function is deprecated. Cloud functions can be configured by
  #     its uri as a regular web service now.
  class GenericWebService
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class RequestHeadersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Whether fulfillment is enabled for the specific feature.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Dialogflow::V2::Fulfillment::Feature::Type]
  #     The type of the feature that enabled for fulfillment.
  class Feature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of the feature.
    module Type
      # Feature type not specified.
      TYPE_UNSPECIFIED = 0

      # Fulfillment is enabled for SmallTalk.
      SMALLTALK = 1
    end
  end
end