Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaEvaluation

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1alpha/classes.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb,
lib/google/apis/discoveryengine_v1alpha/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) ⇒ GoogleCloudDiscoveryengineV1betaEvaluation

Returns a new instance of GoogleCloudDiscoveryengineV1betaEvaluation.



15022
15023
15024
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 15022

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

Instance Attribute Details

#create_time ⇒ String

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

Returns:

  • (String) 


14978
14979
14980
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14978

def create_time
  @create_time
end

#end_time ⇒ String

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

Returns:

  • (String) 


14983
14984
14985
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14983

def end_time
  @end_time
end

#error ⇒ Google::Apis::DiscoveryengineV1alpha::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

Returns:



14993
14994
14995
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14993

def error
  @error
end

#error_samples ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleRpcStatus>

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

Returns:



14998
14999
15000
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14998

def error_samples
  @error_samples
end

#evaluation_spec ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec

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

Returns:



15003
15004
15005
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 15003

def evaluation_spec
  @evaluation_spec
end

#name ⇒ String

Immutable. 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) 


15010
15011
15012
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 15010

def name
  @name
end

#quality_metrics ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaQualityMetrics

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

Returns:



15015
15016
15017
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 15015

def quality_metrics
  @quality_metrics
end

#state ⇒ String

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

Returns:

  • (String) 


15020
15021
15022
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 15020

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



15027
15028
15029
15030
15031
15032
15033
15034
15035
15036
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 15027

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