proto_docs/google/cloud/dialogflow/v2/webhook.rb in google-cloud-dialogflow-v2-0.2.2 vs proto_docs/google/cloud/dialogflow/v2/webhook.rb in google-cloud-dialogflow-v2-0.3.0
- old
+ new
@@ -71,33 +71,20 @@
# @!attribute [rw] source
# @return [String]
# Optional. This value is passed directly to `QueryResult.webhook_source`.
# @!attribute [rw] payload
# @return [Google::Protobuf::Struct]
- # Optional. This value is passed directly to `QueryResult.webhook_payload`.
- # See the related `fulfillment_messages[i].payload field`, which may be used
- # as an alternative to this field.
- #
- # This field can be used for Actions on Google responses.
- # It should have a structure similar to the JSON message shown here. For more
- # information, see
- # [Actions on Google Webhook
- # Format](https://developers.google.com/actions/dialogflow/webhook)
- # <pre>{
- # "google": {
- # "expectUserResponse": true,
- # "richResponse": {
- # "items": [
- # {
- # "simpleResponse": {
- # "textToSpeech": "this is a simple response"
- # }
- # }
- # ]
- # }
- # }
- # }</pre>
+ # Optional. This field can be used to pass custom data from your webhook to the API
+ # caller. Arbitrary JSON objects are supported.
+ # When provided, Dialogflow uses this field to populate
+ # `QueryResult.webhook_payload` sent to the API caller.
+ # This field is also used by the
+ # [Google Assistant
+ # integration](https://cloud.google.com/dialogflow/docs/integrations/aog)
+ # for rich response messages.
+ # See the format definition at [Google Assistant Dialogflow webhook
+ # format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)
# @!attribute [rw] output_contexts
# @return [Array<Google::Cloud::Dialogflow::V2::Context>]
# Optional. The collection of output contexts. This value is passed directly
# to `QueryResult.output_contexts`.
# @!attribute [rw] followup_event_input
@@ -132,10 +119,11 @@
# @return [Google::Protobuf::Struct]
# Optional. This field is set to the value of the `QueryParameters.payload`
# field passed in the request. Some integrations that query a Dialogflow
# agent may provide additional information in the payload.
#
- # In particular for the Telephony Gateway this field has the form:
+ # In particular, for the Dialogflow Phone Gateway integration, this field has
+ # the form:
# <pre>{
# "telephony": {
# "caller_id": "+18558363987"
# }
# }</pre>