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.



41185
41186
41187
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41185

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) 


41126
41127
41128
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41126

def agent_resource
  @agent_resource
end

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

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

Returns:



41132
41133
41134
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41132

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:



41138
41139
41140
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41138

def config
  @config
end

#create_time ⇒ String

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

Returns:

  • (String) 


41143
41144
41145
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41143

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) 


41151
41152
41153
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41151

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:



41160
41161
41162
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41160

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) 


41166
41167
41168
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41166

def name
  @name
end

#state ⇒ String

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

Returns:

  • (String) 


41171
41172
41173
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41171

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:



41178
41179
41180
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41178

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) 


41183
41184
41185
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41183

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



41190
41191
41192
41193
41194
41195
41196
41197
41198
41199
41200
41201
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 41190

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