proto_docs/google/cloud/dialogflow/cx/v3/session.rb in google-cloud-dialogflow-cx-v3-0.8.0 vs proto_docs/google/cloud/dialogflow/cx/v3/session.rb in google-cloud-dialogflow-cx-v3-0.8.1
- old
+ new
@@ -535,11 +535,25 @@
# @return [::Google::Cloud::Dialogflow::CX::V3::Match]
# Intent match result, could be an intent or an event.
# @!attribute [rw] diagnostic_info
# @return [::Google::Protobuf::Struct]
# The free-form diagnostic info. For example, this field could contain
- # webhook call latency. The string keys of the Struct's fields map can change
- # without notice.
+ # webhook call latency. The fields of this data can change without notice,
+ # so you should not write code that depends on its structure.
+ #
+ # One of the fields is called "Alternative Matched Intents", which may
+ # aid with debugging. The following describes these intent results:
+ #
+ # - The list is empty if no intent was matched to end-user input.
+ # - Only intents that are referenced in the currently active flow are
+ # included.
+ # - The matched intent is included.
+ # - Other intents that could have matched end-user input, but did not match
+ # because they are referenced by intent routes that are out of
+ # [scope](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope),
+ # are included.
+ # - Other intents referenced by intent routes in scope that matched end-user
+ # input, but had a lower confidence score.
# @!attribute [rw] sentiment_analysis_result
# @return [::Google::Cloud::Dialogflow::CX::V3::SentimentAnalysisResult]
# The sentiment analyss result, which depends on
# [`analyze_query_text_sentiment`]
# [google.cloud.dialogflow.cx.v3.QueryParameters.analyze_query_text_sentiment], specified in the request.