Struct TrainCustomModelRequest 

#[non_exhaustive]
pub struct TrainCustomModelRequest {
    pub data_store: String,
    pub model_type: String,
    pub error_config: Option<ImportErrorConfig>,
    pub model_id: String,
    pub training_input: Option<TrainingInput>,
    /* private fields */
}

Available on crate feature search-tuning-service only.

Request message for SearchTuningService.TrainCustomModel method.

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.

data_store: String

Required. The resource name of the Data Store, such as projects/*/locations/global/collections/default_collection/dataStores/default_data_store. This field is used to identify the data store where to train the models.

model_type: String

Model to be trained. Supported values are:

• search-tuning: Fine tuning the search system based on data provided.

error_config: Option<ImportErrorConfig>

The desired location of errors incurred during the data ingestion and training.

model_id: String

If not provided, a UUID will be generated.

training_input: Option<TrainingInput>

Model training input.

Implementations

impl TrainCustomModelRequest

pub fn new() -> Self

Creates a new default instance.

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

Sets the value of data_store.

Example

let x = TrainCustomModelRequest::new().set_data_store(format!("projects/{project_id}/locations/{location_id}/dataStores/{data_store_id}"));

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

Sets the value of model_type.

Example

let x = TrainCustomModelRequest::new().set_model_type("example");

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

where T: Into<ImportErrorConfig>,

Sets the value of error_config.

Example

use google_cloud_discoveryengine_v1::model::ImportErrorConfig;
let x = TrainCustomModelRequest::new().set_error_config(ImportErrorConfig::default()/* use setters */);

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

where T: Into<ImportErrorConfig>,

Sets or clears the value of error_config.

Example

use google_cloud_discoveryengine_v1::model::ImportErrorConfig;
let x = TrainCustomModelRequest::new().set_or_clear_error_config(Some(ImportErrorConfig::default()/* use setters */));
let x = TrainCustomModelRequest::new().set_or_clear_error_config(None::<ImportErrorConfig>);

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

Sets the value of model_id.

Example

let x = TrainCustomModelRequest::new().set_model_id("example");

pub fn set_training_input<T: Into<Option<TrainingInput>>>(self, v: T) -> Self

Sets the value of training_input.

Note that all the setters affecting training_input are mutually exclusive.

Example

use google_cloud_discoveryengine_v1::model::train_custom_model_request::GcsTrainingInput;
let x = TrainCustomModelRequest::new().set_training_input(Some(
    google_cloud_discoveryengine_v1::model::train_custom_model_request::TrainingInput::GcsTrainingInput(GcsTrainingInput::default().into())));

pub fn gcs_training_input(&self) -> Option<&Box<GcsTrainingInput>>

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

pub fn set_gcs_training_input<T: Into<Box<GcsTrainingInput>>>( self, v: T, ) -> Self

Sets the value of training_input to hold a GcsTrainingInput.

Note that all the setters affecting training_input are mutually exclusive.

Example

use google_cloud_discoveryengine_v1::model::train_custom_model_request::GcsTrainingInput;
let x = TrainCustomModelRequest::new().set_gcs_training_input(GcsTrainingInput::default()/* use setters */);
assert!(x.gcs_training_input().is_some());

Trait Implementations

impl Clone for TrainCustomModelRequest

fn clone(&self) -> TrainCustomModelRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TrainCustomModelRequest

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

Formats the value using the given formatter.

impl Default for TrainCustomModelRequest

fn default() -> TrainCustomModelRequest

Returns the “default value” for a type.

impl Message for TrainCustomModelRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for TrainCustomModelRequest

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TrainCustomModelRequest