Struct Context 

#[non_exhaustive]
pub struct Context {
    pub source_uri: String,
    pub source_display_name: String,
    pub text: String,
    pub score: Option<f64>,
    pub chunk: Option<RagChunk>,
    /* private fields */
}

Available on crate feature vertex-rag-service only.

A context of the query.

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.

source_uri: String

If the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name.

source_display_name: String

The file display name.

text: String

The text chunk.

score: Option<f64>

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 context 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 context. The larger the distance, the less relevant the context is to the query. The range is [0, 2], while 0 means the most relevant and 2 means the least relevant.

chunk: Option<RagChunk>

Context of the retrieved chunk.

Implementations

impl Context

pub fn new() -> Self

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

Sets the value of source_uri.

Example

let x = Context::new().set_source_uri("example");

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

Sets the value of source_display_name.

Example

let x = Context::new().set_source_display_name("example");

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

Sets the value of text.

Example

let x = Context::new().set_text("example");

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

where T: Into<f64>,

Sets the value of score.

Example

let x = Context::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 = Context::new().set_or_clear_score(Some(42.0));
let x = Context::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 = Context::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 = Context::new().set_or_clear_chunk(Some(RagChunk::default()/* use setters */));
let x = Context::new().set_or_clear_chunk(None::<RagChunk>);

Trait Implementations

impl Clone for Context

fn clone(&self) -> Context

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Context

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

Formats the value using the given formatter.

impl Default for Context

fn default() -> Context

Returns the “default value” for a type.

impl Message for Context

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Context

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