Struct SummaryWithMetadata 

#[non_exhaustive]
pub struct SummaryWithMetadata {
    pub summary: String,
    pub citation_metadata: Option<CitationMetadata>,
    pub references: Vec<Reference>,
    /* private fields */
}

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

Summary with metadata information.

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: String

Summary text with no citation information.

citation_metadata: Option<CitationMetadata>

Citation metadata for given summary.

references: Vec<Reference>

Document References.

Implementations

impl SummaryWithMetadata

pub fn new() -> Self

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

Sets the value of summary.

Example

let x = SummaryWithMetadata::new().set_summary("example");

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

where T: Into<CitationMetadata>,

Sets the value of citation_metadata.

Example

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

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

where T: Into<CitationMetadata>,

Sets or clears the value of citation_metadata.

Example

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

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

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

Sets the value of references.

Example

use google_cloud_discoveryengine_v1::model::search_response::summary::Reference;
let x = SummaryWithMetadata::new()
    .set_references([
        Reference::default()/* use setters */,
        Reference::default()/* use (different) setters */,
    ]);

Trait Implementations

impl Clone for SummaryWithMetadata

fn clone(&self) -> SummaryWithMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SummaryWithMetadata

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

Formats the value using the given formatter.

impl Default for SummaryWithMetadata

fn default() -> SummaryWithMetadata

Returns the “default value” for a type.

impl Message for SummaryWithMetadata

fn typename() -> &'static str

The typename of this message.

impl PartialEq for SummaryWithMetadata

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