Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::Evaluation (v0.16.0)

Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::Evaluation.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#end_time

def end_time() -> ::Google::Protobuf::Timestamp
Returns

#error

def error() -> ::Google::Rpc::Status
Returns
  • (::Google::Rpc::Status) — Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.

#error_samples

def error_samples() -> ::Array<::Google::Rpc::Status>
Returns
  • (::Array<::Google::Rpc::Status>) — Output only. A sample of errors encountered while processing the request.

#evaluation_spec

def evaluation_spec() -> ::Google::Cloud::DiscoveryEngine::V1beta::Evaluation::EvaluationSpec
Returns

#evaluation_spec=

def evaluation_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Evaluation::EvaluationSpec
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — 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.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#quality_metrics

def quality_metrics() -> ::Google::Cloud::DiscoveryEngine::V1beta::QualityMetrics
Returns

#state

def state() -> ::Google::Cloud::DiscoveryEngine::V1beta::Evaluation::State
Returns