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

Inherits:

Object

Object
Google::Cloud::DataQnA::V1alpha::SuggestionInfo::MatchInfo

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/dataqna/v1alpha/auto_suggestion_service.rb

Overview

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}
}

Instance Attribute Summary collapse

#length ⇒ ::Integer
Count of unicode characters of this substring.
#start_char_index ⇒ ::Integer
Unicode character index of the string annotation.

Instance Attribute Details

#length ⇒ `::Integer`

Returns Count of unicode characters of this substring.

Returns:

(::Integer) —
Count of unicode characters of this substring.

# File 'proto_docs/google/cloud/dataqna/v1alpha/auto_suggestion_service.rb', line 111

class MatchInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#start_char_index ⇒ `::Integer`

Returns Unicode character index of the string annotation.