Class: Google::Cloud::DataQnA::V1alpha::SuggestionInfo

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dataqna/v1alpha/auto_suggestion_service.rb

Overview

Detailed information about the suggestion.

Defined Under Namespace

Classes: MatchInfo

Instance Attribute Summary collapse

Instance Attribute Details

#annotated_suggestion ⇒ ::Google::Cloud::DataQnA::V1alpha::AnnotatedString

Returns Annotations for the suggestion. This provides information about which part of the suggestion corresponds to what semantic meaning (e.g. a metric).

Returns:



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
 
# File 'proto_docs/google/cloud/dataqna/v1alpha/auto_suggestion_service.rb', line 77

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

  # MatchInfo describes which part of suggestion matched with data in user
  # typed query. This can be used to highlight matching parts in the UI. This
  # is different from the annotations provided in annotated_suggestion. The
  # annotated_suggestion provides information about the semantic meaning, while
  # this provides information about how it relates to the input.
  #
  # Example:
  # user query: `top products`
  #
  # ```
  # annotated_suggestion {
  #  text_formatted = "top product_group"
  #  html_formatted = "top <b>product_group</b>"
  #  markups {
  #   \\{type: TEXT, start_char_index: 0, length: 3}
  #   \\{type: DIMENSION, start_char_index: 4, length: 13}
  #  }
  # }
  #
  # query_matches {
  #  { start_char_index: 0, length: 3 }
  #  { start_char_index: 4, length: 7}
  # }
  # ```
  # @!attribute [rw] start_char_index
  #   @return [::Integer]
  #     Unicode character index of the string annotation.
  # @!attribute [rw] length
  #   @return [::Integer]
  #     Count of unicode characters of this substring.
  class MatchInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#query_matches ⇒ ::Array<::Google::Cloud::DataQnA::V1alpha::SuggestionInfo::MatchInfo>

Returns Matches between user query and the annotated string.

Returns:



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
 
# File 'proto_docs/google/cloud/dataqna/v1alpha/auto_suggestion_service.rb', line 77

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

  # MatchInfo describes which part of suggestion matched with data in user
  # typed query. This can be used to highlight matching parts in the UI. This
  # is different from the annotations provided in annotated_suggestion. The
  # annotated_suggestion provides information about the semantic meaning, while
  # this provides information about how it relates to the input.
  #
  # Example:
  # user query: `top products`
  #
  # ```
  # annotated_suggestion {
  #  text_formatted = "top product_group"
  #  html_formatted = "top <b>product_group</b>"
  #  markups {
  #   \\{type: TEXT, start_char_index: 0, length: 3}
  #   \\{type: DIMENSION, start_char_index: 4, length: 13}
  #  }
  # }
  #
  # query_matches {
  #  { start_char_index: 0, length: 3 }
  #  { start_char_index: 4, length: 7}
  # }
  # ```
  # @!attribute [rw] start_char_index
  #   @return [::Integer]
  #     Unicode character index of the string annotation.
  # @!attribute [rw] length
  #   @return [::Integer]
  #     Count of unicode characters of this substring.
  class MatchInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end