Google Cloud Discovery Engine V1 Client - Class TrainCustomModelResponse (1.1.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
NameDescription
dataarray

Optional. Data for populating the Message object.

↳ error_samplesarray<Google\Rpc\Status>

A sample of errors encountered while processing the data.

↳ error_configGoogle\Cloud\DiscoveryEngine\V1\ImportErrorConfig

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

↳ model_statusstring

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.

↳ metricsarray|Google\Protobuf\Internal\MapField

The metrics of the trained model.

↳ model_namestring

Fully qualified name of the CustomTuningModel.

getErrorSamples

A sample of errors encountered while processing the data.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setErrorSamples

A sample of errors encountered while processing the data.

Parameter
NameDescription
vararray<Google\Rpc\Status>
Returns
TypeDescription
$this

getErrorConfig

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

Returns
TypeDescription
Google\Cloud\DiscoveryEngine\V1\ImportErrorConfig|null

hasErrorConfig

clearErrorConfig

setErrorConfig

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

Parameter
NameDescription
varGoogle\Cloud\DiscoveryEngine\V1\ImportErrorConfig
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
varstring
Returns
TypeDescription
$this

getMetrics

The metrics of the trained model.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setMetrics

The metrics of the trained model.

Parameter
NameDescription
vararray|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getModelName

Fully qualified name of the CustomTuningModel.

Returns
TypeDescription
string

setModelName

Fully qualified name of the CustomTuningModel.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this