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.



19835
19836
19837
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19835

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) 


19755
19756
19757
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19755

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) 


19760
19761
19762
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19760

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:



19765
19766
19767
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19765

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) 


19770
19771
19772
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19770

def display_name
  @display_name
end

#encryption_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EncryptionSpec

Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. Corresponds to the JSON property encryptionSpec

Returns:



19776
19777
19778
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19776

def encryption_spec
  @encryption_spec
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:



19786
19787
19788
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19786

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:



19791
19792
19793
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19791

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:



19796
19797
19798
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19796

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) 


19803
19804
19805
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19803

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:



19810
19811
19812
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19810

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


19815
19816
19817
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19815

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) 


19821
19822
19823
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19821

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) 


19828
19829
19830
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19828

def name
  @name
end

#state ⇒ String

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

Returns:

  • (String) 


19833
19834
19835
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19833

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



19840
19841
19842
19843
19844
19845
19846
19847
19848
19849
19850
19851
19852
19853
19854
19855
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19840

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)
  @encryption_spec = args[:encryption_spec] if args.key?(:encryption_spec)
  @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