View Source GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1betaEvaluation (google_api_discovery_engine v0.16.0)

An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.

Attributes

createTime (type: DateTime.t, default: nil) - Output only. Timestamp the Evaluation was created at.
endTime (type: DateTime.t, default: nil) - Output only. Timestamp the Evaluation was completed at.
error (type: GoogleApi.DiscoveryEngine.V1.Model.GoogleRpcStatus.t, default: nil) - Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.
errorSamples (type: list(GoogleApi.DiscoveryEngine.V1.Model.GoogleRpcStatus.t), default: nil) - Output only. A sample of errors encountered while processing the request.
evaluationSpec (type: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec.t, default: nil) - Required. The specification of the evaluation.
name (type: String.t, default: nil) - Identifier. The full resource name of the Evaluation, in the format of projects/{project}/locations/{location}/evaluations/{evaluation}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
qualityMetrics (type: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1betaQualityMetrics.t, default: nil) - Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.
state (type: String.t, default: nil) - Output only. The state of the evaluation.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1betaEvaluation{
    createTime: DateTime.t() | nil,
    endTime: DateTime.t() | nil,
    error: GoogleApi.DiscoveryEngine.V1.Model.GoogleRpcStatus.t() | nil,
    errorSamples:
      [GoogleApi.DiscoveryEngine.V1.Model.GoogleRpcStatus.t()] | nil,
    evaluationSpec:
      GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec.t()
      | nil,
    name: String.t() | nil,
    qualityMetrics:
      GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1betaQualityMetrics.t()
      | nil,
    state: String.t() | nil
  }

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.