Class GoogleCloudAiplatformV1OnlineEvaluator

An OnlineEvaluator contains the configuration for an Online Evaluation.

Inheritance
object
GoogleCloudAiplatformV1OnlineEvaluator
Implements
Inherited Members
Namespace: Google.Apis.Aiplatform.v1.Data
Assembly: Google.Apis.Aiplatform.v1.dll
Syntax
public class GoogleCloudAiplatformV1OnlineEvaluator : IDirectResponseSchema

Properties

AgentResource

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.

Declaration
[JsonProperty("agentResource")]
public virtual string AgentResource { get; set; }
Property Value
Type Description
string

CloudObservability

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

Declaration
[JsonProperty("cloudObservability")]
public virtual GoogleCloudAiplatformV1OnlineEvaluatorCloudObservability CloudObservability { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1OnlineEvaluatorCloudObservability

Config

Required. Configuration for the OnlineEvaluator.

Declaration
[JsonProperty("config")]
public virtual GoogleCloudAiplatformV1OnlineEvaluatorConfig Config { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1OnlineEvaluatorConfig

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. Timestamp when the OnlineEvaluator was created.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

DisplayName

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.

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

MetricSources

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.

Declaration
[JsonProperty("metricSources")]
public virtual IList<GoogleCloudAiplatformV1MetricSource> MetricSources { get; set; }
Property Value
Type Description
IList<GoogleCloudAiplatformV1MetricSource>

Name

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

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

State

Output only. The state of the OnlineEvaluator.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

StateDetails

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

Declaration
[JsonProperty("stateDetails")]
public virtual IList<GoogleCloudAiplatformV1OnlineEvaluatorStateDetails> StateDetails { get; set; }
Property Value
Type Description
IList<GoogleCloudAiplatformV1OnlineEvaluatorStateDetails>

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

Output only. Timestamp when the OnlineEvaluator was last updated.

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

Implements