Struct Summary 

#[non_exhaustive]
pub struct Summary {
    pub summary_text: String,
    pub summary_skipped_reasons: Vec<SummarySkippedReason>,
    pub safety_attributes: Option<SafetyAttributes>,
    pub summary_with_metadata: Option<SummaryWithMetadata>,
    /* private fields */
}

Available on crate features conversational-search-service or search-service only.

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

summary_text: String

The summary content.

summary_skipped_reasons: Vec<SummarySkippedReason>

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 new() -> Self

pub fn set_summary_text<T: Into<String>>(self, v: T) -> Self

Sets the value of summary_text.

Example

let x = Summary::new().set_summary_text("example");

pub fn set_summary_skipped_reasons<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<SummarySkippedReason>,

Sets the value of summary_skipped_reasons.

Example

use google_cloud_discoveryengine_v1::model::search_response::summary::SummarySkippedReason;
let x = Summary::new().set_summary_skipped_reasons([
    SummarySkippedReason::AdversarialQueryIgnored,
    SummarySkippedReason::NonSummarySeekingQueryIgnored,
    SummarySkippedReason::OutOfDomainQueryIgnored,
]);

pub fn set_safety_attributes<T>(self, v: T) -> Self

where T: Into<SafetyAttributes>,

Sets the value of safety_attributes.

Example

use google_cloud_discoveryengine_v1::model::search_response::summary::SafetyAttributes;
let x = Summary::new().set_safety_attributes(SafetyAttributes::default()/* use setters */);

pub fn set_or_clear_safety_attributes<T>(self, v: Option<T>) -> Self

where T: Into<SafetyAttributes>,

Sets or clears the value of safety_attributes.

Example

use google_cloud_discoveryengine_v1::model::search_response::summary::SafetyAttributes;
let x = Summary::new().set_or_clear_safety_attributes(Some(SafetyAttributes::default()/* use setters */));
let x = Summary::new().set_or_clear_safety_attributes(None::<SafetyAttributes>);

pub fn set_summary_with_metadata<T>(self, v: T) -> Self

where T: Into<SummaryWithMetadata>,

Sets the value of summary_with_metadata.

Example

use google_cloud_discoveryengine_v1::model::search_response::summary::SummaryWithMetadata;
let x = Summary::new().set_summary_with_metadata(SummaryWithMetadata::default()/* use setters */);

pub fn set_or_clear_summary_with_metadata<T>(self, v: Option<T>) -> Self

where T: Into<SummaryWithMetadata>,

Sets or clears the value of summary_with_metadata.

Example

use google_cloud_discoveryengine_v1::model::search_response::summary::SummaryWithMetadata;
let x = Summary::new().set_or_clear_summary_with_metadata(Some(SummaryWithMetadata::default()/* use setters */));
let x = Summary::new().set_or_clear_summary_with_metadata(None::<SummaryWithMetadata>);

Trait Implementations

impl Clone for Summary

fn clone(&self) -> Summary

Returns a duplicate 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() -> Summary

Returns the “default value” for a type.

impl Message for Summary

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Summary

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Summary