Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRun

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

Overview

EvaluationRun is a resource that represents a single evaluation run, which includes a set of prompts, model responses, evaluation configuration and the resulting metrics.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1EvaluationRun

Returns a new instance of GoogleCloudAiplatformV1beta1EvaluationRun.



17914
17915
17916
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17914

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

Instance Attribute Details

#completion_time ⇒ String

Output only. Time when the evaluation run was completed. Corresponds to the JSON property completionTime

Returns:

  • (String) 


17840
17841
17842
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17840

def completion_time
  @completion_time
end

#create_time ⇒ String

Output only. Time when the evaluation run was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


17845
17846
17847
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17845

def create_time
  @create_time
end

#data_source ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunDataSource

The data source for the evaluation run. Corresponds to the JSON property dataSource

Returns:



17850
17851
17852
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17850

def data_source
  @data_source
end

#display_name ⇒ String

Required. The display name of the Evaluation Run. Corresponds to the JSON property displayName

Returns:

  • (String) 


17855
17856
17857
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17855

def display_name
  @display_name
end

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



17865
17866
17867
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17865

def error
  @error
end

#evaluation_config ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfig

The Evalution configuration used for the evaluation run. Corresponds to the JSON property evaluationConfig

Returns:



17870
17871
17872
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17870

def evaluation_config
  @evaluation_config
end

#evaluation_results ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationResults

The results of the evaluation run. Corresponds to the JSON property evaluationResults

Returns:



17875
17876
17877
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17875

def evaluation_results
  @evaluation_results
end

#evaluation_set_snapshot ⇒ String

Output only. The specific evaluation set of the evaluation run. For runs with an evaluation set input, this will be that same set. For runs with BigQuery input, it's the sampled BigQuery dataset. Corresponds to the JSON property evaluationSetSnapshot

Returns:

  • (String) 


17882
17883
17884
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17882

def evaluation_set_snapshot
  @evaluation_set_snapshot
end

#inference_configs ⇒ Hash<String,Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfig>

Optional. The candidate to inference config map for the evaluation run. The candidate can be up to 128 characters long and can consist of any UTF-8 characters. Corresponds to the JSON property inferenceConfigs

Returns:



17889
17890
17891
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17889

def inference_configs
  @inference_configs
end

#labels ⇒ Hash<String,String>

Optional. Labels for the evaluation run. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


17894
17895
17896
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17894

def labels
  @labels
end

#metadata ⇒ Object

Optional. Metadata about the evaluation run, can be used by the caller to store additional tracking information about the evaluation run. Corresponds to the JSON property metadata

Returns:

  • (Object) 


17900
17901
17902
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17900

def metadata
  @metadata
end

#name ⇒ String

Identifier. The resource name of the EvaluationRun. This is a unique identifier. Format: projects/project/locations/location/evaluationRuns/ evaluation_run` Corresponds to the JSON propertyname`

Returns:

  • (String) 


17907
17908
17909
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17907

def name
  @name
end

#state ⇒ String

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

Returns:

  • (String) 


17912
17913
17914
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17912

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



17919
17920
17921
17922
17923
17924
17925
17926
17927
17928
17929
17930
17931
17932
17933
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17919

def update!(**args)
  @completion_time = args[:completion_time] if args.key?(:completion_time)
  @create_time = args[:create_time] if args.key?(:create_time)
  @data_source = args[:data_source] if args.key?(:data_source)
  @display_name = args[:display_name] if args.key?(:display_name)
  @error = args[:error] if args.key?(:error)
  @evaluation_config = args[:evaluation_config] if args.key?(:evaluation_config)
  @evaluation_results = args[:evaluation_results] if args.key?(:evaluation_results)
  @evaluation_set_snapshot = args[:evaluation_set_snapshot] if args.key?(:evaluation_set_snapshot)
  @inference_configs = args[:inference_configs] if args.key?(:inference_configs)
  @labels = args[:labels] if args.key?(:labels)
  @metadata = args[:metadata] if args.key?(:metadata)
  @name = args[:name] if args.key?(:name)
  @state = args[:state] if args.key?(:state)
end