BigQuery Data QnA V1alpha API - Class Google::Cloud::DataQnA::V1alpha::SuggestionInfo::MatchInfo (v0.3.0)

Reference documentation and code samples for the BigQuery Data QnA V1alpha API class Google::Cloud::DataQnA::V1alpha::SuggestionInfo::MatchInfo.

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 product_group" 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} } ```

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#length

def length() -> ::Integer
Returns
  • (::Integer) — Count of unicode characters of this substring.

#length=

def length=(value) -> ::Integer
Parameter
  • value (::Integer) — Count of unicode characters of this substring.
Returns
  • (::Integer) — Count of unicode characters of this substring.

#start_char_index

def start_char_index() -> ::Integer
Returns
  • (::Integer) — Unicode character index of the string annotation.

#start_char_index=

def start_char_index=(value) -> ::Integer
Parameter
  • value (::Integer) — Unicode character index of the string annotation.
Returns
  • (::Integer) — Unicode character index of the string annotation.