public sealed class OnlineEvaluator : IMessage<OnlineEvaluator>, IEquatable<OnlineEvaluator>, IDeepCloneable<OnlineEvaluator>, IBufferMessage, IMessageReference documentation and code samples for the Vertex AI v1beta1 API class OnlineEvaluator.
An OnlineEvaluator contains the configuration for an Online Evaluation.
Implements
IMessageOnlineEvaluator, IEquatableOnlineEvaluator, IDeepCloneableOnlineEvaluator, IBufferMessage, IMessageNamespace
Google.Cloud.AIPlatform.V1Beta1Assembly
Google.Cloud.AIPlatform.V1Beta1.dll
Constructors
OnlineEvaluator()
public OnlineEvaluator()OnlineEvaluator(OnlineEvaluator)
public OnlineEvaluator(OnlineEvaluator other)| Parameter | |
|---|---|
| Name | Description |
other |
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 |
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 |
OnlineEvaluatorTypesCloudObservability |
|
Config
public OnlineEvaluator.Types.Config Config { get; set; }Required. Configuration for the OnlineEvaluator.
| Property Value | |
|---|---|
| Type | Description |
OnlineEvaluatorTypesConfig |
|
CreateTime
public Timestamp CreateTime { get; set; }Output only. Timestamp when the OnlineEvaluator was created.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
DataSourceCase
public OnlineEvaluator.DataSourceOneofCase DataSourceCase { get; }| Property Value | |
|---|---|
| Type | Description |
OnlineEvaluatorDataSourceOneofCase |
|
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 |
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 |
RepeatedFieldMetricSource |
|
Name
public string Name { get; set; }Identifier. The resource name of the OnlineEvaluator. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.
| Property Value | |
|---|---|
| Type | Description |
string |
|
OnlineEvaluatorName
public OnlineEvaluatorName OnlineEvaluatorName { get; set; }OnlineEvaluatorName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
OnlineEvaluatorName |
|
State
public OnlineEvaluator.Types.State State { get; set; }Output only. The state of the OnlineEvaluator.
| Property Value | |
|---|---|
| Type | Description |
OnlineEvaluatorTypesState |
|
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 |
RepeatedFieldOnlineEvaluatorTypesStateDetails |
|
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. Timestamp when the OnlineEvaluator was last updated.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|