Class EvaluationResult
An evaluation result represents the output of running an Evaluation.
Implements
Inherited Members
Namespace: Google.Apis.CustomerEngagementSuite.v1beta.Data
Assembly: Google.Apis.CustomerEngagementSuite.v1beta.dll
Syntax
public class EvaluationResult : IDirectResponseSchema
Properties
AppVersion
Output only. The app version used to generate the conversation that resulted in this result. Format:
projects/{project}/locations/{location}/apps/{app}/versions/{version}
Declaration
[JsonProperty("appVersion")]
public virtual string AppVersion { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
AppVersionDisplayName
Output only. The display name of the app_version that the evaluation ran against.
Declaration
[JsonProperty("appVersionDisplayName")]
public virtual string AppVersionDisplayName { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Changelog
Output only. The changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft.
Declaration
[JsonProperty("changelog")]
public virtual string Changelog { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
ChangelogCreateTime
object representation of ChangelogCreateTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ChangelogCreateTimeDateTimeOffset instead.")]
public virtual object ChangelogCreateTime { get; set; }
Property Value
| Type | Description |
|---|---|
| object |
ChangelogCreateTimeDateTimeOffset
DateTimeOffset representation of ChangelogCreateTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? ChangelogCreateTimeDateTimeOffset { get; set; }
Property Value
| Type | Description |
|---|---|
| DateTimeOffset? |
ChangelogCreateTimeRaw
Output only. The create time of the changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft.
Declaration
[JsonProperty("changelogCreateTime")]
public virtual string ChangelogCreateTimeRaw { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Config
Output only. The configuration used in the evaluation run that resulted in this result.
Declaration
[JsonProperty("config")]
public virtual EvaluationConfig Config { get; set; }
Property Value
| Type | Description |
|---|---|
| EvaluationConfig |
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 evaluation result was created.
Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
DisplayName
Required. Display name of the Evaluation Result. Unique within an Evaluation. By default, it has the following format: " result - ".
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. Deprecated: Use error_info instead. Errors encountered during execution.
Declaration
[JsonProperty("error")]
public virtual Status Error { get; set; }
Property Value
| Type | Description |
|---|---|
| Status |
ErrorInfo
Output only. Error information for the evaluation result.
Declaration
[JsonProperty("errorInfo")]
public virtual EvaluationErrorInfo ErrorInfo { get; set; }
Property Value
| Type | Description |
|---|---|
| EvaluationErrorInfo |
EvaluationMetricsThresholds
Output only. The evaluation thresholds for the result.
Declaration
[JsonProperty("evaluationMetricsThresholds")]
public virtual EvaluationMetricsThresholds EvaluationMetricsThresholds { get; set; }
Property Value
| Type | Description |
|---|---|
| EvaluationMetricsThresholds |
EvaluationRun
Output only. The evaluation run that produced this result. Format:
projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}
Declaration
[JsonProperty("evaluationRun")]
public virtual string EvaluationRun { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
EvaluationStatus
Output only. The outcome of the evaluation. Only populated if execution_state is COMPLETE.
Declaration
[JsonProperty("evaluationStatus")]
public virtual string EvaluationStatus { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
ExecutionState
Output only. The state of the evaluation result execution.
Declaration
[JsonProperty("executionState")]
public virtual string ExecutionState { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
GoldenResult
Output only. The outcome of a golden evaluation.
Declaration
[JsonProperty("goldenResult")]
public virtual EvaluationResultGoldenResult GoldenResult { get; set; }
Property Value
| Type | Description |
|---|---|
| EvaluationResultGoldenResult |
GoldenRunMethod
Output only. The method used to run the golden evaluation.
Declaration
[JsonProperty("goldenRunMethod")]
public virtual string GoldenRunMethod { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
InitiatedBy
Output only. The user who initiated the evaluation run that resulted in this result.
Declaration
[JsonProperty("initiatedBy")]
public virtual string InitiatedBy { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Name
Identifier. The unique identifier of the evaluation result. Format:
projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Persona
Output only. The persona used to generate the conversation for the evaluation result.
Declaration
[JsonProperty("persona")]
public virtual EvaluationPersona Persona { get; set; }
Property Value
| Type | Description |
|---|---|
| EvaluationPersona |
ScenarioResult
Output only. The outcome of a scenario evaluation.
Declaration
[JsonProperty("scenarioResult")]
public virtual EvaluationResultScenarioResult ScenarioResult { get; set; }
Property Value
| Type | Description |
|---|---|
| EvaluationResultScenarioResult |