Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaEvaluation

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1/classes.rb,
lib/google/apis/discoveryengine_v1/representations.rb,
lib/google/apis/discoveryengine_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaEvaluation

Returns a new instance of GoogleCloudDiscoveryengineV1alphaEvaluation.



11300
11301
11302
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11300

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_timeString

Output only. Timestamp the Evaluation was created at. Corresponds to the JSON property createTime

Returns:

  • (String)


11256
11257
11258
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11256

def create_time
  @create_time
end

#end_timeString

Output only. Timestamp the Evaluation was completed at. Corresponds to the JSON property endTime

Returns:

  • (String)


11261
11262
11263
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11261

def end_time
  @end_time
end

#errorGoogle::Apis::DiscoveryengineV1::GoogleRpcStatus

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. Corresponds to the JSON property error



11271
11272
11273
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11271

def error
  @error
end

#error_samplesArray<Google::Apis::DiscoveryengineV1::GoogleRpcStatus>

Output only. A sample of errors encountered while processing the request. Corresponds to the JSON property errorSamples



11276
11277
11278
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11276

def error_samples
  @error_samples
end

#evaluation_specGoogle::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec

Describes the specification of the evaluation. Corresponds to the JSON property evaluationSpec



11281
11282
11283
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11281

def evaluation_spec
  @evaluation_spec
end

#nameString

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. Corresponds to the JSON propertyname`

Returns:

  • (String)


11288
11289
11290
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11288

def name
  @name
end

#quality_metricsGoogle::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaQualityMetrics

Describes the metrics produced by the evaluation. Corresponds to the JSON property qualityMetrics



11293
11294
11295
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11293

def quality_metrics
  @quality_metrics
end

#stateString

Output only. The state of the evaluation. Corresponds to the JSON property state

Returns:

  • (String)


11298
11299
11300
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11298

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11305

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @end_time = args[:end_time] if args.key?(:end_time)
  @error = args[:error] if args.key?(:error)
  @error_samples = args[:error_samples] if args.key?(:error_samples)
  @evaluation_spec = args[:evaluation_spec] if args.key?(:evaluation_spec)
  @name = args[:name] if args.key?(:name)
  @quality_metrics = args[:quality_metrics] if args.key?(:quality_metrics)
  @state = args[:state] if args.key?(:state)
end