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.



31994
31995
31996
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31994

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) 


31935
31936
31937
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31935

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:



31941
31942
31943
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31941

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:



31947
31948
31949
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31947

def config
  @config
end

#create_time ⇒ String

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

Returns:

  • (String) 


31952
31953
31954
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31952

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) 


31960
31961
31962
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31960

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:



31969
31970
31971
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31969

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) 


31975
31976
31977
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31975

def name
  @name
end

#state ⇒ String

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

Returns:

  • (String) 


31980
31981
31982
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31980

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:



31987
31988
31989
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31987

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) 


31992
31993
31994
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31992

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



31999
32000
32001
32002
32003
32004
32005
32006
32007
32008
32009
32010
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 31999

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