Struct AsyncRetrieveContextsRequest 

#[non_exhaustive]
pub struct AsyncRetrieveContextsRequest {
    pub parent: String,
    pub query: Option<RagQuery>,
    pub tools: Vec<Tool>,
    /* private fields */
}

Available on crate feature vertex-rag-service only.

Request message for VertexRagService.AsyncRetrieveContexts.

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.

tools: Vec<Tool>

Optional. The tools to use for AskContexts.

Implementations

impl AsyncRetrieveContextsRequest

pub fn new() -> Self

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

Sets the value of parent.

Example

let x = AsyncRetrieveContextsRequest::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 = AsyncRetrieveContextsRequest::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 = AsyncRetrieveContextsRequest::new().set_or_clear_query(Some(RagQuery::default()/* use setters */));
let x = AsyncRetrieveContextsRequest::new().set_or_clear_query(None::<RagQuery>);

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

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

Sets the value of tools.

Example

use google_cloud_aiplatform_v1::model::Tool;
let x = AsyncRetrieveContextsRequest::new()
    .set_tools([
        Tool::default()/* use setters */,
        Tool::default()/* use (different) setters */,
    ]);

Trait Implementations

impl Clone for AsyncRetrieveContextsRequest

fn clone(&self) -> AsyncRetrieveContextsRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AsyncRetrieveContextsRequest

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

Formats the value using the given formatter.

impl Default for AsyncRetrieveContextsRequest

fn default() -> AsyncRetrieveContextsRequest

Returns the “default value” for a type.

impl Message for AsyncRetrieveContextsRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for AsyncRetrieveContextsRequest

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