Struct CheckGroundingSpec 

#[non_exhaustive]
pub struct CheckGroundingSpec {
    pub citation_threshold: Option<f64>,
    pub enable_claim_level_score: Option<bool>,
    /* private fields */
}

Available on crate feature grounded-generation-service only.

Specification for the grounding check.

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.

citation_threshold: Option<f64>

The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate. Choosing a higher threshold will lead to fewer but very strong citations, while choosing a lower threshold may lead to more but somewhat weaker citations. If unset, the threshold will default to 0.6.

enable_claim_level_score: Option<bool>

The control flag that enables claim-level grounding score in the response.

Implementations

impl CheckGroundingSpec

pub fn new() -> Self

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

where T: Into<f64>,

Sets the value of citation_threshold.

Example

let x = CheckGroundingSpec::new().set_citation_threshold(42.0);

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

where T: Into<f64>,

Sets or clears the value of citation_threshold.

Example

let x = CheckGroundingSpec::new().set_or_clear_citation_threshold(Some(42.0));
let x = CheckGroundingSpec::new().set_or_clear_citation_threshold(None::<f32>);

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

where T: Into<bool>,

Sets the value of enable_claim_level_score.

Example

let x = CheckGroundingSpec::new().set_enable_claim_level_score(true);

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

where T: Into<bool>,

Sets or clears the value of enable_claim_level_score.

Example

let x = CheckGroundingSpec::new().set_or_clear_enable_claim_level_score(Some(false));
let x = CheckGroundingSpec::new().set_or_clear_enable_claim_level_score(None::<bool>);

Trait Implementations

impl Clone for CheckGroundingSpec

fn clone(&self) -> CheckGroundingSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CheckGroundingSpec

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

Formats the value using the given formatter.

impl Default for CheckGroundingSpec

fn default() -> CheckGroundingSpec

Returns the “default value” for a type.

impl Message for CheckGroundingSpec

fn typename() -> &'static str

The typename of this message.

impl PartialEq for CheckGroundingSpec

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