Show / Hide Table of Contents

Class GoogleCloudAiplatformV1EvaluationRun

EvaluationRun is a resource that represents a single evaluation run, which includes a set of prompts, model responses, evaluation configuration and the resulting metrics.

Inheritance
object
GoogleCloudAiplatformV1EvaluationRun
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Aiplatform.v1.Data
Assembly: Google.Apis.Aiplatform.v1.dll
Syntax
public class GoogleCloudAiplatformV1EvaluationRun : IDirectResponseSchema

Properties

CompletionTime

object representation of CompletionTimeRaw.

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

CompletionTimeDateTimeOffset

DateTimeOffset representation of CompletionTimeRaw.

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

CompletionTimeRaw

Output only. Time when the evaluation run was completed.

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

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. Time when the evaluation run was created.

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

DataSource

Required. The data source for the evaluation run.

Declaration
[JsonProperty("dataSource")]
public virtual GoogleCloudAiplatformV1EvaluationRunDataSource DataSource { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1EvaluationRunDataSource

DisplayName

Required. The display name of the Evaluation Run.

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

Error

Output only. Only populated when the evaluation run's state is FAILED or CANCELLED.

Declaration
[JsonProperty("error")]
public virtual GoogleRpcStatus Error { get; set; }
Property Value
Type Description
GoogleRpcStatus

EvaluationConfig

Required. The configuration used for the evaluation.

Declaration
[JsonProperty("evaluationConfig")]
public virtual GoogleCloudAiplatformV1EvaluationRunEvaluationConfig EvaluationConfig { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1EvaluationRunEvaluationConfig

EvaluationResults

Output only. The results of the evaluation run. Only populated when the evaluation run's state is SUCCEEDED.

Declaration
[JsonProperty("evaluationResults")]
public virtual GoogleCloudAiplatformV1EvaluationResults EvaluationResults { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1EvaluationResults

EvaluationSetSnapshot

Output only. The specific evaluation set of the evaluation run. For runs with an evaluation set input, this will be that same set. For runs with BigQuery input, it's the sampled BigQuery dataset.

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

InferenceConfigs

Optional. The candidate to inference config map for the evaluation run. The candidate can be up to 128 characters long and can consist of any UTF-8 characters.

Declaration
[JsonProperty("inferenceConfigs")]
public virtual IDictionary<string, GoogleCloudAiplatformV1EvaluationRunInferenceConfig> InferenceConfigs { get; set; }
Property Value
Type Description
IDictionary<string, GoogleCloudAiplatformV1EvaluationRunInferenceConfig>

Labels

Optional. Labels for the evaluation run.

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

Metadata

Optional. Metadata about the evaluation run, can be used by the caller to store additional tracking information about the evaluation run.

Declaration
[JsonProperty("metadata")]
public virtual object Metadata { get; set; }
Property Value
Type Description
object

Name

Identifier. The resource name of the EvaluationRun. This is a unique identifier. Format: projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}

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

State

Output only. The state of the evaluation run.

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

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX