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

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

Response of the TrainCustomModelRequest.

This message is returned by the google.longrunning.Operations.response field.

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

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ error_samples array<Google\Rpc\Status>

A sample of errors encountered while processing the data.

↳ error_config Google\Cloud\DiscoveryEngine\V1\ImportErrorConfig

Echoes the destination for the complete errors in the request if set.

↳ model_status string

The trained model status. Possible values are: * bad-data: The training data quality is bad. * no-improvement: Tuning didn't improve performance. Won't deploy. * in-progress: Model training job creation is in progress. * training: Model is actively training. * evaluating: The model is evaluating trained metrics. * indexing: The model trained metrics are indexing. * ready: The model is ready for serving.

↳ metrics array|Google\Protobuf\Internal\MapField

The metrics of the trained model.

↳ model_name string

Fully qualified name of the CustomTuningModel.

getErrorSamples

A sample of errors encountered while processing the data.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setErrorSamples

A sample of errors encountered while processing the data.

Parameter
Name Description
var array<Google\Rpc\Status>
Returns
Type Description
$this

getErrorConfig

Echoes the destination for the complete errors in the request if set.

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

hasErrorConfig

clearErrorConfig

setErrorConfig

Echoes the destination for the complete errors in the request if set.

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

getModelStatus

The trained model status. Possible values are:

  • bad-data: The training data quality is bad.
  • no-improvement: Tuning didn't improve performance. Won't deploy.
    • in-progress: Model training job creation is in progress.
    • training: Model is actively training.
    • evaluating: The model is evaluating trained metrics.
    • indexing: The model trained metrics are indexing.
    • ready: The model is ready for serving.
Returns
Type Description
string

setModelStatus

The trained model status. Possible values are:

  • bad-data: The training data quality is bad.
  • no-improvement: Tuning didn't improve performance. Won't deploy.
    • in-progress: Model training job creation is in progress.
    • training: Model is actively training.
    • evaluating: The model is evaluating trained metrics.
    • indexing: The model trained metrics are indexing.
    • ready: The model is ready for serving.
Parameter
Name Description
var string
Returns
Type Description
$this

getMetrics

The metrics of the trained model.

Returns
Type Description
Google\Protobuf\Internal\MapField

setMetrics

The metrics of the trained model.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getModelName

Fully qualified name of the CustomTuningModel.

Returns
Type Description
string

setModelName

Fully qualified name of the CustomTuningModel.

Parameter
Name Description
var string
Returns
Type Description
$this