Struct ExamplesOverride 

#[non_exhaustive]
pub struct ExamplesOverride {
    pub neighbor_count: i32,
    pub crowding_count: i32,
    pub restrictions: Vec<ExamplesRestrictionsNamespace>,
    pub return_embeddings: bool,
    pub data_format: DataFormat,
    /* private fields */
}

Available on crate feature prediction-service only.

Overrides for example-based explanations.

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.

neighbor_count: i32

The number of neighbors to return.

crowding_count: i32

The number of neighbors to return that have the same crowding tag.

restrictions: Vec<ExamplesRestrictionsNamespace>

Restrict the resulting nearest neighbors to respect these constraints.

return_embeddings: bool

If true, return the embeddings instead of neighbors.

data_format: DataFormat

The format of the data being provided with each call.

Implementations

impl ExamplesOverride

pub fn new() -> Self

pub fn set_neighbor_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of neighbor_count.

Example

let x = ExamplesOverride::new().set_neighbor_count(42);

pub fn set_crowding_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of crowding_count.

Example

let x = ExamplesOverride::new().set_crowding_count(42);

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

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

Sets the value of restrictions.

Example

use google_cloud_aiplatform_v1::model::ExamplesRestrictionsNamespace;
let x = ExamplesOverride::new()
    .set_restrictions([
        ExamplesRestrictionsNamespace::default()/* use setters */,
        ExamplesRestrictionsNamespace::default()/* use (different) setters */,
    ]);

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

Sets the value of return_embeddings.

Example

let x = ExamplesOverride::new().set_return_embeddings(true);

pub fn set_data_format<T: Into<DataFormat>>(self, v: T) -> Self

Sets the value of data_format.

Example

use google_cloud_aiplatform_v1::model::examples_override::DataFormat;
let x0 = ExamplesOverride::new().set_data_format(DataFormat::Instances);
let x1 = ExamplesOverride::new().set_data_format(DataFormat::Embeddings);

Trait Implementations

impl Clone for ExamplesOverride

fn clone(&self) -> ExamplesOverride

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExamplesOverride

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

Formats the value using the given formatter.

impl Default for ExamplesOverride

fn default() -> ExamplesOverride

Returns the “default value” for a type.

impl Message for ExamplesOverride

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ExamplesOverride

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