Struct google_api_proto::google::cloud::discoveryengine::v1alpha::search_response::Summary

pub struct Summary {
    pub summary_text: String,
    pub summary_skipped_reasons: Vec<i32>,
    pub safety_attributes: Option<SafetyAttributes>,
    pub summary_with_metadata: Option<SummaryWithMetadata>,
}

Summary of the top N search results specified by the summary spec.

Fields

summary_text: String

The summary content.

summary_skipped_reasons: Vec<i32>

Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

safety_attributes: Option<SafetyAttributes>

A collection of Safety Attribute categories and their associated confidence scores.

summary_with_metadata: Option<SummaryWithMetadata>

Summary with metadata information.

Implementations

impl Summary

pub fn summary_skipped_reasons( &self, ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(_: i32) -> Option<SummarySkippedReason>>

Returns an iterator which yields the valid enum values contained in summary_skipped_reasons.

pub fn push_summary_skipped_reasons(&mut self, value: SummarySkippedReason)

Appends the provided enum value to summary_skipped_reasons.

Trait Implementations

impl Clone for Summary

fn clone(&self) -> Summary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Summary

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

Formats the value using the given formatter.

impl Default for Summary

fn default() -> Self

Returns the “default value” for a type.

impl Message for Summary

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 Summary

fn eq(&self, other: &Summary) -> 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 Summary