Struct Claim 

#[non_exhaustive]
pub struct Claim {
    pub start_pos: Option<i32>,
    pub end_pos: Option<i32>,
    pub claim_text: String,
    pub citation_indices: Vec<i32>,
    pub grounding_check_required: Option<bool>,
    pub score: Option<f64>,
    /* private fields */
}

Available on crate feature grounded-generation-service only.

Text and citation info for a claim in the answer candidate.

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_pos: Option<i32>

Position indicating the start of the claim in the answer candidate, measured in bytes. Note that this is not measured in characters and, therefore, must be rendered in the user interface keeping in mind that some characters may take more than one byte. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent).

end_pos: Option<i32>

Position indicating the end of the claim in the answer candidate, exclusive, in bytes. Note that this is not measured in characters and, therefore, must be rendered as such. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent).

claim_text: String

Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found.

citation_indices: Vec<i32>

A list of indices (into ‘cited_chunks’) specifying the citations associated with the claim. For instance [1,3,4] means that cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited supporting for the claim. A citation to a fact indicates that the claim is supported by the fact.

grounding_check_required: Option<bool>

Indicates that this claim required grounding check. When the system decided this claim doesn’t require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices should not be returned.

score: Option<f64>

Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when CheckGroundingRequest.grounding_spec.enable_claim_level_score is true.

Implementations

impl Claim

pub fn new() -> Self

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

where T: Into<i32>,

Sets the value of start_pos.

Example

let x = Claim::new().set_start_pos(42);

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

where T: Into<i32>,

Sets or clears the value of start_pos.

Example

let x = Claim::new().set_or_clear_start_pos(Some(42));
let x = Claim::new().set_or_clear_start_pos(None::<i32>);

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

where T: Into<i32>,

Sets the value of end_pos.

Example

let x = Claim::new().set_end_pos(42);

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

where T: Into<i32>,

Sets or clears the value of end_pos.

Example

let x = Claim::new().set_or_clear_end_pos(Some(42));
let x = Claim::new().set_or_clear_end_pos(None::<i32>);

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

Sets the value of claim_text.

Example

let x = Claim::new().set_claim_text("example");

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

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

Sets the value of citation_indices.

Example

let x = Claim::new().set_citation_indices([1, 2, 3]);

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 = Claim::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 = Claim::new().set_or_clear_grounding_check_required(Some(false));
let x = Claim::new().set_or_clear_grounding_check_required(None::<bool>);

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

where T: Into<f64>,

Sets the value of score.

Example

let x = Claim::new().set_score(42.0);

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

where T: Into<f64>,

Sets or clears the value of score.

Example

let x = Claim::new().set_or_clear_score(Some(42.0));
let x = Claim::new().set_or_clear_score(None::<f32>);

Trait Implementations

impl Clone for Claim

fn clone(&self) -> Claim

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Claim

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

Formats the value using the given formatter.

impl Default for Claim

fn default() -> Claim

Returns the “default value” for a type.

impl Message for Claim

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Claim

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