Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaEvaluation

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) ⇒ GoogleCloudDiscoveryengineV1betaEvaluation

Returns a new instance of GoogleCloudDiscoveryengineV1betaEvaluation.



19170
19171
19172
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19170

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) 


19126
19127
19128
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19126

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) 


19131
19132
19133
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19131

def end_time
  @end_time
end

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

Returns:



19141
19142
19143
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19141

def error
  @error
end

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

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

Returns:



19146
19147
19148
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19146

def error_samples
  @error_samples
end

#evaluation_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec

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

Returns:



19151
19152
19153
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19151

def evaluation_spec
  @evaluation_spec
end

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

Returns:

  • (String) 


19158
19159
19160
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19158

def name
  @name
end

#quality_metrics ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaQualityMetrics

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

Returns:



19163
19164
19165
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19163

def quality_metrics
  @quality_metrics
end

#state ⇒ String

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

Returns:

  • (String) 


19168
19169
19170
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19168

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



19175
19176
19177
19178
19179
19180
19181
19182
19183
19184
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19175

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