1.0.0-beta87 (latest) 1.0.0-beta86

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

Reference documentation and code samples for the Vertex AI v1beta1 API class OnlineEvaluator.

An OnlineEvaluator contains the configuration for an Online Evaluation.

## Inheritance

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

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[OnlineEvaluator](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.OnlineEvaluator), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[OnlineEvaluator](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.OnlineEvaluator), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[OnlineEvaluator](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.OnlineEvaluator), [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.AIPlatform.V1Beta1](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1)

## Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

## Constructors

### OnlineEvaluator()

    public OnlineEvaluator()

### OnlineEvaluator(OnlineEvaluator)

    public OnlineEvaluator(OnlineEvaluator other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.OnlineEvaluator` |

## Properties

### AgentResource

    public string AgentResource { get; set; }

Required. Immutable. The name of the agent that the OnlineEvaluator
evaluates periodically. This value is used to filter the traces with a
matching cloud.resource_id and link the evaluation results with relevant
dashboards/UIs.

This field is immutable. Once set, it cannot be changed.

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

### CloudObservability

    public OnlineEvaluator.Types.CloudObservability CloudObservability { get; set; }

Data source for the OnlineEvaluator, based on GCP Observability stack
(Cloud Trace \& Cloud Logging).

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.OnlineEvaluatorhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.OnlineEvaluator.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.OnlineEvaluator.Types.CloudObservability` |   |

### Config

    public OnlineEvaluator.Types.Config Config { get; set; }

Required. Configuration for the OnlineEvaluator.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.OnlineEvaluatorhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.OnlineEvaluator.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.OnlineEvaluator.Types.Config` |   |

### CreateTime

    public Timestamp CreateTime { get; set; }

Output only. Timestamp when the OnlineEvaluator was created.

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

### DataSourceCase

    public OnlineEvaluator.DataSourceOneofCase DataSourceCase { get; }

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.OnlineEvaluatorhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.OnlineEvaluator.DataSourceOneofCase` |   |

### DisplayName

    public string DisplayName { get; set; }

Optional. Human-readable name for the `OnlineEvaluator`.

The name doesn't have to be unique.

The name can consist of any UTF-8 characters. The maximum length is `63`
characters. If the display name exceeds max characters, an
`INVALID_ARGUMENT` error is returned.

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

### MetricSources

    public RepeatedField<MetricSource> MetricSources { get; }

Required. A list of metric sources to be used for evaluating samples.
At least one MetricSource must be provided.
Right now, only predefined metrics and registered metrics are supported.

Every registered metric must have `display_name` (or `title`) and
`score_range` defined. Otherwise, the evaluations will fail.

The maximum number of `metric_sources` is 25.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.MetricSource` |   |

### Name

    public string Name { get; set; }

Identifier. The resource name of the OnlineEvaluator.
Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.

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

### OnlineEvaluatorName

    public OnlineEvaluatorName OnlineEvaluatorName { get; set; }

[OnlineEvaluatorName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.OnlineEvaluatorName)-typed view over the [Name](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.OnlineEvaluator#Google_Cloud_AIPlatform_V1Beta1_OnlineEvaluator_Name) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.OnlineEvaluatorName` |   |

### State

    public OnlineEvaluator.Types.State State { get; set; }

Output only. The state of the OnlineEvaluator.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.OnlineEvaluatorhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.OnlineEvaluator.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.OnlineEvaluator.Types.State` |   |

### StateDetails

    public RepeatedField<OnlineEvaluator.Types.StateDetails> StateDetails { get; }

Output only. Contains additional information about the state of the
OnlineEvaluator. This is used to provide more details in the event of a
failure.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.OnlineEvaluatorhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.OnlineEvaluator.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.OnlineEvaluator.Types.StateDetails` |   |

### UpdateTime

    public Timestamp UpdateTime { get; set; }

Output only. Timestamp when the OnlineEvaluator was last updated.

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