Struct gapi_grpc::google::cloud::dataqna::v1alpha::suggestion_info::MatchInfo

pub struct MatchInfo {
    pub start_char_index: i32,
    pub length: i32,
}

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

Fields

start_char_index: i32

Unicode character index of the string annotation.

length: i32

Count of unicode characters of this substring.

Trait Implementations

impl Clone for MatchInfo

fn clone(&self) -> MatchInfo

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MatchInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MatchInfo

fn default() -> MatchInfo

Returns the “default value” for a type.

impl Message for MatchInfo

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<MatchInfo> for MatchInfo

fn eq(&self, other: &MatchInfo) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &MatchInfo) -> bool

This method tests for !=.

impl StructuralPartialEq for MatchInfo