Struct google_api_proto::google::cloud::dataqna::v1alpha::AnnotatedString

pub struct AnnotatedString {
    pub text_formatted: String,
    pub html_formatted: String,
    pub markups: Vec<SemanticMarkup>,
}

Describes string annotation from both semantic and formatting perspectives. Example:

User Query:

top countries by population in Africa

0 4 14 17 28 31 37

Table Data:

• “country” - dimension
• “population” - metric
• “Africa” - value in the “continent” column

text_formatted = "top countries by population in Africa"

html_formatted = "top <b>countries</b> by <b>population</b> in <i>Africa</i>"

markups = [
   {DIMENSION, 4, 12}, // 'countries'
   {METRIC, 17, 26}, // 'population'
   {FILTER, 31, 36}  // 'Africa'
]

Note that html formattings for ‘DIMENSION’ and ‘METRIC’ are the same, while semantic markups are different.

Fields

text_formatted: String

Text version of the string.

html_formatted: String

HTML version of the string annotation.

markups: Vec<SemanticMarkup>

Semantic version of the string annotation.

Trait Implementations

impl Clone for AnnotatedString

fn clone(&self) -> AnnotatedString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AnnotatedString

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

Formats the value using the given formatter.

impl Default for AnnotatedString

fn default() -> Self

Returns the “default value” for a type.

impl Message for AnnotatedString

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.

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

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

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

where Self: Sized,

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

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

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

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

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

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

where Self: Sized,

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

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

where Self: Sized,

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

impl PartialEq for AnnotatedString

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AnnotatedString