Struct Fact 

#[non_exhaustive]
pub struct Fact {
    pub query: Option<String>,
    pub title: Option<String>,
    pub uri: Option<String>,
    pub summary: Option<String>,
    pub vector_distance: Option<f64>,
    pub score: Option<f64>,
    pub chunk: Option<RagChunk>,
    /* private fields */
}

Available on crate feature vertex-rag-service only.

The fact used in grounding.

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.

query: Option<String>

Query that is used to retrieve this fact.

title: Option<String>

If present, it refers to the title of this fact.

uri: Option<String>

If present, this uri links to the source of the fact.

summary: Option<String>

If present, the summary/snippet of the fact.

vector_distance: Option<f64>

👎Deprecated

If present, the distance between the query vector and this fact vector.

score: Option<f64>

If present, according to the underlying Vector DB and the selected metric type, the score can be either the distance or the similarity between the query and the fact and its range depends on the metric type.

For example, if the metric type is COSINE_DISTANCE, it represents the distance between the query and the fact. The larger the distance, the less relevant the fact is to the query. The range is [0, 2], while 0 means the most relevant and 2 means the least relevant.

chunk: Option<RagChunk>

If present, chunk properties.

Implementations

impl Fact

pub fn new() -> Self

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

where T: Into<String>,

Sets the value of query.

Example

let x = Fact::new().set_query("example");

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

where T: Into<String>,

Sets or clears the value of query.

Example

let x = Fact::new().set_or_clear_query(Some("example"));
let x = Fact::new().set_or_clear_query(None::<String>);

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

where T: Into<String>,

Sets the value of title.

Example

let x = Fact::new().set_title("example");

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

where T: Into<String>,

Sets or clears the value of title.

Example

let x = Fact::new().set_or_clear_title(Some("example"));
let x = Fact::new().set_or_clear_title(None::<String>);

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

where T: Into<String>,

Sets the value of uri.

Example

let x = Fact::new().set_uri("example");

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

where T: Into<String>,

Sets or clears the value of uri.

Example

let x = Fact::new().set_or_clear_uri(Some("example"));
let x = Fact::new().set_or_clear_uri(None::<String>);

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

where T: Into<String>,

Sets the value of summary.

Example

let x = Fact::new().set_summary("example");

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

where T: Into<String>,

Sets or clears the value of summary.

Example

let x = Fact::new().set_or_clear_summary(Some("example"));
let x = Fact::new().set_or_clear_summary(None::<String>);

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

where T: Into<f64>,

👎Deprecated

Sets the value of vector_distance.

Example

let x = Fact::new().set_vector_distance(42.0);

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

where T: Into<f64>,

👎Deprecated

Sets or clears the value of vector_distance.

Example

let x = Fact::new().set_or_clear_vector_distance(Some(42.0));
let x = Fact::new().set_or_clear_vector_distance(None::<f32>);

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

where T: Into<f64>,

Sets the value of score.

Example

let x = Fact::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 = Fact::new().set_or_clear_score(Some(42.0));
let x = Fact::new().set_or_clear_score(None::<f32>);

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

where T: Into<RagChunk>,

Sets the value of chunk.

Example

use google_cloud_aiplatform_v1::model::RagChunk;
let x = Fact::new().set_chunk(RagChunk::default()/* use setters */);

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

where T: Into<RagChunk>,

Sets or clears the value of chunk.

Example

use google_cloud_aiplatform_v1::model::RagChunk;
let x = Fact::new().set_or_clear_chunk(Some(RagChunk::default()/* use setters */));
let x = Fact::new().set_or_clear_chunk(None::<RagChunk>);

Trait Implementations

impl Clone for Fact

fn clone(&self) -> Fact

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Fact

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

Formats the value using the given formatter.

impl Default for Fact

fn default() -> Fact

Returns the “default value” for a type.

impl Message for Fact

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Fact

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