Struct GroundingSupport 

#[non_exhaustive]
pub struct GroundingSupport {
    pub start_index: i64,
    pub end_index: i64,
    pub grounding_score: Option<f64>,
    pub grounding_check_required: Option<bool>,
    pub sources: Vec<CitationSource>,
    /* private fields */
}

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

Grounding support for a claim in answer_text.

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.

start_index: i64

Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode).

end_index: i64

Required. End of the claim, exclusive.

grounding_score: Option<f64>

A score in the range of [0, 1] describing how grounded is a specific claim by the references. Higher value means that the claim is better supported by the reference chunks.

grounding_check_required: Option<bool>

Indicates that this claim required grounding check. When the system decided this claim didn’t require attribution/grounding check, this field is set to false. In that case, no grounding check was done for the claim and therefore grounding_score, sources is not returned.

sources: Vec<CitationSource>

Optional. Citation sources for the claim.

Implementations

impl GroundingSupport

pub fn new() -> Self

Creates a new default instance.

pub fn set_start_index<T: Into<i64>>(self, v: T) -> Self

Sets the value of start_index.

Example

let x = GroundingSupport::new().set_start_index(42);

pub fn set_end_index<T: Into<i64>>(self, v: T) -> Self

Sets the value of end_index.

Example

let x = GroundingSupport::new().set_end_index(42);

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

where T: Into<f64>,

Sets the value of grounding_score.

Example

let x = GroundingSupport::new().set_grounding_score(42.0);

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

where T: Into<f64>,

Sets or clears the value of grounding_score.

Example

let x = GroundingSupport::new().set_or_clear_grounding_score(Some(42.0));
let x = GroundingSupport::new().set_or_clear_grounding_score(None::<f32>);

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

where T: Into<bool>,

Sets the value of grounding_check_required.

Example

let x = GroundingSupport::new().set_grounding_check_required(true);

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

where T: Into<bool>,

Sets or clears the value of grounding_check_required.

Example

let x = GroundingSupport::new().set_or_clear_grounding_check_required(Some(false));
let x = GroundingSupport::new().set_or_clear_grounding_check_required(None::<bool>);

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

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

Sets the value of sources.

Example

use google_cloud_discoveryengine_v1::model::answer::CitationSource;
let x = GroundingSupport::new()
    .set_sources([
        CitationSource::default()/* use setters */,
        CitationSource::default()/* use (different) setters */,
    ]);

Trait Implementations

impl Clone for GroundingSupport

fn clone(&self) -> GroundingSupport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GroundingSupport

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

Formats the value using the given formatter.

impl Default for GroundingSupport

fn default() -> GroundingSupport

Returns the “default value” for a type.

impl Message for GroundingSupport

fn typename() -> &'static str

The typename of this message.

impl PartialEq for GroundingSupport

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for GroundingSupport