proto_docs/google/cloud/dialogflow/v2/webhook.rb in google-cloud-dialogflow-v2-0.20.0 vs proto_docs/google/cloud/dialogflow/v2/webhook.rb in google-cloud-dialogflow-v2-0.21.0
- old
+ new
@@ -47,13 +47,14 @@
end
# The response message for a webhook call.
#
# This response is validated by the Dialogflow server. If validation fails,
- # an error will be returned in the {::Google::Cloud::Dialogflow::V2::QueryResult#diagnostic_info QueryResult.diagnostic_info} field.
- # Setting JSON fields to an empty value with the wrong type is a common error.
- # To avoid this error:
+ # an error will be returned in the
+ # {::Google::Cloud::Dialogflow::V2::QueryResult#diagnostic_info QueryResult.diagnostic_info}
+ # field. Setting JSON fields to an empty value with the wrong type is a common
+ # error. To avoid this error:
#
# - Use `""` for empty strings
# - Use `{}` or `null` for empty objects
# - Use `[]` or `null` for empty arrays
#
@@ -63,40 +64,44 @@
# @!attribute [rw] fulfillment_text
# @return [::String]
# Optional. The text response message intended for the end-user.
# It is recommended to use `fulfillment_messages.text.text[0]` instead.
# When provided, Dialogflow uses this field to populate
- # {::Google::Cloud::Dialogflow::V2::QueryResult#fulfillment_text QueryResult.fulfillment_text} sent to the integration or API caller.
+ # {::Google::Cloud::Dialogflow::V2::QueryResult#fulfillment_text QueryResult.fulfillment_text}
+ # sent to the integration or API caller.
# @!attribute [rw] fulfillment_messages
# @return [::Array<::Google::Cloud::Dialogflow::V2::Intent::Message>]
# Optional. The rich response messages intended for the end-user.
# When provided, Dialogflow uses this field to populate
- # {::Google::Cloud::Dialogflow::V2::QueryResult#fulfillment_messages QueryResult.fulfillment_messages} sent to the integration or API caller.
+ # {::Google::Cloud::Dialogflow::V2::QueryResult#fulfillment_messages QueryResult.fulfillment_messages}
+ # sent to the integration or API caller.
# @!attribute [rw] source
# @return [::String]
# Optional. A custom field used to identify the webhook source.
# Arbitrary strings are supported.
# When provided, Dialogflow uses this field to populate
- # {::Google::Cloud::Dialogflow::V2::QueryResult#webhook_source QueryResult.webhook_source} sent to the integration or API caller.
+ # {::Google::Cloud::Dialogflow::V2::QueryResult#webhook_source QueryResult.webhook_source}
+ # sent to the integration or API caller.
# @!attribute [rw] payload
# @return [::Google::Protobuf::Struct]
- # Optional. This field can be used to pass custom data from your webhook to the
- # integration or API caller. Arbitrary JSON objects are supported.
- # When provided, Dialogflow uses this field to populate
- # {::Google::Cloud::Dialogflow::V2::QueryResult#webhook_payload QueryResult.webhook_payload} sent to the integration or API caller.
- # This field is also used by the
+ # Optional. This field can be used to pass custom data from your webhook to
+ # the integration or API caller. Arbitrary JSON objects are supported. When
+ # provided, Dialogflow uses this field to populate
+ # {::Google::Cloud::Dialogflow::V2::QueryResult#webhook_payload QueryResult.webhook_payload}
+ # sent to the integration or 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 that will overwrite currently
# active contexts for the session and reset their lifespans.
# When provided, Dialogflow uses this field to populate
- # {::Google::Cloud::Dialogflow::V2::QueryResult#output_contexts QueryResult.output_contexts} sent to the integration or API caller.
+ # {::Google::Cloud::Dialogflow::V2::QueryResult#output_contexts QueryResult.output_contexts}
+ # sent to the integration or API caller.
# @!attribute [rw] followup_event_input
# @return [::Google::Cloud::Dialogflow::V2::EventInput]
# Optional. Invokes the supplied events.
# When this field is set, Dialogflow ignores the `fulfillment_text`,
# `fulfillment_messages`, and `payload` fields.
@@ -104,10 +109,12 @@
# @return [::Array<::Google::Cloud::Dialogflow::V2::SessionEntityType>]
# Optional. Additional session entity types to replace or extend developer
# entity types with. The entity synonyms apply to all languages and persist
# for the session. Setting this data from a webhook overwrites
# the session entity types that have been set using `detectIntent`,
- # `streamingDetectIntent` or {::Google::Cloud::Dialogflow::V2::SessionEntityType SessionEntityType} management methods.
+ # `streamingDetectIntent` or
+ # {::Google::Cloud::Dialogflow::V2::SessionEntityType SessionEntityType}
+ # management methods.
class WebhookResponse
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end