Google Cloud Discovery Engine V1 Client - Class CustomTuningModel (1.3.1)

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

Metadata that describes a custom tuned model.

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

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Required. The fully qualified resource name of the model. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. Model must be an alpha-numerical string with limit of 40 characters.
`↳ display_name`	`string` The display name of the model.
`↳ model_version`	`int\|string` The version of the model.
`↳ model_state`	`int` The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
`↳ create_time`	`Google\Protobuf\Timestamp` Deprecated: Timestamp the Model was created at.
`↳ training_start_time`	`Google\Protobuf\Timestamp` Timestamp the model training was initiated.
`↳ metrics`	`array\|Google\Protobuf\Internal\MapField` The metrics of the trained model.
`↳ error_message`	`string` Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.

getName

Required. The fully qualified resource name of the model.

Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}. Model must be an alpha-numerical string with limit of 40 characters.

Returns
Type	Description
`string`

setName

Required. The fully qualified resource name of the model.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

The display name of the model.

Returns
Type	Description
`string`

setDisplayName

The display name of the model.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getModelVersion

The version of the model.

Returns
Type	Description
`int\|string`

setModelVersion

The version of the model.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getModelState

The state that the model is in (e.g.TRAINING or TRAINING_FAILED).

Returns
Type	Description
`int`

setModelState

The state that the model is in (e.g.TRAINING or TRAINING_FAILED).

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getCreateTime

Deprecated: Timestamp the Model was created at.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Deprecated: Timestamp the Model was created at.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getTrainingStartTime

Timestamp the model training was initiated.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasTrainingStartTime

clearTrainingStartTime

setTrainingStartTime

Timestamp the model training was initiated.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

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`

getErrorMessage

Currently this is only populated if the model state is INPUT_VALIDATION_FAILED.

Returns
Type	Description
`string`

setErrorMessage

Currently this is only populated if the model state is INPUT_VALIDATION_FAILED.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`