Struct RagQuery 

#[non_exhaustive]
pub struct RagQuery {
    pub rag_retrieval_config: Option<RagRetrievalConfig>,
    pub query: Option<Query>,
    /* private fields */
}

Available on crate feature vertex-rag-service only.

A query to retrieve relevant contexts.

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.

rag_retrieval_config: Option<RagRetrievalConfig>

Optional. The retrieval config for the query.

query: Option<Query>

The query to retrieve contexts. Currently only text query is supported.

Implementations

impl RagQuery

pub fn new() -> Self

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

where T: Into<RagRetrievalConfig>,

Sets the value of rag_retrieval_config.

Example

use google_cloud_aiplatform_v1::model::RagRetrievalConfig;
let x = RagQuery::new().set_rag_retrieval_config(RagRetrievalConfig::default()/* use setters */);

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

where T: Into<RagRetrievalConfig>,

Sets or clears the value of rag_retrieval_config.

Example

use google_cloud_aiplatform_v1::model::RagRetrievalConfig;
let x = RagQuery::new().set_or_clear_rag_retrieval_config(Some(RagRetrievalConfig::default()/* use setters */));
let x = RagQuery::new().set_or_clear_rag_retrieval_config(None::<RagRetrievalConfig>);

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

Sets the value of query.

Note that all the setters affecting query are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::rag_query::Query;
let x = RagQuery::new().set_query(Some(Query::Text("example".to_string())));

pub fn text(&self) -> Option<&String>

The value of query if it holds a Text, None if the field is not set or holds a different branch.

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

Sets the value of query to hold a Text.

Note that all the setters affecting query are mutually exclusive.

Example

let x = RagQuery::new().set_text("example");
assert!(x.text().is_some());

Trait Implementations

impl Clone for RagQuery

fn clone(&self) -> RagQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RagQuery

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

Formats the value using the given formatter.

impl Default for RagQuery

fn default() -> RagQuery

Returns the “default value” for a type.

impl Message for RagQuery

fn typename() -> &'static str

The typename of this message.

impl PartialEq for RagQuery

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