# Discovery Engine v1beta API - Class CustomTuningModel (1.0.0-beta23)

1.0.0-beta23 (latest) 1.0.0-beta22

    public sealed class CustomTuningModel : IMessage<CustomTuningModel>, IEquatable<CustomTuningModel>, IDeepCloneable<CustomTuningModel>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1beta API class CustomTuningModel.

Metadata that describes a custom tuned model.

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> CustomTuningModel

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[CustomTuningModel](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.CustomTuningModel), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[CustomTuningModel](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.CustomTuningModel), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[CustomTuningModel](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.CustomTuningModel), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.DiscoveryEngine.V1Beta](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta)

## Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

## Constructors

### CustomTuningModel()

    public CustomTuningModel()

### CustomTuningModel(CustomTuningModel)

    public CustomTuningModel(CustomTuningModel other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.CustomTuningModel` |

## Properties

### CreateTime

    [Obsolete]
    public Timestamp CreateTime { get; set; }

Deprecated: Timestamp the Model was created at.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Timestamp.html` |   |

### CustomTuningModelName

    public CustomTuningModelName CustomTuningModelName { get; set; }

[CustomTuningModelName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.CustomTuningModelName)-typed view over the [Name](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.CustomTuningModel#Google_Cloud_DiscoveryEngine_V1Beta_CustomTuningModel_Name) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.CustomTuningModelName` |   |

### DisplayName

    public string DisplayName { get; set; }

The display name of the model.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### ErrorMessage

    public string ErrorMessage { get; set; }

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Metrics

    public MapField<string, double> Metrics { get; }

The metrics of the trained model.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.MapField-2.htmlhttps://learn.microsoft.com/dotnet/api/system.stringhttps://learn.microsoft.com/dotnet/api/system.double` |   |

### ModelState

    public CustomTuningModel.Types.ModelState ModelState { get; set; }

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.CustomTuningModelhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.CustomTuningModel.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.CustomTuningModel.Types.ModelState` |   |

### ModelVersion

    public long ModelVersion { get; set; }

The version of the model.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int64` |   |

### Name

    public string Name { get; set; }

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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### TrainingStartTime

    public Timestamp TrainingStartTime { get; set; }

Timestamp the model training was initiated.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Timestamp.html` |   |