Struct google_api_proto::google::cloud::discoveryengine::v1::check_grounding_response::Claim

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>,
}

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

Fields

start_pos: Option<i32>

Position indicating the start of the claim in the answer candidate, measured in bytes.

end_pos: Option<i32>

Position indicating the end of the claim in the answer candidate, exclusive.

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][google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim.citation_indices], [anti_citation_indices][google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim.anti_citation_indices], and [score][google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim.score] should not be returned.

Implementations

impl Claim

pub fn start_pos(&self) -> i32

Returns the value of start_pos, or the default value if start_pos is unset.

pub fn end_pos(&self) -> i32

Returns the value of end_pos, or the default value if end_pos is unset.

pub fn grounding_check_required(&self) -> bool

Returns the value of grounding_check_required, or the default value if grounding_check_required is unset.

Trait Implementations

impl Clone for Claim

fn clone(&self) -> Claim

Returns a copy 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() -> Self

Returns the “default value” for a type.

impl Message for Claim

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Claim

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Claim