Struct CheckGroundingResponse 

#[non_exhaustive]
pub struct CheckGroundingResponse {
    pub support_score: Option<f32>,
    pub cited_chunks: Vec<FactChunk>,
    pub cited_facts: Vec<CheckGroundingFactChunk>,
    pub claims: Vec<Claim>,
    /* private fields */
}

Available on crate feature grounded-generation-service only.

Response message for the GroundedGenerationService.CheckGrounding method.

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.

support_score: Option<f32>

The support score for the input answer candidate. Higher the score, higher is the fraction of claims that are supported by the provided facts. This is always set when a response is returned.

cited_chunks: Vec<FactChunk>

List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.

cited_facts: Vec<CheckGroundingFactChunk>

List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.

claims: Vec<Claim>

Claim texts and citation info across all claims in the answer candidate.

Implementations

impl CheckGroundingResponse

pub fn new() -> Self

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

where T: Into<f32>,

Sets the value of support_score.

Example

let x = CheckGroundingResponse::new().set_support_score(42.0);

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

where T: Into<f32>,

Sets or clears the value of support_score.

Example

let x = CheckGroundingResponse::new().set_or_clear_support_score(Some(42.0));
let x = CheckGroundingResponse::new().set_or_clear_support_score(None::<f32>);

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

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

Sets the value of cited_chunks.

Example

use google_cloud_discoveryengine_v1::model::FactChunk;
let x = CheckGroundingResponse::new()
    .set_cited_chunks([
        FactChunk::default()/* use setters */,
        FactChunk::default()/* use (different) setters */,
    ]);

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

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

Sets the value of cited_facts.

Example

use google_cloud_discoveryengine_v1::model::check_grounding_response::CheckGroundingFactChunk;
let x = CheckGroundingResponse::new()
    .set_cited_facts([
        CheckGroundingFactChunk::default()/* use setters */,
        CheckGroundingFactChunk::default()/* use (different) setters */,
    ]);

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

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

Sets the value of claims.

Example

use google_cloud_discoveryengine_v1::model::check_grounding_response::Claim;
let x = CheckGroundingResponse::new()
    .set_claims([
        Claim::default()/* use setters */,
        Claim::default()/* use (different) setters */,
    ]);

Trait Implementations

impl Clone for CheckGroundingResponse

fn clone(&self) -> CheckGroundingResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CheckGroundingResponse

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

Formats the value using the given formatter.

impl Default for CheckGroundingResponse

fn default() -> CheckGroundingResponse

Returns the “default value” for a type.

impl Message for CheckGroundingResponse

fn typename() -> &'static str

The typename of this message.

impl PartialEq for CheckGroundingResponse

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