Struct ExplainRequest 

#[non_exhaustive]
pub struct ExplainRequest {
    pub endpoint: String,
    pub instances: Vec<Value>,
    pub parameters: Option<Value>,
    pub explanation_spec_override: Option<ExplanationSpecOverride>,
    pub deployed_model_id: String,
    /* private fields */
}

Available on crate feature prediction-service only.

Request message for PredictionService.Explain.

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.

endpoint: String

Required. The name of the Endpoint requested to serve the explanation. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

instances: Vec<Value>

Required. The instances that are the input to the explanation call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the explanation call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint’s DeployedModels’ Model’s PredictSchemata’s instance_schema_uri.

parameters: Option<Value>

The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint’s DeployedModels’ Model’s PredictSchemata’s parameters_schema_uri.

explanation_spec_override: Option<ExplanationSpecOverride>

If specified, overrides the explanation_spec of the DeployedModel. Can be used for explaining prediction results with different configurations, such as:

• Explaining top-5 predictions results as opposed to top-1;
• Increasing path count or step count of the attribution methods to reduce approximate errors;
• Using different baselines for explaining the prediction results.

deployed_model_id: String

If specified, this ExplainRequest will be served by the chosen DeployedModel, overriding Endpoint.traffic_split.

Implementations

impl ExplainRequest

pub fn new() -> Self

Creates a new default instance.

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

Sets the value of endpoint.

Example

let x = ExplainRequest::new().set_endpoint(format!("projects/{project_id}/locations/{location_id}/endpoints/{endpoint_id}"));

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

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

Sets the value of instances.

Example

use wkt::Value;
let x = ExplainRequest::new()
    .set_instances([
        Value::default()/* use setters */,
        Value::default()/* use (different) setters */,
    ]);

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

where T: Into<Value>,

Sets the value of parameters.

Example

use wkt::Value;
let x = ExplainRequest::new().set_parameters(Value::default()/* use setters */);

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

where T: Into<Value>,

Sets or clears the value of parameters.

Example

use wkt::Value;
let x = ExplainRequest::new().set_or_clear_parameters(Some(Value::default()/* use setters */));
let x = ExplainRequest::new().set_or_clear_parameters(None::<Value>);

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

where T: Into<ExplanationSpecOverride>,

Sets the value of explanation_spec_override.

Example

use google_cloud_aiplatform_v1::model::ExplanationSpecOverride;
let x = ExplainRequest::new().set_explanation_spec_override(ExplanationSpecOverride::default()/* use setters */);

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

where T: Into<ExplanationSpecOverride>,

Sets or clears the value of explanation_spec_override.

Example

use google_cloud_aiplatform_v1::model::ExplanationSpecOverride;
let x = ExplainRequest::new().set_or_clear_explanation_spec_override(Some(ExplanationSpecOverride::default()/* use setters */));
let x = ExplainRequest::new().set_or_clear_explanation_spec_override(None::<ExplanationSpecOverride>);

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

Sets the value of deployed_model_id.

Example

let x = ExplainRequest::new().set_deployed_model_id("example");

Trait Implementations

impl Clone for ExplainRequest

fn clone(&self) -> ExplainRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExplainRequest

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

Formats the value using the given formatter.

impl Default for ExplainRequest

fn default() -> ExplainRequest

Returns the “default value” for a type.

impl Message for ExplainRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ExplainRequest

fn eq(&self, other: &ExplainRequest) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ExplainRequest