Struct GroundingSupport 

#[non_exhaustive]
pub struct GroundingSupport {
    pub segment: Option<Segment>,
    pub grounding_chunk_indices: Vec<i32>,
    pub confidence_scores: Vec<f32>,
    /* private fields */
}

Available on crate feature prediction-service only.

Grounding support.

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.

segment: Option<Segment>

Segment of the content this support belongs to.

grounding_chunk_indices: Vec<i32>

A list of indices (into ‘grounding_chunk’) specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.

confidence_scores: Vec<f32>

Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. This list must have the same size as the grounding_chunk_indices.

Implementations

impl GroundingSupport

pub fn new() -> Self

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

where T: Into<Segment>,

Sets the value of segment.

Example

use google_cloud_aiplatform_v1::model::Segment;
let x = GroundingSupport::new().set_segment(Segment::default()/* use setters */);

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

where T: Into<Segment>,

Sets or clears the value of segment.

Example

use google_cloud_aiplatform_v1::model::Segment;
let x = GroundingSupport::new().set_or_clear_segment(Some(Segment::default()/* use setters */));
let x = GroundingSupport::new().set_or_clear_segment(None::<Segment>);

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

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

Sets the value of grounding_chunk_indices.

Example

let x = GroundingSupport::new().set_grounding_chunk_indices([1, 2, 3]);

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

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

Sets the value of confidence_scores.

Example

let x = GroundingSupport::new().set_confidence_scores([1.0, 2.0, 3.0]);

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

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 GroundingSupport