Struct RetrieveContextsRequest 

#[non_exhaustive]
pub struct RetrieveContextsRequest {
    pub parent: String,
    pub query: Option<RagQuery>,
    pub data_source: Option<DataSource>,
    /* private fields */
}

Available on crate feature vertex-rag-service only.

Request message for VertexRagService.RetrieveContexts.

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.

parent: String

Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: projects/{project}/locations/{location}.

query: Option<RagQuery>

Required. Single RAG retrieve query.

data_source: Option<DataSource>

Data Source to retrieve contexts.

Implementations

impl RetrieveContextsRequest

pub fn new() -> Self

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

Sets the value of parent.

Example

let x = RetrieveContextsRequest::new().set_parent("example");

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

where T: Into<RagQuery>,

Sets the value of query.

Example

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

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

where T: Into<RagQuery>,

Sets or clears the value of query.

Example

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

pub fn set_data_source<T: Into<Option<DataSource>>>(self, v: T) -> Self

Sets the value of data_source.

Note that all the setters affecting data_source are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::retrieve_contexts_request::VertexRagStore;
let x = RetrieveContextsRequest::new().set_data_source(Some(
    google_cloud_aiplatform_v1::model::retrieve_contexts_request::DataSource::VertexRagStore(VertexRagStore::default().into())));

pub fn vertex_rag_store(&self) -> Option<&Box<VertexRagStore>>

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

pub fn set_vertex_rag_store<T: Into<Box<VertexRagStore>>>(self, v: T) -> Self

Sets the value of data_source to hold a VertexRagStore.

Note that all the setters affecting data_source are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::retrieve_contexts_request::VertexRagStore;
let x = RetrieveContextsRequest::new().set_vertex_rag_store(VertexRagStore::default()/* use setters */);
assert!(x.vertex_rag_store().is_some());

Trait Implementations

impl Clone for RetrieveContextsRequest

fn clone(&self) -> RetrieveContextsRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RetrieveContextsRequest

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

Formats the value using the given formatter.

impl Default for RetrieveContextsRequest

fn default() -> RetrieveContextsRequest

Returns the “default value” for a type.

impl Message for RetrieveContextsRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for RetrieveContextsRequest

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