Google Cloud Discovery Engine V1 Client - Class TrainCustomModelRequest (1.2.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class TrainCustomModelRequest.

Request message for SearchTuningService.TrainCustomModel method.

Generated from protobuf message google.cloud.discoveryengine.v1.TrainCustomModelRequest

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ gcs_training_input Google\Cloud\DiscoveryEngine\V1\TrainCustomModelRequest\GcsTrainingInput

Cloud Storage training input.

↳ 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 Google\Cloud\DiscoveryEngine\V1\ImportErrorConfig

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

↳ model_id string

If not provided, a UUID will be generated.

getGcsTrainingInput

Cloud Storage training input.

Returns
Type Description
Google\Cloud\DiscoveryEngine\V1\TrainCustomModelRequest\GcsTrainingInput|null

hasGcsTrainingInput

setGcsTrainingInput

Cloud Storage training input.

Parameter
Name Description
var Google\Cloud\DiscoveryEngine\V1\TrainCustomModelRequest\GcsTrainingInput
Returns
Type Description
$this

getDataStore

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.

Returns
Type Description
string

setDataStore

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getModelType

Model to be trained. Supported values are:

  • search-tuning: Fine tuning the search system based on data provided.
Returns
Type Description
string

setModelType

Model to be trained. Supported values are:

  • search-tuning: Fine tuning the search system based on data provided.
Parameter
Name Description
var string
Returns
Type Description
$this

getErrorConfig

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

Returns
Type Description
Google\Cloud\DiscoveryEngine\V1\ImportErrorConfig|null

hasErrorConfig

clearErrorConfig

setErrorConfig

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

Parameter
Name Description
var Google\Cloud\DiscoveryEngine\V1\ImportErrorConfig
Returns
Type Description
$this

getModelId

If not provided, a UUID will be generated.

Returns
Type Description
string

setModelId

If not provided, a UUID will be generated.

Parameter
Name Description
var string
Returns
Type Description
$this

getTrainingInput

Returns
Type Description
string