Struct AugmentPromptRequest 

#[non_exhaustive]
pub struct AugmentPromptRequest {
    pub parent: String,
    pub contents: Vec<Content>,
    pub model: Option<Model>,
    pub data_source: Option<DataSource>,
    /* private fields */
}

Available on crate feature vertex-rag-service only.

Request message for AugmentPrompt.

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 augment prompt. The users must have permission to make a call in the project. Format: projects/{project}/locations/{location}.

contents: Vec<Content>

Optional. Input content to augment, only text format is supported for now.

model: Option<Model>

Optional. Metadata of the backend deployed model.

data_source: Option<DataSource>

The data source for retrieving contexts.

Implementations

impl AugmentPromptRequest

pub fn new() -> Self

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

Sets the value of parent.

Example

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

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

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

Sets the value of contents.

Example

use google_cloud_aiplatform_v1::model::Content;
let x = AugmentPromptRequest::new()
    .set_contents([
        Content::default()/* use setters */,
        Content::default()/* use (different) setters */,
    ]);

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

where T: Into<Model>,

Sets the value of model.

Example

use google_cloud_aiplatform_v1::model::augment_prompt_request::Model;
let x = AugmentPromptRequest::new().set_model(Model::default()/* use setters */);

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

where T: Into<Model>,

Sets or clears the value of model.

Example

use google_cloud_aiplatform_v1::model::augment_prompt_request::Model;
let x = AugmentPromptRequest::new().set_or_clear_model(Some(Model::default()/* use setters */));
let x = AugmentPromptRequest::new().set_or_clear_model(None::<Model>);

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::VertexRagStore;
let x = AugmentPromptRequest::new().set_data_source(Some(
    google_cloud_aiplatform_v1::model::augment_prompt_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::VertexRagStore;
let x = AugmentPromptRequest::new().set_vertex_rag_store(VertexRagStore::default()/* use setters */);
assert!(x.vertex_rag_store().is_some());

Trait Implementations

impl Clone for AugmentPromptRequest

fn clone(&self) -> AugmentPromptRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AugmentPromptRequest

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

Formats the value using the given formatter.

impl Default for AugmentPromptRequest

fn default() -> AugmentPromptRequest

Returns the “default value” for a type.

impl Message for AugmentPromptRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for AugmentPromptRequest

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