Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1OnlineEvaluator

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

An OnlineEvaluator contains the configuration for an Online Evaluation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1OnlineEvaluator

Returns a new instance of GoogleCloudAiplatformV1beta1OnlineEvaluator.



32060
32061
32062
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32060

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

Instance Attribute Details

#agent_resource ⇒ String

Required. Immutable. The name of the agent that the OnlineEvaluator evaluates periodically. This value is used to filter the traces with a matching cloud. resource_id and link the evaluation results with relevant dashboards/UIs. This field is immutable. Once set, it cannot be changed. Corresponds to the JSON property agentResource

Returns:

  • (String) 


32001
32002
32003
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32001

def agent_resource
  @agent_resource
end

#cloud_observability ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservability

Data source for the OnlineEvaluator, based on GCP Observability stack (Cloud Trace & Cloud Logging). Corresponds to the JSON property cloudObservability

Returns:



32007
32008
32009
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32007

def cloud_observability
  @cloud_observability
end

#config ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1OnlineEvaluatorConfig

Configuration for sampling behavior of the OnlineEvaluator. The OnlineEvaluator runs at a fixed interval of 10 minutes. Corresponds to the JSON property config

Returns:



32013
32014
32015
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32013

def config
  @config
end

#create_time ⇒ String

Output only. Timestamp when the OnlineEvaluator was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


32018
32019
32020
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32018

def create_time
  @create_time
end

#display_name ⇒ String

Optional. Human-readable name for the OnlineEvaluator. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is 63 characters. If the display name exceeds max characters, an INVALID_ARGUMENT error is returned. Corresponds to the JSON property displayName

Returns:

  • (String) 


32026
32027
32028
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32026

def display_name
  @display_name
end

#metric_sources ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MetricSource>

Required. A list of metric sources to be used for evaluating samples. At least one MetricSource must be provided. Right now, only predefined metrics and registered metrics are supported. Every registered metric must have display_name (or title) and score_range defined. Otherwise, the evaluations will fail. The maximum number of metric_sources is 25. Corresponds to the JSON property metricSources

Returns:



32035
32036
32037
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32035

def metric_sources
  @metric_sources
end

#name ⇒ String

Identifier. The resource name of the OnlineEvaluator. Format: projects/ project/locations/location/onlineEvaluators/id. Corresponds to the JSON property name

Returns:

  • (String) 


32041
32042
32043
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32041

def name
  @name
end

#state ⇒ String

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

Returns:

  • (String) 


32046
32047
32048
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32046

def state
  @state
end

#state_details ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1OnlineEvaluatorStateDetails>

Output only. Contains additional information about the state of the OnlineEvaluator. This is used to provide more details in the event of a failure. Corresponds to the JSON property stateDetails

Returns:



32053
32054
32055
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32053

def state_details
  @state_details
end

#update_time ⇒ String

Output only. Timestamp when the OnlineEvaluator was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


32058
32059
32060
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32058

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



32065
32066
32067
32068
32069
32070
32071
32072
32073
32074
32075
32076
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32065

def update!(**args)
  @agent_resource = args[:agent_resource] if args.key?(:agent_resource)
  @cloud_observability = args[:cloud_observability] if args.key?(:cloud_observability)
  @config = args[:config] if args.key?(:config)
  @create_time = args[:create_time] if args.key?(:create_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @metric_sources = args[:metric_sources] if args.key?(:metric_sources)
  @name = args[:name] if args.key?(:name)
  @state = args[:state] if args.key?(:state)
  @state_details = args[:state_details] if args.key?(:state_details)
  @update_time = args[:update_time] if args.key?(:update_time)
end