Struct Retrieval 

#[non_exhaustive]
pub struct Retrieval {
    pub disable_attribution: bool,
    pub source: Option<Source>,
    /* private fields */
}

Available on crate features gen-ai-cache-service or llm-utility-service or prediction-service only.

Defines a retrieval tool that model can call to access external knowledge.

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.

disable_attribution: bool

👎Deprecated

Optional. Deprecated. This option is no longer supported.

source: Option<Source>

The source of the retrieval.

Implementations

impl Retrieval

pub fn new() -> Self

pub fn set_disable_attribution<T: Into<bool>>(self, v: T) -> Self

👎Deprecated

Sets the value of disable_attribution.

Example

let x = Retrieval::new().set_disable_attribution(true);

pub fn set_source<T: Into<Option<Source>>>(self, v: T) -> Self

Sets the value of source.

Note that all the setters affecting source are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::VertexAISearch;
let x = Retrieval::new().set_source(Some(
    google_cloud_aiplatform_v1::model::retrieval::Source::VertexAiSearch(VertexAISearch::default().into())));

pub fn vertex_ai_search(&self) -> Option<&Box<VertexAISearch>>

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

pub fn set_vertex_ai_search<T: Into<Box<VertexAISearch>>>(self, v: T) -> Self

Sets the value of source to hold a VertexAiSearch.

Note that all the setters affecting source are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::VertexAISearch;
let x = Retrieval::new().set_vertex_ai_search(VertexAISearch::default()/* use setters */);
assert!(x.vertex_ai_search().is_some());
assert!(x.vertex_rag_store().is_none());

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

The value of 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 source to hold a VertexRagStore.

Note that all the setters affecting source are mutually exclusive.

Example

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

Trait Implementations

impl Clone for Retrieval

fn clone(&self) -> Retrieval

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Retrieval

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

Formats the value using the given formatter.

impl Default for Retrieval

fn default() -> Retrieval

Returns the “default value” for a type.

impl Message for Retrieval

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Retrieval

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