google-apis-aiplatform_v1beta1 0.57.0 → 0.59.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -779,6 +779,80 @@ module Google
779
779
  end
780
780
  end
781
781
 
782
+ # The aggregation result for the entire dataset and all metrics.
783
+ class GoogleCloudAiplatformV1beta1AggregationOutput
784
+ include Google::Apis::Core::Hashable
785
+
786
+ # One AggregationResult per metric.
787
+ # Corresponds to the JSON property `aggregationResults`
788
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AggregationResult>]
789
+ attr_accessor :aggregation_results
790
+
791
+ # The dataset used for evaluation.
792
+ # Corresponds to the JSON property `dataset`
793
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationDataset]
794
+ attr_accessor :dataset
795
+
796
+ def initialize(**args)
797
+ update!(**args)
798
+ end
799
+
800
+ # Update properties of this object
801
+ def update!(**args)
802
+ @aggregation_results = args[:aggregation_results] if args.key?(:aggregation_results)
803
+ @dataset = args[:dataset] if args.key?(:dataset)
804
+ end
805
+ end
806
+
807
+ # The aggregation result for a single metric.
808
+ class GoogleCloudAiplatformV1beta1AggregationResult
809
+ include Google::Apis::Core::Hashable
810
+
811
+ # Aggregation metric.
812
+ # Corresponds to the JSON property `aggregationMetric`
813
+ # @return [String]
814
+ attr_accessor :aggregation_metric
815
+
816
+ # Bleu metric value for an instance.
817
+ # Corresponds to the JSON property `bleuMetricValue`
818
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BleuMetricValue]
819
+ attr_accessor :bleu_metric_value
820
+
821
+ # Exact match metric value for an instance.
822
+ # Corresponds to the JSON property `exactMatchMetricValue`
823
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExactMatchMetricValue]
824
+ attr_accessor :exact_match_metric_value
825
+
826
+ # Spec for pairwise metric result.
827
+ # Corresponds to the JSON property `pairwiseMetricResult`
828
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PairwiseMetricResult]
829
+ attr_accessor :pairwise_metric_result
830
+
831
+ # Spec for pointwise metric result.
832
+ # Corresponds to the JSON property `pointwiseMetricResult`
833
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PointwiseMetricResult]
834
+ attr_accessor :pointwise_metric_result
835
+
836
+ # Rouge metric value for an instance.
837
+ # Corresponds to the JSON property `rougeMetricValue`
838
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RougeMetricValue]
839
+ attr_accessor :rouge_metric_value
840
+
841
+ def initialize(**args)
842
+ update!(**args)
843
+ end
844
+
845
+ # Update properties of this object
846
+ def update!(**args)
847
+ @aggregation_metric = args[:aggregation_metric] if args.key?(:aggregation_metric)
848
+ @bleu_metric_value = args[:bleu_metric_value] if args.key?(:bleu_metric_value)
849
+ @exact_match_metric_value = args[:exact_match_metric_value] if args.key?(:exact_match_metric_value)
850
+ @pairwise_metric_result = args[:pairwise_metric_result] if args.key?(:pairwise_metric_result)
851
+ @pointwise_metric_result = args[:pointwise_metric_result] if args.key?(:pointwise_metric_result)
852
+ @rouge_metric_value = args[:rouge_metric_value] if args.key?(:rouge_metric_value)
853
+ end
854
+ end
855
+
782
856
  # Used to assign specific AnnotationSpec to a particular area of a DataItem or
783
857
  # the whole part of the DataItem.
784
858
  class GoogleCloudAiplatformV1beta1Annotation
@@ -1788,6 +1862,13 @@ module Google
1788
1862
  # @return [String]
1789
1863
  attr_accessor :metric_name
1790
1864
 
1865
+ # Optional. The Cloud Monitoring monitored resource labels as key value pairs
1866
+ # used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.
1867
+ # com/monitoring/api/v3/metric-model#generic-label-info
1868
+ # Corresponds to the JSON property `monitoredResourceLabels`
1869
+ # @return [Hash<String,String>]
1870
+ attr_accessor :monitored_resource_labels
1871
+
1791
1872
  # The target resource utilization in percentage (1% - 100%) for the given metric;
1792
1873
  # once the real usage deviates from the target by a certain percentage, the
1793
1874
  # machine replicas change. The default value is 60 (representing 60%) if not
@@ -1803,6 +1884,7 @@ module Google
1803
1884
  # Update properties of this object
1804
1885
  def update!(**args)
1805
1886
  @metric_name = args[:metric_name] if args.key?(:metric_name)
1887
+ @monitored_resource_labels = args[:monitored_resource_labels] if args.key?(:monitored_resource_labels)
1806
1888
  @target = args[:target] if args.key?(:target)
1807
1889
  end
1808
1890
  end
@@ -2906,6 +2988,86 @@ module Google
2906
2988
  end
2907
2989
  end
2908
2990
 
2991
+ # The request set for the evaluation run.
2992
+ class GoogleCloudAiplatformV1beta1BigQueryRequestSet
2993
+ include Google::Apis::Core::Hashable
2994
+
2995
+ # Optional. Map of candidate name to candidate response column name. The column
2996
+ # will be in evaluation_item.CandidateResponse format.
2997
+ # Corresponds to the JSON property `candidateResponseColumns`
2998
+ # @return [Hash<String,String>]
2999
+ attr_accessor :candidate_response_columns
3000
+
3001
+ # Optional. The name of the column that contains the requests to evaluate. This
3002
+ # will be in evaluation_item.EvalPrompt format.
3003
+ # Corresponds to the JSON property `promptColumn`
3004
+ # @return [String]
3005
+ attr_accessor :prompt_column
3006
+
3007
+ # Optional. The name of the column that contains the rubrics. This will be in
3008
+ # evaluation_rubric.RubricGroup format (cl/762595858).
3009
+ # Corresponds to the JSON property `rubricsColumn`
3010
+ # @return [String]
3011
+ attr_accessor :rubrics_column
3012
+
3013
+ # The sampling config.
3014
+ # Corresponds to the JSON property `samplingConfig`
3015
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BigQueryRequestSetSamplingConfig]
3016
+ attr_accessor :sampling_config
3017
+
3018
+ # Required. The URI of a BigQuery table. e.g. bq://projectId.bqDatasetId.
3019
+ # bqTableId
3020
+ # Corresponds to the JSON property `uri`
3021
+ # @return [String]
3022
+ attr_accessor :uri
3023
+
3024
+ def initialize(**args)
3025
+ update!(**args)
3026
+ end
3027
+
3028
+ # Update properties of this object
3029
+ def update!(**args)
3030
+ @candidate_response_columns = args[:candidate_response_columns] if args.key?(:candidate_response_columns)
3031
+ @prompt_column = args[:prompt_column] if args.key?(:prompt_column)
3032
+ @rubrics_column = args[:rubrics_column] if args.key?(:rubrics_column)
3033
+ @sampling_config = args[:sampling_config] if args.key?(:sampling_config)
3034
+ @uri = args[:uri] if args.key?(:uri)
3035
+ end
3036
+ end
3037
+
3038
+ # The sampling config.
3039
+ class GoogleCloudAiplatformV1beta1BigQueryRequestSetSamplingConfig
3040
+ include Google::Apis::Core::Hashable
3041
+
3042
+ # Optional. The total number of logged data to import. If available data is less
3043
+ # than the sampling count, all data will be imported. Default is 100.
3044
+ # Corresponds to the JSON property `samplingCount`
3045
+ # @return [Fixnum]
3046
+ attr_accessor :sampling_count
3047
+
3048
+ # Optional. How long to wait before sampling data from the BigQuery table. If
3049
+ # not specified, defaults to 0.
3050
+ # Corresponds to the JSON property `samplingDuration`
3051
+ # @return [String]
3052
+ attr_accessor :sampling_duration
3053
+
3054
+ # Optional. The sampling method to use.
3055
+ # Corresponds to the JSON property `samplingMethod`
3056
+ # @return [String]
3057
+ attr_accessor :sampling_method
3058
+
3059
+ def initialize(**args)
3060
+ update!(**args)
3061
+ end
3062
+
3063
+ # Update properties of this object
3064
+ def update!(**args)
3065
+ @sampling_count = args[:sampling_count] if args.key?(:sampling_count)
3066
+ @sampling_duration = args[:sampling_duration] if args.key?(:sampling_duration)
3067
+ @sampling_method = args[:sampling_method] if args.key?(:sampling_method)
3068
+ end
3069
+ end
3070
+
2909
3071
  # The BigQuery location for the input content.
2910
3072
  class GoogleCloudAiplatformV1beta1BigQuerySource
2911
3073
  include Google::Apis::Core::Hashable
@@ -3327,6 +3489,19 @@ module Google
3327
3489
  end
3328
3490
  end
3329
3491
 
3492
+ # Request message for EvaluationManagementService.CancelEvaluationRun.
3493
+ class GoogleCloudAiplatformV1beta1CancelEvaluationRunRequest
3494
+ include Google::Apis::Core::Hashable
3495
+
3496
+ def initialize(**args)
3497
+ update!(**args)
3498
+ end
3499
+
3500
+ # Update properties of this object
3501
+ def update!(**args)
3502
+ end
3503
+ end
3504
+
3330
3505
  # Request message for JobService.CancelHyperparameterTuningJob.
3331
3506
  class GoogleCloudAiplatformV1beta1CancelHyperparameterTuningJobRequest
3332
3507
  include Google::Apis::Core::Hashable
@@ -3471,6 +3646,87 @@ module Google
3471
3646
  end
3472
3647
  end
3473
3648
 
3649
+ # Responses from model or agent.
3650
+ class GoogleCloudAiplatformV1beta1CandidateResponse
3651
+ include Google::Apis::Core::Hashable
3652
+
3653
+ # Required. The name of the candidate that produced the response.
3654
+ # Corresponds to the JSON property `candidate`
3655
+ # @return [String]
3656
+ attr_accessor :candidate
3657
+
3658
+ # Text response.
3659
+ # Corresponds to the JSON property `text`
3660
+ # @return [String]
3661
+ attr_accessor :text
3662
+
3663
+ # Fields and values that can be used to populate the response template.
3664
+ # Corresponds to the JSON property `value`
3665
+ # @return [Object]
3666
+ attr_accessor :value
3667
+
3668
+ def initialize(**args)
3669
+ update!(**args)
3670
+ end
3671
+
3672
+ # Update properties of this object
3673
+ def update!(**args)
3674
+ @candidate = args[:candidate] if args.key?(:candidate)
3675
+ @text = args[:text] if args.key?(:text)
3676
+ @value = args[:value] if args.key?(:value)
3677
+ end
3678
+ end
3679
+
3680
+ # Result for a single candidate.
3681
+ class GoogleCloudAiplatformV1beta1CandidateResult
3682
+ include Google::Apis::Core::Hashable
3683
+
3684
+ # Optional. Additional results for the metric.
3685
+ # Corresponds to the JSON property `additionalResults`
3686
+ # @return [Object]
3687
+ attr_accessor :additional_results
3688
+
3689
+ # Required. The candidate that is being evaluated. The value is the same as the
3690
+ # candidate name in the EvaluationRequest.
3691
+ # Corresponds to the JSON property `candidate`
3692
+ # @return [String]
3693
+ attr_accessor :candidate
3694
+
3695
+ # Optional. The explanation for the metric.
3696
+ # Corresponds to the JSON property `explanation`
3697
+ # @return [String]
3698
+ attr_accessor :explanation
3699
+
3700
+ # Required. The metric that was evaluated.
3701
+ # Corresponds to the JSON property `metric`
3702
+ # @return [String]
3703
+ attr_accessor :metric
3704
+
3705
+ # Optional. The rubric verdicts for the metric.
3706
+ # Corresponds to the JSON property `rubricVerdicts`
3707
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RubricVerdict>]
3708
+ attr_accessor :rubric_verdicts
3709
+
3710
+ # Optional. The score for the metric.
3711
+ # Corresponds to the JSON property `score`
3712
+ # @return [Float]
3713
+ attr_accessor :score
3714
+
3715
+ def initialize(**args)
3716
+ update!(**args)
3717
+ end
3718
+
3719
+ # Update properties of this object
3720
+ def update!(**args)
3721
+ @additional_results = args[:additional_results] if args.key?(:additional_results)
3722
+ @candidate = args[:candidate] if args.key?(:candidate)
3723
+ @explanation = args[:explanation] if args.key?(:explanation)
3724
+ @metric = args[:metric] if args.key?(:metric)
3725
+ @rubric_verdicts = args[:rubric_verdicts] if args.key?(:rubric_verdicts)
3726
+ @score = args[:score] if args.key?(:score)
3727
+ end
3728
+ end
3729
+
3474
3730
  # Request message for ModelGardenService.CheckPublisherModelEula.
3475
3731
  class GoogleCloudAiplatformV1beta1CheckPublisherModelEulaAcceptanceRequest
3476
3732
  include Google::Apis::Core::Hashable
@@ -3588,6 +3844,40 @@ module Google
3588
3844
  end
3589
3845
  end
3590
3846
 
3847
+ # Container for bytes-encoded data such as video frame, audio sample, or a
3848
+ # complete binary/text data.
3849
+ class GoogleCloudAiplatformV1beta1Chunk
3850
+ include Google::Apis::Core::Hashable
3851
+
3852
+ # Required. The data in the chunk.
3853
+ # Corresponds to the JSON property `data`
3854
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
3855
+ # @return [String]
3856
+ attr_accessor :data
3857
+
3858
+ # Metadata for a chunk.
3859
+ # Corresponds to the JSON property `metadata`
3860
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Metadata]
3861
+ attr_accessor :metadata
3862
+
3863
+ # Required. Mime type of the chunk data. See https://www.iana.org/assignments/
3864
+ # media-types/media-types.xhtml for the full list.
3865
+ # Corresponds to the JSON property `mimeType`
3866
+ # @return [String]
3867
+ attr_accessor :mime_type
3868
+
3869
+ def initialize(**args)
3870
+ update!(**args)
3871
+ end
3872
+
3873
+ # Update properties of this object
3874
+ def update!(**args)
3875
+ @data = args[:data] if args.key?(:data)
3876
+ @metadata = args[:metadata] if args.key?(:metadata)
3877
+ @mime_type = args[:mime_type] if args.key?(:mime_type)
3878
+ end
3879
+ end
3880
+
3591
3881
  # Source attributions for content.
3592
3882
  class GoogleCloudAiplatformV1beta1Citation
3593
3883
  include Google::Apis::Core::Hashable
@@ -6201,6 +6491,18 @@ module Google
6201
6491
  class GoogleCloudAiplatformV1beta1DatasetStats
6202
6492
  include Google::Apis::Core::Hashable
6203
6493
 
6494
+ # Output only. A partial sample of the indices (starting from 1) of the dropped
6495
+ # examples.
6496
+ # Corresponds to the JSON property `droppedExampleIndices`
6497
+ # @return [Array<Fixnum>]
6498
+ attr_accessor :dropped_example_indices
6499
+
6500
+ # Output only. For each index in `dropped_example_indices`, the user-facing
6501
+ # reason why the example was dropped.
6502
+ # Corresponds to the JSON property `droppedExampleReasons`
6503
+ # @return [Array<String>]
6504
+ attr_accessor :dropped_example_reasons
6505
+
6204
6506
  # Output only. Number of billable characters in the tuning dataset.
6205
6507
  # Corresponds to the JSON property `totalBillableCharacterCount`
6206
6508
  # @return [Fixnum]
@@ -6247,6 +6549,8 @@ module Google
6247
6549
 
6248
6550
  # Update properties of this object
6249
6551
  def update!(**args)
6552
+ @dropped_example_indices = args[:dropped_example_indices] if args.key?(:dropped_example_indices)
6553
+ @dropped_example_reasons = args[:dropped_example_reasons] if args.key?(:dropped_example_reasons)
6250
6554
  @total_billable_character_count = args[:total_billable_character_count] if args.key?(:total_billable_character_count)
6251
6555
  @total_tuning_character_count = args[:total_tuning_character_count] if args.key?(:total_tuning_character_count)
6252
6556
  @tuning_dataset_example_count = args[:tuning_dataset_example_count] if args.key?(:tuning_dataset_example_count)
@@ -6981,12 +7285,26 @@ module Google
6981
7285
  class GoogleCloudAiplatformV1beta1DeployRequestEndpointConfig
6982
7286
  include Google::Apis::Core::Hashable
6983
7287
 
6984
- # Optional. If true, the endpoint will be exposed through a dedicated DNS [
6985
- # Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be
6986
- # isolated from other users' traffic and will have better performance and
6987
- # reliability. Note: Once you enabled dedicated endpoint, you won't be able to
6988
- # send request to the shared DNS `region`-aiplatform.googleapis.com. The
6989
- # limitations will be removed soon.
7288
+ # Optional. By default, if dedicated endpoint is enabled, the endpoint will be
7289
+ # exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your
7290
+ # request to the dedicated DNS will be isolated from other users' traffic and
7291
+ # will have better performance and reliability. Note: Once you enabled dedicated
7292
+ # endpoint, you won't be able to send request to the shared DNS `region`-
7293
+ # aiplatform.googleapis.com. The limitations will be removed soon. If this field
7294
+ # is set to true, the dedicated endpoint will be disabled and the deployed model
7295
+ # will be exposed through the shared DNS `region`-aiplatform.googleapis.com.
7296
+ # Corresponds to the JSON property `dedicatedEndpointDisabled`
7297
+ # @return [Boolean]
7298
+ attr_accessor :dedicated_endpoint_disabled
7299
+ alias_method :dedicated_endpoint_disabled?, :dedicated_endpoint_disabled
7300
+
7301
+ # Optional. Deprecated. Use dedicated_endpoint_disabled instead. If true, the
7302
+ # endpoint will be exposed through a dedicated DNS [Endpoint.
7303
+ # dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated
7304
+ # from other users' traffic and will have better performance and reliability.
7305
+ # Note: Once you enabled dedicated endpoint, you won't be able to send request
7306
+ # to the shared DNS `region`-aiplatform.googleapis.com. The limitations will be
7307
+ # removed soon.
6990
7308
  # Corresponds to the JSON property `dedicatedEndpointEnabled`
6991
7309
  # @return [Boolean]
6992
7310
  attr_accessor :dedicated_endpoint_enabled
@@ -6998,14 +7316,29 @@ module Google
6998
7316
  # @return [String]
6999
7317
  attr_accessor :endpoint_display_name
7000
7318
 
7319
+ # Optional. Immutable. The ID to use for endpoint, which will become the final
7320
+ # component of the endpoint resource name. If not provided, Vertex AI will
7321
+ # generate a value for this ID. If the first character is a letter, this value
7322
+ # may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last
7323
+ # character must be a letter or number. If the first character is a number, this
7324
+ # value may be up to 9 characters, and valid characters are `[0-9]` with no
7325
+ # leading zeros. When using HTTP/JSON, this field is populated based on a query
7326
+ # string argument, such as `?endpoint_id=12345`. This is the fallback for fields
7327
+ # that are not included in either the URI or the body.
7328
+ # Corresponds to the JSON property `endpointUserId`
7329
+ # @return [String]
7330
+ attr_accessor :endpoint_user_id
7331
+
7001
7332
  def initialize(**args)
7002
7333
  update!(**args)
7003
7334
  end
7004
7335
 
7005
7336
  # Update properties of this object
7006
7337
  def update!(**args)
7338
+ @dedicated_endpoint_disabled = args[:dedicated_endpoint_disabled] if args.key?(:dedicated_endpoint_disabled)
7007
7339
  @dedicated_endpoint_enabled = args[:dedicated_endpoint_enabled] if args.key?(:dedicated_endpoint_enabled)
7008
7340
  @endpoint_display_name = args[:endpoint_display_name] if args.key?(:endpoint_display_name)
7341
+ @endpoint_user_id = args[:endpoint_user_id] if args.key?(:endpoint_user_id)
7009
7342
  end
7010
7343
  end
7011
7344
 
@@ -8475,6 +8808,75 @@ module Google
8475
8808
  end
8476
8809
  end
8477
8810
 
8811
+ # Response in LRO for EvaluationService.EvaluateDataset.
8812
+ class GoogleCloudAiplatformV1beta1EvaluateDatasetResponse
8813
+ include Google::Apis::Core::Hashable
8814
+
8815
+ # The aggregation result for the entire dataset and all metrics.
8816
+ # Corresponds to the JSON property `aggregationOutput`
8817
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AggregationOutput]
8818
+ attr_accessor :aggregation_output
8819
+
8820
+ # Describes the info for output of EvaluationService.EvaluateDataset.
8821
+ # Corresponds to the JSON property `outputInfo`
8822
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1OutputInfo]
8823
+ attr_accessor :output_info
8824
+
8825
+ def initialize(**args)
8826
+ update!(**args)
8827
+ end
8828
+
8829
+ # Update properties of this object
8830
+ def update!(**args)
8831
+ @aggregation_output = args[:aggregation_output] if args.key?(:aggregation_output)
8832
+ @output_info = args[:output_info] if args.key?(:output_info)
8833
+ end
8834
+ end
8835
+
8836
+ # Evaluate Dataset Run Result for Tuning Job.
8837
+ class GoogleCloudAiplatformV1beta1EvaluateDatasetRun
8838
+ include Google::Apis::Core::Hashable
8839
+
8840
+ # Output only. The checkpoint id used in the evaluation run. Only populated when
8841
+ # evaluating checkpoints.
8842
+ # Corresponds to the JSON property `checkpointId`
8843
+ # @return [String]
8844
+ attr_accessor :checkpoint_id
8845
+
8846
+ # The `Status` type defines a logical error model that is suitable for different
8847
+ # programming environments, including REST APIs and RPC APIs. It is used by [
8848
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
8849
+ # data: error code, error message, and error details. You can find out more
8850
+ # about this error model and how to work with it in the [API Design Guide](https:
8851
+ # //cloud.google.com/apis/design/errors).
8852
+ # Corresponds to the JSON property `error`
8853
+ # @return [Google::Apis::AiplatformV1beta1::GoogleRpcStatus]
8854
+ attr_accessor :error
8855
+
8856
+ # Response in LRO for EvaluationService.EvaluateDataset.
8857
+ # Corresponds to the JSON property `evaluateDatasetResponse`
8858
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluateDatasetResponse]
8859
+ attr_accessor :evaluate_dataset_response
8860
+
8861
+ # Output only. The operation ID of the evaluation run. Format: `projects/`
8862
+ # project`/locations/`location`/operations/`operation_id``.
8863
+ # Corresponds to the JSON property `operationName`
8864
+ # @return [String]
8865
+ attr_accessor :operation_name
8866
+
8867
+ def initialize(**args)
8868
+ update!(**args)
8869
+ end
8870
+
8871
+ # Update properties of this object
8872
+ def update!(**args)
8873
+ @checkpoint_id = args[:checkpoint_id] if args.key?(:checkpoint_id)
8874
+ @error = args[:error] if args.key?(:error)
8875
+ @evaluate_dataset_response = args[:evaluate_dataset_response] if args.key?(:evaluate_dataset_response)
8876
+ @operation_name = args[:operation_name] if args.key?(:operation_name)
8877
+ end
8878
+ end
8879
+
8478
8880
  # Request message for EvaluationService.EvaluateInstances.
8479
8881
  class GoogleCloudAiplatformV1beta1EvaluateInstancesRequest
8480
8882
  include Google::Apis::Core::Hashable
@@ -8520,6 +8922,20 @@ module Google
8520
8922
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundednessInput]
8521
8923
  attr_accessor :groundedness_input
8522
8924
 
8925
+ # A single instance to be evaluated. Instances are used to specify the input
8926
+ # data for evaluation, from simple string comparisons to complex, multi-turn
8927
+ # model evaluations
8928
+ # Corresponds to the JSON property `instance`
8929
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstance]
8930
+ attr_accessor :instance
8931
+
8932
+ # The metrics used for evaluation. Currently, we only support evaluating a
8933
+ # single metric. If multiple metrics are provided, only the first one will be
8934
+ # evaluated.
8935
+ # Corresponds to the JSON property `metrics`
8936
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Metric>]
8937
+ attr_accessor :metrics
8938
+
8523
8939
  # Input for MetricX metric.
8524
8940
  # Corresponds to the JSON property `metricxInput`
8525
8941
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MetricxInput]
@@ -8659,6 +9075,8 @@ module Google
8659
9075
  @fluency_input = args[:fluency_input] if args.key?(:fluency_input)
8660
9076
  @fulfillment_input = args[:fulfillment_input] if args.key?(:fulfillment_input)
8661
9077
  @groundedness_input = args[:groundedness_input] if args.key?(:groundedness_input)
9078
+ @instance = args[:instance] if args.key?(:instance)
9079
+ @metrics = args[:metrics] if args.key?(:metrics)
8662
9080
  @metricx_input = args[:metricx_input] if args.key?(:metricx_input)
8663
9081
  @pairwise_metric_input = args[:pairwise_metric_input] if args.key?(:pairwise_metric_input)
8664
9082
  @pairwise_question_answering_quality_input = args[:pairwise_question_answering_quality_input] if args.key?(:pairwise_question_answering_quality_input)
@@ -8727,6 +9145,12 @@ module Google
8727
9145
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundednessResult]
8728
9146
  attr_accessor :groundedness_result
8729
9147
 
9148
+ # Metric results for each instance. The order of the metric results is
9149
+ # guaranteed to be the same as the order of the instances in the request.
9150
+ # Corresponds to the JSON property `metricResults`
9151
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MetricResult>]
9152
+ attr_accessor :metric_results
9153
+
8730
9154
  # Spec for MetricX result - calculates the MetricX score for the given instance
8731
9155
  # using the version specified in the spec.
8732
9156
  # Corresponds to the JSON property `metricxResult`
@@ -8866,6 +9290,7 @@ module Google
8866
9290
  @fluency_result = args[:fluency_result] if args.key?(:fluency_result)
8867
9291
  @fulfillment_result = args[:fulfillment_result] if args.key?(:fulfillment_result)
8868
9292
  @groundedness_result = args[:groundedness_result] if args.key?(:groundedness_result)
9293
+ @metric_results = args[:metric_results] if args.key?(:metric_results)
8869
9294
  @metricx_result = args[:metricx_result] if args.key?(:metricx_result)
8870
9295
  @pairwise_metric_result = args[:pairwise_metric_result] if args.key?(:pairwise_metric_result)
8871
9296
  @pairwise_question_answering_quality_result = args[:pairwise_question_answering_quality_result] if args.key?(:pairwise_question_answering_quality_result)
@@ -8998,6 +9423,38 @@ module Google
8998
9423
  end
8999
9424
  end
9000
9425
 
9426
+ # Evaluation Config for Tuning Job.
9427
+ class GoogleCloudAiplatformV1beta1EvaluationConfig
9428
+ include Google::Apis::Core::Hashable
9429
+
9430
+ # The configs for autorater. This is applicable to both EvaluateInstances and
9431
+ # EvaluateDataset.
9432
+ # Corresponds to the JSON property `autoraterConfig`
9433
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AutoraterConfig]
9434
+ attr_accessor :autorater_config
9435
+
9436
+ # Required. The metrics used for evaluation.
9437
+ # Corresponds to the JSON property `metrics`
9438
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Metric>]
9439
+ attr_accessor :metrics
9440
+
9441
+ # Config for evaluation output.
9442
+ # Corresponds to the JSON property `outputConfig`
9443
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1OutputConfig]
9444
+ attr_accessor :output_config
9445
+
9446
+ def initialize(**args)
9447
+ update!(**args)
9448
+ end
9449
+
9450
+ # Update properties of this object
9451
+ def update!(**args)
9452
+ @autorater_config = args[:autorater_config] if args.key?(:autorater_config)
9453
+ @metrics = args[:metrics] if args.key?(:metrics)
9454
+ @output_config = args[:output_config] if args.key?(:output_config)
9455
+ end
9456
+ end
9457
+
9001
9458
  # The dataset used for evaluation.
9002
9459
  class GoogleCloudAiplatformV1beta1EvaluationDataset
9003
9460
  include Google::Apis::Core::Hashable
@@ -9023,6 +9480,999 @@ module Google
9023
9480
  end
9024
9481
  end
9025
9482
 
9483
+ # A single instance to be evaluated. Instances are used to specify the input
9484
+ # data for evaluation, from simple string comparisons to complex, multi-turn
9485
+ # model evaluations
9486
+ class GoogleCloudAiplatformV1beta1EvaluationInstance
9487
+ include Google::Apis::Core::Hashable
9488
+
9489
+ # Instance data specified as a map.
9490
+ # Corresponds to the JSON property `otherData`
9491
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstanceMapInstance]
9492
+ attr_accessor :other_data
9493
+
9494
+ # Instance data used to populate placeholders in a metric prompt template.
9495
+ # Corresponds to the JSON property `prompt`
9496
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData]
9497
+ attr_accessor :prompt
9498
+
9499
+ # Instance data used to populate placeholders in a metric prompt template.
9500
+ # Corresponds to the JSON property `reference`
9501
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData]
9502
+ attr_accessor :reference
9503
+
9504
+ # Instance data used to populate placeholders in a metric prompt template.
9505
+ # Corresponds to the JSON property `response`
9506
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData]
9507
+ attr_accessor :response
9508
+
9509
+ # Optional. Named groups of rubrics associated with the prompt. This is used for
9510
+ # rubric-based evaluations where rubrics can be referenced by a key. The key
9511
+ # could represent versions, associated metrics, etc.
9512
+ # Corresponds to the JSON property `rubricGroups`
9513
+ # @return [Hash<String,Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RubricGroup>]
9514
+ attr_accessor :rubric_groups
9515
+
9516
+ def initialize(**args)
9517
+ update!(**args)
9518
+ end
9519
+
9520
+ # Update properties of this object
9521
+ def update!(**args)
9522
+ @other_data = args[:other_data] if args.key?(:other_data)
9523
+ @prompt = args[:prompt] if args.key?(:prompt)
9524
+ @reference = args[:reference] if args.key?(:reference)
9525
+ @response = args[:response] if args.key?(:response)
9526
+ @rubric_groups = args[:rubric_groups] if args.key?(:rubric_groups)
9527
+ end
9528
+ end
9529
+
9530
+ # Instance data used to populate placeholders in a metric prompt template.
9531
+ class GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData
9532
+ include Google::Apis::Core::Hashable
9533
+
9534
+ # List of standard Content messages from Gemini API.
9535
+ # Corresponds to the JSON property `contents`
9536
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceDataContents]
9537
+ attr_accessor :contents
9538
+
9539
+ # Text data.
9540
+ # Corresponds to the JSON property `text`
9541
+ # @return [String]
9542
+ attr_accessor :text
9543
+
9544
+ def initialize(**args)
9545
+ update!(**args)
9546
+ end
9547
+
9548
+ # Update properties of this object
9549
+ def update!(**args)
9550
+ @contents = args[:contents] if args.key?(:contents)
9551
+ @text = args[:text] if args.key?(:text)
9552
+ end
9553
+ end
9554
+
9555
+ # List of standard Content messages from Gemini API.
9556
+ class GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceDataContents
9557
+ include Google::Apis::Core::Hashable
9558
+
9559
+ # Optional. Repeated contents.
9560
+ # Corresponds to the JSON property `contents`
9561
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content>]
9562
+ attr_accessor :contents
9563
+
9564
+ def initialize(**args)
9565
+ update!(**args)
9566
+ end
9567
+
9568
+ # Update properties of this object
9569
+ def update!(**args)
9570
+ @contents = args[:contents] if args.key?(:contents)
9571
+ end
9572
+ end
9573
+
9574
+ # Instance data specified as a map.
9575
+ class GoogleCloudAiplatformV1beta1EvaluationInstanceMapInstance
9576
+ include Google::Apis::Core::Hashable
9577
+
9578
+ # Optional. Map of instance data.
9579
+ # Corresponds to the JSON property `mapInstance`
9580
+ # @return [Hash<String,Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData>]
9581
+ attr_accessor :map_instance
9582
+
9583
+ def initialize(**args)
9584
+ update!(**args)
9585
+ end
9586
+
9587
+ # Update properties of this object
9588
+ def update!(**args)
9589
+ @map_instance = args[:map_instance] if args.key?(:map_instance)
9590
+ end
9591
+ end
9592
+
9593
+ # EvaluationItem is a single evaluation request or result. The content of an
9594
+ # EvaluationItem is immutable - it cannot be updated once created.
9595
+ # EvaluationItems can be deleted when no longer needed.
9596
+ class GoogleCloudAiplatformV1beta1EvaluationItem
9597
+ include Google::Apis::Core::Hashable
9598
+
9599
+ # Output only. Timestamp when this item was created.
9600
+ # Corresponds to the JSON property `createTime`
9601
+ # @return [String]
9602
+ attr_accessor :create_time
9603
+
9604
+ # Required. The display name of the EvaluationItem.
9605
+ # Corresponds to the JSON property `displayName`
9606
+ # @return [String]
9607
+ attr_accessor :display_name
9608
+
9609
+ # The `Status` type defines a logical error model that is suitable for different
9610
+ # programming environments, including REST APIs and RPC APIs. It is used by [
9611
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
9612
+ # data: error code, error message, and error details. You can find out more
9613
+ # about this error model and how to work with it in the [API Design Guide](https:
9614
+ # //cloud.google.com/apis/design/errors).
9615
+ # Corresponds to the JSON property `error`
9616
+ # @return [Google::Apis::AiplatformV1beta1::GoogleRpcStatus]
9617
+ attr_accessor :error
9618
+
9619
+ # Required. The type of the EvaluationItem.
9620
+ # Corresponds to the JSON property `evaluationItemType`
9621
+ # @return [String]
9622
+ attr_accessor :evaluation_item_type
9623
+
9624
+ # Single evaluation request.
9625
+ # Corresponds to the JSON property `evaluationRequest`
9626
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRequest]
9627
+ attr_accessor :evaluation_request
9628
+
9629
+ # Evaluation result.
9630
+ # Corresponds to the JSON property `evaluationResponse`
9631
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationResult]
9632
+ attr_accessor :evaluation_response
9633
+
9634
+ # The GCS object where the request or response is stored.
9635
+ # Corresponds to the JSON property `gcsUri`
9636
+ # @return [String]
9637
+ attr_accessor :gcs_uri
9638
+
9639
+ # Optional. Labels for the EvaluationItem.
9640
+ # Corresponds to the JSON property `labels`
9641
+ # @return [Hash<String,String>]
9642
+ attr_accessor :labels
9643
+
9644
+ # Optional. Metadata for the EvaluationItem.
9645
+ # Corresponds to the JSON property `metadata`
9646
+ # @return [Object]
9647
+ attr_accessor :metadata
9648
+
9649
+ # Identifier. The resource name of the EvaluationItem. Format: `projects/`
9650
+ # project`/locations/`location`/evaluationItems/`evaluation_item``
9651
+ # Corresponds to the JSON property `name`
9652
+ # @return [String]
9653
+ attr_accessor :name
9654
+
9655
+ def initialize(**args)
9656
+ update!(**args)
9657
+ end
9658
+
9659
+ # Update properties of this object
9660
+ def update!(**args)
9661
+ @create_time = args[:create_time] if args.key?(:create_time)
9662
+ @display_name = args[:display_name] if args.key?(:display_name)
9663
+ @error = args[:error] if args.key?(:error)
9664
+ @evaluation_item_type = args[:evaluation_item_type] if args.key?(:evaluation_item_type)
9665
+ @evaluation_request = args[:evaluation_request] if args.key?(:evaluation_request)
9666
+ @evaluation_response = args[:evaluation_response] if args.key?(:evaluation_response)
9667
+ @gcs_uri = args[:gcs_uri] if args.key?(:gcs_uri)
9668
+ @labels = args[:labels] if args.key?(:labels)
9669
+ @metadata = args[:metadata] if args.key?(:metadata)
9670
+ @name = args[:name] if args.key?(:name)
9671
+ end
9672
+ end
9673
+
9674
+ # Prompt to be evaluated.
9675
+ class GoogleCloudAiplatformV1beta1EvaluationPrompt
9676
+ include Google::Apis::Core::Hashable
9677
+
9678
+ # Message to hold a prompt template and the values to populate the template.
9679
+ # Corresponds to the JSON property `promptTemplateData`
9680
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationPromptPromptTemplateData]
9681
+ attr_accessor :prompt_template_data
9682
+
9683
+ # Text prompt.
9684
+ # Corresponds to the JSON property `text`
9685
+ # @return [String]
9686
+ attr_accessor :text
9687
+
9688
+ # Fields and values that can be used to populate the prompt template.
9689
+ # Corresponds to the JSON property `value`
9690
+ # @return [Object]
9691
+ attr_accessor :value
9692
+
9693
+ def initialize(**args)
9694
+ update!(**args)
9695
+ end
9696
+
9697
+ # Update properties of this object
9698
+ def update!(**args)
9699
+ @prompt_template_data = args[:prompt_template_data] if args.key?(:prompt_template_data)
9700
+ @text = args[:text] if args.key?(:text)
9701
+ @value = args[:value] if args.key?(:value)
9702
+ end
9703
+ end
9704
+
9705
+ # Message to hold a prompt template and the values to populate the template.
9706
+ class GoogleCloudAiplatformV1beta1EvaluationPromptPromptTemplateData
9707
+ include Google::Apis::Core::Hashable
9708
+
9709
+ # The values for fields in the prompt template.
9710
+ # Corresponds to the JSON property `values`
9711
+ # @return [Hash<String,Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content>]
9712
+ attr_accessor :values
9713
+
9714
+ def initialize(**args)
9715
+ update!(**args)
9716
+ end
9717
+
9718
+ # Update properties of this object
9719
+ def update!(**args)
9720
+ @values = args[:values] if args.key?(:values)
9721
+ end
9722
+ end
9723
+
9724
+ # Single evaluation request.
9725
+ class GoogleCloudAiplatformV1beta1EvaluationRequest
9726
+ include Google::Apis::Core::Hashable
9727
+
9728
+ # Optional. Responses from model under test and other baseline models for
9729
+ # comparison.
9730
+ # Corresponds to the JSON property `candidateResponses`
9731
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CandidateResponse>]
9732
+ attr_accessor :candidate_responses
9733
+
9734
+ # Responses from model or agent.
9735
+ # Corresponds to the JSON property `goldenResponse`
9736
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CandidateResponse]
9737
+ attr_accessor :golden_response
9738
+
9739
+ # Prompt to be evaluated.
9740
+ # Corresponds to the JSON property `prompt`
9741
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationPrompt]
9742
+ attr_accessor :prompt
9743
+
9744
+ # Optional. Named groups of rubrics associated with this prompt. The key is a
9745
+ # user-defined name for the rubric group.
9746
+ # Corresponds to the JSON property `rubrics`
9747
+ # @return [Hash<String,Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RubricGroup>]
9748
+ attr_accessor :rubrics
9749
+
9750
+ def initialize(**args)
9751
+ update!(**args)
9752
+ end
9753
+
9754
+ # Update properties of this object
9755
+ def update!(**args)
9756
+ @candidate_responses = args[:candidate_responses] if args.key?(:candidate_responses)
9757
+ @golden_response = args[:golden_response] if args.key?(:golden_response)
9758
+ @prompt = args[:prompt] if args.key?(:prompt)
9759
+ @rubrics = args[:rubrics] if args.key?(:rubrics)
9760
+ end
9761
+ end
9762
+
9763
+ # Evaluation result.
9764
+ class GoogleCloudAiplatformV1beta1EvaluationResult
9765
+ include Google::Apis::Core::Hashable
9766
+
9767
+ # Optional. The results for the metric.
9768
+ # Corresponds to the JSON property `candidateResults`
9769
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CandidateResult>]
9770
+ attr_accessor :candidate_results
9771
+
9772
+ # Required. The request item that was evaluated. Format: projects/`project`/
9773
+ # locations/`location`/evaluationItems/`evaluation_item`
9774
+ # Corresponds to the JSON property `evaluationRequest`
9775
+ # @return [String]
9776
+ attr_accessor :evaluation_request
9777
+
9778
+ # Required. The evaluation run that was used to generate the result. Format:
9779
+ # projects/`project`/locations/`location`/evaluationRuns/`evaluation_run`
9780
+ # Corresponds to the JSON property `evaluationRun`
9781
+ # @return [String]
9782
+ attr_accessor :evaluation_run
9783
+
9784
+ # Optional. Metadata about the evaluation result.
9785
+ # Corresponds to the JSON property `metadata`
9786
+ # @return [Object]
9787
+ attr_accessor :metadata
9788
+
9789
+ # Required. The metric that was evaluated.
9790
+ # Corresponds to the JSON property `metric`
9791
+ # @return [String]
9792
+ attr_accessor :metric
9793
+
9794
+ # Single evaluation request.
9795
+ # Corresponds to the JSON property `request`
9796
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRequest]
9797
+ attr_accessor :request
9798
+
9799
+ def initialize(**args)
9800
+ update!(**args)
9801
+ end
9802
+
9803
+ # Update properties of this object
9804
+ def update!(**args)
9805
+ @candidate_results = args[:candidate_results] if args.key?(:candidate_results)
9806
+ @evaluation_request = args[:evaluation_request] if args.key?(:evaluation_request)
9807
+ @evaluation_run = args[:evaluation_run] if args.key?(:evaluation_run)
9808
+ @metadata = args[:metadata] if args.key?(:metadata)
9809
+ @metric = args[:metric] if args.key?(:metric)
9810
+ @request = args[:request] if args.key?(:request)
9811
+ end
9812
+ end
9813
+
9814
+ # The results of the evaluation run.
9815
+ class GoogleCloudAiplatformV1beta1EvaluationResults
9816
+ include Google::Apis::Core::Hashable
9817
+
9818
+ # The evaluation set where item level results are stored.
9819
+ # Corresponds to the JSON property `evaluationSet`
9820
+ # @return [String]
9821
+ attr_accessor :evaluation_set
9822
+
9823
+ # The summary metrics for the evaluation run.
9824
+ # Corresponds to the JSON property `summaryMetrics`
9825
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SummaryMetrics]
9826
+ attr_accessor :summary_metrics
9827
+
9828
+ def initialize(**args)
9829
+ update!(**args)
9830
+ end
9831
+
9832
+ # Update properties of this object
9833
+ def update!(**args)
9834
+ @evaluation_set = args[:evaluation_set] if args.key?(:evaluation_set)
9835
+ @summary_metrics = args[:summary_metrics] if args.key?(:summary_metrics)
9836
+ end
9837
+ end
9838
+
9839
+ # Configuration for a rubric group to be generated/saved for evaluation.
9840
+ class GoogleCloudAiplatformV1beta1EvaluationRubricConfig
9841
+ include Google::Apis::Core::Hashable
9842
+
9843
+ # Specification for a pre-defined metric.
9844
+ # Corresponds to the JSON property `predefinedRubricGenerationSpec`
9845
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunMetricPredefinedMetricSpec]
9846
+ attr_accessor :predefined_rubric_generation_spec
9847
+
9848
+ # Specification for how rubrics should be generated.
9849
+ # Corresponds to the JSON property `rubricGenerationSpec`
9850
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricGenerationSpec]
9851
+ attr_accessor :rubric_generation_spec
9852
+
9853
+ # Required. The key used to save the generated rubrics. If a generation spec is
9854
+ # provided, this key will be used for the name of the generated rubric group.
9855
+ # Otherwise, this key will be used to look up the existing rubric group on the
9856
+ # evaluation item. Note that if a rubric group key is specified on both a rubric
9857
+ # config and an evaluation metric, the key from the metric will be used to
9858
+ # select the rubrics for evaluation.
9859
+ # Corresponds to the JSON property `rubricGroupKey`
9860
+ # @return [String]
9861
+ attr_accessor :rubric_group_key
9862
+
9863
+ def initialize(**args)
9864
+ update!(**args)
9865
+ end
9866
+
9867
+ # Update properties of this object
9868
+ def update!(**args)
9869
+ @predefined_rubric_generation_spec = args[:predefined_rubric_generation_spec] if args.key?(:predefined_rubric_generation_spec)
9870
+ @rubric_generation_spec = args[:rubric_generation_spec] if args.key?(:rubric_generation_spec)
9871
+ @rubric_group_key = args[:rubric_group_key] if args.key?(:rubric_group_key)
9872
+ end
9873
+ end
9874
+
9875
+ # EvaluationRun is a resource that represents a single evaluation run, which
9876
+ # includes a set of prompts, model responses, evaluation configuration and the
9877
+ # resulting metrics.
9878
+ class GoogleCloudAiplatformV1beta1EvaluationRun
9879
+ include Google::Apis::Core::Hashable
9880
+
9881
+ # Output only. Time when the evaluation run was completed.
9882
+ # Corresponds to the JSON property `completionTime`
9883
+ # @return [String]
9884
+ attr_accessor :completion_time
9885
+
9886
+ # Output only. Time when the evaluation run was created.
9887
+ # Corresponds to the JSON property `createTime`
9888
+ # @return [String]
9889
+ attr_accessor :create_time
9890
+
9891
+ # The data source for the evaluation run.
9892
+ # Corresponds to the JSON property `dataSource`
9893
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunDataSource]
9894
+ attr_accessor :data_source
9895
+
9896
+ # Required. The display name of the Evaluation Run.
9897
+ # Corresponds to the JSON property `displayName`
9898
+ # @return [String]
9899
+ attr_accessor :display_name
9900
+
9901
+ # The `Status` type defines a logical error model that is suitable for different
9902
+ # programming environments, including REST APIs and RPC APIs. It is used by [
9903
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
9904
+ # data: error code, error message, and error details. You can find out more
9905
+ # about this error model and how to work with it in the [API Design Guide](https:
9906
+ # //cloud.google.com/apis/design/errors).
9907
+ # Corresponds to the JSON property `error`
9908
+ # @return [Google::Apis::AiplatformV1beta1::GoogleRpcStatus]
9909
+ attr_accessor :error
9910
+
9911
+ # The Evalution configuration used for the evaluation run.
9912
+ # Corresponds to the JSON property `evaluationConfig`
9913
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfig]
9914
+ attr_accessor :evaluation_config
9915
+
9916
+ # The results of the evaluation run.
9917
+ # Corresponds to the JSON property `evaluationResults`
9918
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationResults]
9919
+ attr_accessor :evaluation_results
9920
+
9921
+ # Output only. The specific evaluation set of the evaluation run. For runs with
9922
+ # an evaluation set input, this will be that same set. For runs with BigQuery
9923
+ # input, it's the sampled BigQuery dataset.
9924
+ # Corresponds to the JSON property `evaluationSetSnapshot`
9925
+ # @return [String]
9926
+ attr_accessor :evaluation_set_snapshot
9927
+
9928
+ # Optional. The candidate to inference config map for the evaluation run. The
9929
+ # candidate can be up to 128 characters long and can consist of any UTF-8
9930
+ # characters.
9931
+ # Corresponds to the JSON property `inferenceConfigs`
9932
+ # @return [Hash<String,Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfig>]
9933
+ attr_accessor :inference_configs
9934
+
9935
+ # Optional. Labels for the evaluation run.
9936
+ # Corresponds to the JSON property `labels`
9937
+ # @return [Hash<String,String>]
9938
+ attr_accessor :labels
9939
+
9940
+ # Optional. Metadata about the evaluation run, can be used by the caller to
9941
+ # store additional tracking information about the evaluation run.
9942
+ # Corresponds to the JSON property `metadata`
9943
+ # @return [Object]
9944
+ attr_accessor :metadata
9945
+
9946
+ # Identifier. The resource name of the EvaluationRun. This is a unique
9947
+ # identifier. Format: `projects/`project`/locations/`location`/evaluationRuns/`
9948
+ # evaluation_run``
9949
+ # Corresponds to the JSON property `name`
9950
+ # @return [String]
9951
+ attr_accessor :name
9952
+
9953
+ # Output only. The state of the evaluation run.
9954
+ # Corresponds to the JSON property `state`
9955
+ # @return [String]
9956
+ attr_accessor :state
9957
+
9958
+ def initialize(**args)
9959
+ update!(**args)
9960
+ end
9961
+
9962
+ # Update properties of this object
9963
+ def update!(**args)
9964
+ @completion_time = args[:completion_time] if args.key?(:completion_time)
9965
+ @create_time = args[:create_time] if args.key?(:create_time)
9966
+ @data_source = args[:data_source] if args.key?(:data_source)
9967
+ @display_name = args[:display_name] if args.key?(:display_name)
9968
+ @error = args[:error] if args.key?(:error)
9969
+ @evaluation_config = args[:evaluation_config] if args.key?(:evaluation_config)
9970
+ @evaluation_results = args[:evaluation_results] if args.key?(:evaluation_results)
9971
+ @evaluation_set_snapshot = args[:evaluation_set_snapshot] if args.key?(:evaluation_set_snapshot)
9972
+ @inference_configs = args[:inference_configs] if args.key?(:inference_configs)
9973
+ @labels = args[:labels] if args.key?(:labels)
9974
+ @metadata = args[:metadata] if args.key?(:metadata)
9975
+ @name = args[:name] if args.key?(:name)
9976
+ @state = args[:state] if args.key?(:state)
9977
+ end
9978
+ end
9979
+
9980
+ # The data source for the evaluation run.
9981
+ class GoogleCloudAiplatformV1beta1EvaluationRunDataSource
9982
+ include Google::Apis::Core::Hashable
9983
+
9984
+ # The request set for the evaluation run.
9985
+ # Corresponds to the JSON property `bigqueryRequestSet`
9986
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BigQueryRequestSet]
9987
+ attr_accessor :bigquery_request_set
9988
+
9989
+ # The EvaluationSet resource name. Format: `projects/`project`/locations/`
9990
+ # location`/evaluationSets/`evaluation_set``
9991
+ # Corresponds to the JSON property `evaluationSet`
9992
+ # @return [String]
9993
+ attr_accessor :evaluation_set
9994
+
9995
+ def initialize(**args)
9996
+ update!(**args)
9997
+ end
9998
+
9999
+ # Update properties of this object
10000
+ def update!(**args)
10001
+ @bigquery_request_set = args[:bigquery_request_set] if args.key?(:bigquery_request_set)
10002
+ @evaluation_set = args[:evaluation_set] if args.key?(:evaluation_set)
10003
+ end
10004
+ end
10005
+
10006
+ # The Evalution configuration used for the evaluation run.
10007
+ class GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfig
10008
+ include Google::Apis::Core::Hashable
10009
+
10010
+ # The autorater config used for the evaluation run.
10011
+ # Corresponds to the JSON property `autoraterConfig`
10012
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigAutoraterConfig]
10013
+ attr_accessor :autorater_config
10014
+
10015
+ # Required. The metrics to be calculated in the evaluation run.
10016
+ # Corresponds to the JSON property `metrics`
10017
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunMetric>]
10018
+ attr_accessor :metrics
10019
+
10020
+ # The output config for the evaluation run.
10021
+ # Corresponds to the JSON property `outputConfig`
10022
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigOutputConfig]
10023
+ attr_accessor :output_config
10024
+
10025
+ # Prompt template used for inference.
10026
+ # Corresponds to the JSON property `promptTemplate`
10027
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigPromptTemplate]
10028
+ attr_accessor :prompt_template
10029
+
10030
+ # Optional. The rubric configs for the evaluation run. They are used to generate
10031
+ # rubrics which can be used by rubric-based metrics. Multiple rubric configs can
10032
+ # be specified for rubric generation but only one rubric config can be used for
10033
+ # a rubric-based metric. If more than one rubric config is provided, the
10034
+ # evaluation metric must specify a rubric group key. Note that if a generation
10035
+ # spec is specified on both a rubric config and an evaluation metric, the
10036
+ # rubrics generated for the metric will be used for evaluation.
10037
+ # Corresponds to the JSON property `rubricConfigs`
10038
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRubricConfig>]
10039
+ attr_accessor :rubric_configs
10040
+
10041
+ def initialize(**args)
10042
+ update!(**args)
10043
+ end
10044
+
10045
+ # Update properties of this object
10046
+ def update!(**args)
10047
+ @autorater_config = args[:autorater_config] if args.key?(:autorater_config)
10048
+ @metrics = args[:metrics] if args.key?(:metrics)
10049
+ @output_config = args[:output_config] if args.key?(:output_config)
10050
+ @prompt_template = args[:prompt_template] if args.key?(:prompt_template)
10051
+ @rubric_configs = args[:rubric_configs] if args.key?(:rubric_configs)
10052
+ end
10053
+ end
10054
+
10055
+ # The autorater config used for the evaluation run.
10056
+ class GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigAutoraterConfig
10057
+ include Google::Apis::Core::Hashable
10058
+
10059
+ # Optional. The fully qualified name of the publisher model or tuned autorater
10060
+ # endpoint to use. Publisher model format: `projects/`project`/locations/`
10061
+ # location`/publishers/*/models/*` Tuned model endpoint format: `projects/`
10062
+ # project`/locations/`location`/endpoints/`endpoint``
10063
+ # Corresponds to the JSON property `autoraterModel`
10064
+ # @return [String]
10065
+ attr_accessor :autorater_model
10066
+
10067
+ # Generation config.
10068
+ # Corresponds to the JSON property `generationConfig`
10069
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig]
10070
+ attr_accessor :generation_config
10071
+
10072
+ # Optional. Number of samples for each instance in the dataset. If not specified,
10073
+ # the default is 4. Minimum value is 1, maximum value is 32.
10074
+ # Corresponds to the JSON property `sampleCount`
10075
+ # @return [Fixnum]
10076
+ attr_accessor :sample_count
10077
+
10078
+ def initialize(**args)
10079
+ update!(**args)
10080
+ end
10081
+
10082
+ # Update properties of this object
10083
+ def update!(**args)
10084
+ @autorater_model = args[:autorater_model] if args.key?(:autorater_model)
10085
+ @generation_config = args[:generation_config] if args.key?(:generation_config)
10086
+ @sample_count = args[:sample_count] if args.key?(:sample_count)
10087
+ end
10088
+ end
10089
+
10090
+ # The output config for the evaluation run.
10091
+ class GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigOutputConfig
10092
+ include Google::Apis::Core::Hashable
10093
+
10094
+ # The BigQuery location for the output content.
10095
+ # Corresponds to the JSON property `bigqueryDestination`
10096
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BigQueryDestination]
10097
+ attr_accessor :bigquery_destination
10098
+
10099
+ # The Google Cloud Storage location where the output is to be written to.
10100
+ # Corresponds to the JSON property `gcsDestination`
10101
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GcsDestination]
10102
+ attr_accessor :gcs_destination
10103
+
10104
+ def initialize(**args)
10105
+ update!(**args)
10106
+ end
10107
+
10108
+ # Update properties of this object
10109
+ def update!(**args)
10110
+ @bigquery_destination = args[:bigquery_destination] if args.key?(:bigquery_destination)
10111
+ @gcs_destination = args[:gcs_destination] if args.key?(:gcs_destination)
10112
+ end
10113
+ end
10114
+
10115
+ # Prompt template used for inference.
10116
+ class GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigPromptTemplate
10117
+ include Google::Apis::Core::Hashable
10118
+
10119
+ # Prompt template stored in Cloud Storage. Format: "gs://my-bucket/file-name.txt"
10120
+ # .
10121
+ # Corresponds to the JSON property `gcsUri`
10122
+ # @return [String]
10123
+ attr_accessor :gcs_uri
10124
+
10125
+ # Inline prompt template. Template variables should be in the format "`var_name`"
10126
+ # . Example: "Translate the following from `source_lang` to `target_lang`: `text`
10127
+ # "
10128
+ # Corresponds to the JSON property `promptTemplate`
10129
+ # @return [String]
10130
+ attr_accessor :prompt_template
10131
+
10132
+ def initialize(**args)
10133
+ update!(**args)
10134
+ end
10135
+
10136
+ # Update properties of this object
10137
+ def update!(**args)
10138
+ @gcs_uri = args[:gcs_uri] if args.key?(:gcs_uri)
10139
+ @prompt_template = args[:prompt_template] if args.key?(:prompt_template)
10140
+ end
10141
+ end
10142
+
10143
+ # An inference config used for model inference during the evaluation run.
10144
+ class GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfig
10145
+ include Google::Apis::Core::Hashable
10146
+
10147
+ # Generation config.
10148
+ # Corresponds to the JSON property `generationConfig`
10149
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig]
10150
+ attr_accessor :generation_config
10151
+
10152
+ # Required. The fully qualified name of the publisher model or endpoint to use.
10153
+ # Publisher model format: `projects/`project`/locations/`location`/publishers/*/
10154
+ # models/*` Endpoint format: `projects/`project`/locations/`location`/endpoints/`
10155
+ # endpoint``
10156
+ # Corresponds to the JSON property `model`
10157
+ # @return [String]
10158
+ attr_accessor :model
10159
+
10160
+ def initialize(**args)
10161
+ update!(**args)
10162
+ end
10163
+
10164
+ # Update properties of this object
10165
+ def update!(**args)
10166
+ @generation_config = args[:generation_config] if args.key?(:generation_config)
10167
+ @model = args[:model] if args.key?(:model)
10168
+ end
10169
+ end
10170
+
10171
+ # The metric used for evaluation runs.
10172
+ class GoogleCloudAiplatformV1beta1EvaluationRunMetric
10173
+ include Google::Apis::Core::Hashable
10174
+
10175
+ # Specification for a computation based metric.
10176
+ # Corresponds to the JSON property `computationBasedMetricSpec`
10177
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunMetricComputationBasedMetricSpec]
10178
+ attr_accessor :computation_based_metric_spec
10179
+
10180
+ # Specification for an LLM based metric.
10181
+ # Corresponds to the JSON property `llmBasedMetricSpec`
10182
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunMetricLlmBasedMetricSpec]
10183
+ attr_accessor :llm_based_metric_spec
10184
+
10185
+ # Required. The name of the metric.
10186
+ # Corresponds to the JSON property `metric`
10187
+ # @return [String]
10188
+ attr_accessor :metric
10189
+
10190
+ # Specification for a pre-defined metric.
10191
+ # Corresponds to the JSON property `predefinedMetricSpec`
10192
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunMetricPredefinedMetricSpec]
10193
+ attr_accessor :predefined_metric_spec
10194
+
10195
+ # Specification for a metric that is based on rubrics.
10196
+ # Corresponds to the JSON property `rubricBasedMetricSpec`
10197
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricBasedMetricSpec]
10198
+ attr_accessor :rubric_based_metric_spec
10199
+
10200
+ def initialize(**args)
10201
+ update!(**args)
10202
+ end
10203
+
10204
+ # Update properties of this object
10205
+ def update!(**args)
10206
+ @computation_based_metric_spec = args[:computation_based_metric_spec] if args.key?(:computation_based_metric_spec)
10207
+ @llm_based_metric_spec = args[:llm_based_metric_spec] if args.key?(:llm_based_metric_spec)
10208
+ @metric = args[:metric] if args.key?(:metric)
10209
+ @predefined_metric_spec = args[:predefined_metric_spec] if args.key?(:predefined_metric_spec)
10210
+ @rubric_based_metric_spec = args[:rubric_based_metric_spec] if args.key?(:rubric_based_metric_spec)
10211
+ end
10212
+ end
10213
+
10214
+ # Specification for a computation based metric.
10215
+ class GoogleCloudAiplatformV1beta1EvaluationRunMetricComputationBasedMetricSpec
10216
+ include Google::Apis::Core::Hashable
10217
+
10218
+ # Optional. A map of parameters for the metric, e.g. `"rouge_type": "rougeL"`.
10219
+ # Corresponds to the JSON property `parameters`
10220
+ # @return [Hash<String,Object>]
10221
+ attr_accessor :parameters
10222
+
10223
+ # Required. The type of the computation based metric.
10224
+ # Corresponds to the JSON property `type`
10225
+ # @return [String]
10226
+ attr_accessor :type
10227
+
10228
+ def initialize(**args)
10229
+ update!(**args)
10230
+ end
10231
+
10232
+ # Update properties of this object
10233
+ def update!(**args)
10234
+ @parameters = args[:parameters] if args.key?(:parameters)
10235
+ @type = args[:type] if args.key?(:type)
10236
+ end
10237
+ end
10238
+
10239
+ # Specification for an LLM based metric.
10240
+ class GoogleCloudAiplatformV1beta1EvaluationRunMetricLlmBasedMetricSpec
10241
+ include Google::Apis::Core::Hashable
10242
+
10243
+ # Optional. Optional additional configuration for the metric.
10244
+ # Corresponds to the JSON property `additionalConfig`
10245
+ # @return [Hash<String,Object>]
10246
+ attr_accessor :additional_config
10247
+
10248
+ # The autorater config used for the evaluation run.
10249
+ # Corresponds to the JSON property `judgeAutoraterConfig`
10250
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigAutoraterConfig]
10251
+ attr_accessor :judge_autorater_config
10252
+
10253
+ # Required. Template for the prompt sent to the judge model.
10254
+ # Corresponds to the JSON property `metricPromptTemplate`
10255
+ # @return [String]
10256
+ attr_accessor :metric_prompt_template
10257
+
10258
+ # Specification for a pre-defined metric.
10259
+ # Corresponds to the JSON property `predefinedRubricGenerationSpec`
10260
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunMetricPredefinedMetricSpec]
10261
+ attr_accessor :predefined_rubric_generation_spec
10262
+
10263
+ # Specification for how rubrics should be generated.
10264
+ # Corresponds to the JSON property `rubricGenerationSpec`
10265
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricGenerationSpec]
10266
+ attr_accessor :rubric_generation_spec
10267
+
10268
+ # Use a pre-defined group of rubrics associated with the input. Refers to a key
10269
+ # in the rubric_groups map of EvaluationInstance.
10270
+ # Corresponds to the JSON property `rubricGroupKey`
10271
+ # @return [String]
10272
+ attr_accessor :rubric_group_key
10273
+
10274
+ # Optional. System instructions for the judge model.
10275
+ # Corresponds to the JSON property `systemInstruction`
10276
+ # @return [String]
10277
+ attr_accessor :system_instruction
10278
+
10279
+ def initialize(**args)
10280
+ update!(**args)
10281
+ end
10282
+
10283
+ # Update properties of this object
10284
+ def update!(**args)
10285
+ @additional_config = args[:additional_config] if args.key?(:additional_config)
10286
+ @judge_autorater_config = args[:judge_autorater_config] if args.key?(:judge_autorater_config)
10287
+ @metric_prompt_template = args[:metric_prompt_template] if args.key?(:metric_prompt_template)
10288
+ @predefined_rubric_generation_spec = args[:predefined_rubric_generation_spec] if args.key?(:predefined_rubric_generation_spec)
10289
+ @rubric_generation_spec = args[:rubric_generation_spec] if args.key?(:rubric_generation_spec)
10290
+ @rubric_group_key = args[:rubric_group_key] if args.key?(:rubric_group_key)
10291
+ @system_instruction = args[:system_instruction] if args.key?(:system_instruction)
10292
+ end
10293
+ end
10294
+
10295
+ # Specification for a pre-defined metric.
10296
+ class GoogleCloudAiplatformV1beta1EvaluationRunMetricPredefinedMetricSpec
10297
+ include Google::Apis::Core::Hashable
10298
+
10299
+ # Required. The name of a pre-defined metric, such as "instruction_following_v1"
10300
+ # or "text_quality_v1".
10301
+ # Corresponds to the JSON property `metricSpecName`
10302
+ # @return [String]
10303
+ attr_accessor :metric_spec_name
10304
+
10305
+ # Optional. The parameters needed to run the pre-defined metric.
10306
+ # Corresponds to the JSON property `parameters`
10307
+ # @return [Hash<String,Object>]
10308
+ attr_accessor :parameters
10309
+
10310
+ def initialize(**args)
10311
+ update!(**args)
10312
+ end
10313
+
10314
+ # Update properties of this object
10315
+ def update!(**args)
10316
+ @metric_spec_name = args[:metric_spec_name] if args.key?(:metric_spec_name)
10317
+ @parameters = args[:parameters] if args.key?(:parameters)
10318
+ end
10319
+ end
10320
+
10321
+ # Specification for a metric that is based on rubrics.
10322
+ class GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricBasedMetricSpec
10323
+ include Google::Apis::Core::Hashable
10324
+
10325
+ # Defines a list of rubrics, used when providing rubrics inline.
10326
+ # Corresponds to the JSON property `inlineRubrics`
10327
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricBasedMetricSpecRepeatedRubrics]
10328
+ attr_accessor :inline_rubrics
10329
+
10330
+ # The autorater config used for the evaluation run.
10331
+ # Corresponds to the JSON property `judgeAutoraterConfig`
10332
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigAutoraterConfig]
10333
+ attr_accessor :judge_autorater_config
10334
+
10335
+ # Optional. Template for the prompt used by the judge model to evaluate against
10336
+ # rubrics.
10337
+ # Corresponds to the JSON property `metricPromptTemplate`
10338
+ # @return [String]
10339
+ attr_accessor :metric_prompt_template
10340
+
10341
+ # Specification for how rubrics should be generated.
10342
+ # Corresponds to the JSON property `rubricGenerationSpec`
10343
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricGenerationSpec]
10344
+ attr_accessor :rubric_generation_spec
10345
+
10346
+ # Use a pre-defined group of rubrics associated with the input content. This
10347
+ # refers to a key in the `rubric_groups` map of `RubricEnhancedContents`.
10348
+ # Corresponds to the JSON property `rubricGroupKey`
10349
+ # @return [String]
10350
+ attr_accessor :rubric_group_key
10351
+
10352
+ def initialize(**args)
10353
+ update!(**args)
10354
+ end
10355
+
10356
+ # Update properties of this object
10357
+ def update!(**args)
10358
+ @inline_rubrics = args[:inline_rubrics] if args.key?(:inline_rubrics)
10359
+ @judge_autorater_config = args[:judge_autorater_config] if args.key?(:judge_autorater_config)
10360
+ @metric_prompt_template = args[:metric_prompt_template] if args.key?(:metric_prompt_template)
10361
+ @rubric_generation_spec = args[:rubric_generation_spec] if args.key?(:rubric_generation_spec)
10362
+ @rubric_group_key = args[:rubric_group_key] if args.key?(:rubric_group_key)
10363
+ end
10364
+ end
10365
+
10366
+ # Defines a list of rubrics, used when providing rubrics inline.
10367
+ class GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricBasedMetricSpecRepeatedRubrics
10368
+ include Google::Apis::Core::Hashable
10369
+
10370
+ # The list of rubrics.
10371
+ # Corresponds to the JSON property `rubrics`
10372
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Rubric>]
10373
+ attr_accessor :rubrics
10374
+
10375
+ def initialize(**args)
10376
+ update!(**args)
10377
+ end
10378
+
10379
+ # Update properties of this object
10380
+ def update!(**args)
10381
+ @rubrics = args[:rubrics] if args.key?(:rubrics)
10382
+ end
10383
+ end
10384
+
10385
+ # Specification for how rubrics should be generated.
10386
+ class GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricGenerationSpec
10387
+ include Google::Apis::Core::Hashable
10388
+
10389
+ # The autorater config used for the evaluation run.
10390
+ # Corresponds to the JSON property `modelConfig`
10391
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigAutoraterConfig]
10392
+ attr_accessor :model_config
10393
+
10394
+ # Optional. Template for the prompt used to generate rubrics. The details should
10395
+ # be updated based on the most-recent recipe requirements.
10396
+ # Corresponds to the JSON property `promptTemplate`
10397
+ # @return [String]
10398
+ attr_accessor :prompt_template
10399
+
10400
+ # Optional. The type of rubric content to be generated.
10401
+ # Corresponds to the JSON property `rubricContentType`
10402
+ # @return [String]
10403
+ attr_accessor :rubric_content_type
10404
+
10405
+ # Optional. An optional, pre-defined list of allowed types for generated rubrics.
10406
+ # If this field is provided, it implies `include_rubric_type` should be true,
10407
+ # and the generated rubric types should be chosen from this ontology.
10408
+ # Corresponds to the JSON property `rubricTypeOntology`
10409
+ # @return [Array<String>]
10410
+ attr_accessor :rubric_type_ontology
10411
+
10412
+ def initialize(**args)
10413
+ update!(**args)
10414
+ end
10415
+
10416
+ # Update properties of this object
10417
+ def update!(**args)
10418
+ @model_config = args[:model_config] if args.key?(:model_config)
10419
+ @prompt_template = args[:prompt_template] if args.key?(:prompt_template)
10420
+ @rubric_content_type = args[:rubric_content_type] if args.key?(:rubric_content_type)
10421
+ @rubric_type_ontology = args[:rubric_type_ontology] if args.key?(:rubric_type_ontology)
10422
+ end
10423
+ end
10424
+
10425
+ # EvaluationSet is a collection of related EvaluationItems that are evaluated
10426
+ # together.
10427
+ class GoogleCloudAiplatformV1beta1EvaluationSet
10428
+ include Google::Apis::Core::Hashable
10429
+
10430
+ # Output only. Timestamp when this item was created.
10431
+ # Corresponds to the JSON property `createTime`
10432
+ # @return [String]
10433
+ attr_accessor :create_time
10434
+
10435
+ # Required. The display name of the EvaluationSet.
10436
+ # Corresponds to the JSON property `displayName`
10437
+ # @return [String]
10438
+ attr_accessor :display_name
10439
+
10440
+ # Required. The EvaluationItems that are part of this dataset.
10441
+ # Corresponds to the JSON property `evaluationItems`
10442
+ # @return [Array<String>]
10443
+ attr_accessor :evaluation_items
10444
+
10445
+ # Optional. Metadata for the EvaluationSet.
10446
+ # Corresponds to the JSON property `metadata`
10447
+ # @return [Object]
10448
+ attr_accessor :metadata
10449
+
10450
+ # Identifier. The resource name of the EvaluationSet. Format: `projects/`project`
10451
+ # /locations/`location`/evaluationSets/`evaluation_set``
10452
+ # Corresponds to the JSON property `name`
10453
+ # @return [String]
10454
+ attr_accessor :name
10455
+
10456
+ # Output only. Timestamp when this item was last updated.
10457
+ # Corresponds to the JSON property `updateTime`
10458
+ # @return [String]
10459
+ attr_accessor :update_time
10460
+
10461
+ def initialize(**args)
10462
+ update!(**args)
10463
+ end
10464
+
10465
+ # Update properties of this object
10466
+ def update!(**args)
10467
+ @create_time = args[:create_time] if args.key?(:create_time)
10468
+ @display_name = args[:display_name] if args.key?(:display_name)
10469
+ @evaluation_items = args[:evaluation_items] if args.key?(:evaluation_items)
10470
+ @metadata = args[:metadata] if args.key?(:metadata)
10471
+ @name = args[:name] if args.key?(:name)
10472
+ @update_time = args[:update_time] if args.key?(:update_time)
10473
+ end
10474
+ end
10475
+
9026
10476
  # An edge describing the relationship between an Artifact and an Execution in a
9027
10477
  # lineage graph.
9028
10478
  class GoogleCloudAiplatformV1beta1Event
@@ -9671,6 +11121,44 @@ module Google
9671
11121
  end
9672
11122
  end
9673
11123
 
11124
+ # Request message for SandboxEnvironmentExecutionService.Execute.
11125
+ class GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentRequest
11126
+ include Google::Apis::Core::Hashable
11127
+
11128
+ # Required. The inputs to the sandbox environment.
11129
+ # Corresponds to the JSON property `inputs`
11130
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Chunk>]
11131
+ attr_accessor :inputs
11132
+
11133
+ def initialize(**args)
11134
+ update!(**args)
11135
+ end
11136
+
11137
+ # Update properties of this object
11138
+ def update!(**args)
11139
+ @inputs = args[:inputs] if args.key?(:inputs)
11140
+ end
11141
+ end
11142
+
11143
+ # Response message for SandboxEnvironmentExecutionService.Execute.
11144
+ class GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentResponse
11145
+ include Google::Apis::Core::Hashable
11146
+
11147
+ # The outputs from the sandbox environment.
11148
+ # Corresponds to the JSON property `outputs`
11149
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Chunk>]
11150
+ attr_accessor :outputs
11151
+
11152
+ def initialize(**args)
11153
+ update!(**args)
11154
+ end
11155
+
11156
+ # Update properties of this object
11157
+ def update!(**args)
11158
+ @outputs = args[:outputs] if args.key?(:outputs)
11159
+ end
11160
+ end
11161
+
9674
11162
  # Instance of a general execution.
9675
11163
  class GoogleCloudAiplatformV1beta1Execution
9676
11164
  include Google::Apis::Core::Hashable
@@ -14926,6 +16414,11 @@ module Google
14926
16414
  # @return [Hash<String,String>]
14927
16415
  attr_accessor :labels
14928
16416
 
16417
+ # Configuration for Model Armor integrations of prompt and responses.
16418
+ # Corresponds to the JSON property `modelArmorConfig`
16419
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelArmorConfig]
16420
+ attr_accessor :model_armor_config
16421
+
14929
16422
  # Optional. Per request settings for blocking unsafe content. Enforced on
14930
16423
  # GenerateContentResponse.candidates.
14931
16424
  # Corresponds to the JSON property `safetySettings`
@@ -14963,6 +16456,7 @@ module Google
14963
16456
  @contents = args[:contents] if args.key?(:contents)
14964
16457
  @generation_config = args[:generation_config] if args.key?(:generation_config)
14965
16458
  @labels = args[:labels] if args.key?(:labels)
16459
+ @model_armor_config = args[:model_armor_config] if args.key?(:model_armor_config)
14966
16460
  @safety_settings = args[:safety_settings] if args.key?(:safety_settings)
14967
16461
  @system_instruction = args[:system_instruction] if args.key?(:system_instruction)
14968
16462
  @tool_config = args[:tool_config] if args.key?(:tool_config)
@@ -15136,7 +16630,59 @@ module Google
15136
16630
  end
15137
16631
  end
15138
16632
 
15139
- # Request message for MemoryBankService.GenerateMemories.
16633
+ # Request message for EvaluationService.GenerateInstanceRubrics.
16634
+ class GoogleCloudAiplatformV1beta1GenerateInstanceRubricsRequest
16635
+ include Google::Apis::Core::Hashable
16636
+
16637
+ # Required. The prompt to generate rubrics from. For single-turn queries, this
16638
+ # is a single instance. For multi-turn queries, this is a repeated field that
16639
+ # contains conversation history + latest request.
16640
+ # Corresponds to the JSON property `contents`
16641
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content>]
16642
+ attr_accessor :contents
16643
+
16644
+ # The spec for a pre-defined metric.
16645
+ # Corresponds to the JSON property `predefinedRubricGenerationSpec`
16646
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PredefinedMetricSpec]
16647
+ attr_accessor :predefined_rubric_generation_spec
16648
+
16649
+ # Specification for how rubrics should be generated.
16650
+ # Corresponds to the JSON property `rubricGenerationSpec`
16651
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RubricGenerationSpec]
16652
+ attr_accessor :rubric_generation_spec
16653
+
16654
+ def initialize(**args)
16655
+ update!(**args)
16656
+ end
16657
+
16658
+ # Update properties of this object
16659
+ def update!(**args)
16660
+ @contents = args[:contents] if args.key?(:contents)
16661
+ @predefined_rubric_generation_spec = args[:predefined_rubric_generation_spec] if args.key?(:predefined_rubric_generation_spec)
16662
+ @rubric_generation_spec = args[:rubric_generation_spec] if args.key?(:rubric_generation_spec)
16663
+ end
16664
+ end
16665
+
16666
+ # Response message for EvaluationService.GenerateInstanceRubrics.
16667
+ class GoogleCloudAiplatformV1beta1GenerateInstanceRubricsResponse
16668
+ include Google::Apis::Core::Hashable
16669
+
16670
+ # Output only. A list of generated rubrics.
16671
+ # Corresponds to the JSON property `generatedRubrics`
16672
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Rubric>]
16673
+ attr_accessor :generated_rubrics
16674
+
16675
+ def initialize(**args)
16676
+ update!(**args)
16677
+ end
16678
+
16679
+ # Update properties of this object
16680
+ def update!(**args)
16681
+ @generated_rubrics = args[:generated_rubrics] if args.key?(:generated_rubrics)
16682
+ end
16683
+ end
16684
+
16685
+ # Request message for MemoryBankService.GenerateMemories. Maximum size is 8 MB.
15140
16686
  class GoogleCloudAiplatformV1beta1GenerateMemoriesRequest
15141
16687
  include Google::Apis::Core::Hashable
15142
16688
 
@@ -15309,6 +16855,64 @@ module Google
15309
16855
  end
15310
16856
  end
15311
16857
 
16858
+ # Request message for DataFoundryService.GenerateSyntheticData.
16859
+ class GoogleCloudAiplatformV1beta1GenerateSyntheticDataRequest
16860
+ include Google::Apis::Core::Hashable
16861
+
16862
+ # Required. The number of synthetic examples to generate. For this stateless API,
16863
+ # the count is limited to a small number.
16864
+ # Corresponds to the JSON property `count`
16865
+ # @return [Fixnum]
16866
+ attr_accessor :count
16867
+
16868
+ # Optional. A list of few-shot examples to guide the model's output style and
16869
+ # format.
16870
+ # Corresponds to the JSON property `examples`
16871
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SyntheticExample>]
16872
+ attr_accessor :examples
16873
+
16874
+ # Required. The schema of the desired output, defined by a list of fields.
16875
+ # Corresponds to the JSON property `outputFieldSpecs`
16876
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1OutputFieldSpec>]
16877
+ attr_accessor :output_field_specs
16878
+
16879
+ # Defines a generation strategy based on a high-level task description.
16880
+ # Corresponds to the JSON property `taskDescription`
16881
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TaskDescriptionStrategy]
16882
+ attr_accessor :task_description
16883
+
16884
+ def initialize(**args)
16885
+ update!(**args)
16886
+ end
16887
+
16888
+ # Update properties of this object
16889
+ def update!(**args)
16890
+ @count = args[:count] if args.key?(:count)
16891
+ @examples = args[:examples] if args.key?(:examples)
16892
+ @output_field_specs = args[:output_field_specs] if args.key?(:output_field_specs)
16893
+ @task_description = args[:task_description] if args.key?(:task_description)
16894
+ end
16895
+ end
16896
+
16897
+ # The response containing the generated data.
16898
+ class GoogleCloudAiplatformV1beta1GenerateSyntheticDataResponse
16899
+ include Google::Apis::Core::Hashable
16900
+
16901
+ # A list of generated synthetic examples.
16902
+ # Corresponds to the JSON property `syntheticExamples`
16903
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SyntheticExample>]
16904
+ attr_accessor :synthetic_examples
16905
+
16906
+ def initialize(**args)
16907
+ update!(**args)
16908
+ end
16909
+
16910
+ # Update properties of this object
16911
+ def update!(**args)
16912
+ @synthetic_examples = args[:synthetic_examples] if args.key?(:synthetic_examples)
16913
+ end
16914
+ end
16915
+
15312
16916
  # Generate video response.
15313
16917
  class GoogleCloudAiplatformV1beta1GenerateVideoResponse
15314
16918
  include Google::Apis::Core::Hashable
@@ -15760,25 +17364,12 @@ module Google
15760
17364
  class GoogleCloudAiplatformV1beta1GoogleMaps
15761
17365
  include Google::Apis::Core::Hashable
15762
17366
 
15763
- # The generic reusable api auth config. Deprecated. Please use AuthConfig (
15764
- # google/cloud/aiplatform/master/auth.proto) instead.
15765
- # Corresponds to the JSON property `apiAuth`
15766
- # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ApiAuth]
15767
- attr_accessor :api_auth
15768
-
15769
- # Auth configuration to run the extension.
15770
- # Corresponds to the JSON property `authConfig`
15771
- # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AuthConfig]
15772
- attr_accessor :auth_config
15773
-
15774
17367
  def initialize(**args)
15775
17368
  update!(**args)
15776
17369
  end
15777
17370
 
15778
17371
  # Update properties of this object
15779
17372
  def update!(**args)
15780
- @api_auth = args[:api_auth] if args.key?(:api_auth)
15781
- @auth_config = args[:auth_config] if args.key?(:auth_config)
15782
17373
  end
15783
17374
  end
15784
17375
 
@@ -16082,6 +17673,12 @@ module Google
16082
17673
  class GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext
16083
17674
  include Google::Apis::Core::Hashable
16084
17675
 
17676
+ # Output only. The full document name for the referenced Vertex AI Search
17677
+ # document.
17678
+ # Corresponds to the JSON property `documentName`
17679
+ # @return [String]
17680
+ attr_accessor :document_name
17681
+
16085
17682
  # A RagChunk includes the content of a chunk of a RagFile, and associated
16086
17683
  # metadata.
16087
17684
  # Corresponds to the JSON property `ragChunk`
@@ -16109,6 +17706,7 @@ module Google
16109
17706
 
16110
17707
  # Update properties of this object
16111
17708
  def update!(**args)
17709
+ @document_name = args[:document_name] if args.key?(:document_name)
16112
17710
  @rag_chunk = args[:rag_chunk] if args.key?(:rag_chunk)
16113
17711
  @text = args[:text] if args.key?(:text)
16114
17712
  @title = args[:title] if args.key?(:title)
@@ -18276,6 +19874,81 @@ module Google
18276
19874
  end
18277
19875
  end
18278
19876
 
19877
+ # Response message for EvaluationManagementService.ListEvaluationItems.
19878
+ class GoogleCloudAiplatformV1beta1ListEvaluationItemsResponse
19879
+ include Google::Apis::Core::Hashable
19880
+
19881
+ # List of EvaluationItems in the requested page.
19882
+ # Corresponds to the JSON property `evaluationItems`
19883
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationItem>]
19884
+ attr_accessor :evaluation_items
19885
+
19886
+ # A token to retrieve the next page of results.
19887
+ # Corresponds to the JSON property `nextPageToken`
19888
+ # @return [String]
19889
+ attr_accessor :next_page_token
19890
+
19891
+ def initialize(**args)
19892
+ update!(**args)
19893
+ end
19894
+
19895
+ # Update properties of this object
19896
+ def update!(**args)
19897
+ @evaluation_items = args[:evaluation_items] if args.key?(:evaluation_items)
19898
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
19899
+ end
19900
+ end
19901
+
19902
+ # Response message for EvaluationManagementService.ListEvaluationRuns.
19903
+ class GoogleCloudAiplatformV1beta1ListEvaluationRunsResponse
19904
+ include Google::Apis::Core::Hashable
19905
+
19906
+ # List of EvaluationRuns in the requested page.
19907
+ # Corresponds to the JSON property `evaluationRuns`
19908
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRun>]
19909
+ attr_accessor :evaluation_runs
19910
+
19911
+ # A token to retrieve the next page of results.
19912
+ # Corresponds to the JSON property `nextPageToken`
19913
+ # @return [String]
19914
+ attr_accessor :next_page_token
19915
+
19916
+ def initialize(**args)
19917
+ update!(**args)
19918
+ end
19919
+
19920
+ # Update properties of this object
19921
+ def update!(**args)
19922
+ @evaluation_runs = args[:evaluation_runs] if args.key?(:evaluation_runs)
19923
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
19924
+ end
19925
+ end
19926
+
19927
+ # Response message for EvaluationManagementService.ListEvaluationSets.
19928
+ class GoogleCloudAiplatformV1beta1ListEvaluationSetsResponse
19929
+ include Google::Apis::Core::Hashable
19930
+
19931
+ # List of EvaluationSets in the requested page.
19932
+ # Corresponds to the JSON property `evaluationSets`
19933
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationSet>]
19934
+ attr_accessor :evaluation_sets
19935
+
19936
+ # A token to retrieve the next page of results.
19937
+ # Corresponds to the JSON property `nextPageToken`
19938
+ # @return [String]
19939
+ attr_accessor :next_page_token
19940
+
19941
+ def initialize(**args)
19942
+ update!(**args)
19943
+ end
19944
+
19945
+ # Update properties of this object
19946
+ def update!(**args)
19947
+ @evaluation_sets = args[:evaluation_sets] if args.key?(:evaluation_sets)
19948
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
19949
+ end
19950
+ end
19951
+
18279
19952
  # Response message for SessionService.ListEvents.
18280
19953
  class GoogleCloudAiplatformV1beta1ListEventsResponse
18281
19954
  include Google::Apis::Core::Hashable
@@ -19280,6 +20953,33 @@ module Google
19280
20953
  end
19281
20954
  end
19282
20955
 
20956
+ # Response message for SandboxEnvironmentService.ListSandboxEnvironments.
20957
+ class GoogleCloudAiplatformV1beta1ListSandboxEnvironmentsResponse
20958
+ include Google::Apis::Core::Hashable
20959
+
20960
+ # A token, which can be sent as ListSandboxEnvironmentsRequest.page_token to
20961
+ # retrieve the next page. Absence of this field indicates there are no
20962
+ # subsequent pages.
20963
+ # Corresponds to the JSON property `nextPageToken`
20964
+ # @return [String]
20965
+ attr_accessor :next_page_token
20966
+
20967
+ # The SandboxEnvironments matching the request.
20968
+ # Corresponds to the JSON property `sandboxEnvironments`
20969
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SandboxEnvironment>]
20970
+ attr_accessor :sandbox_environments
20971
+
20972
+ def initialize(**args)
20973
+ update!(**args)
20974
+ end
20975
+
20976
+ # Update properties of this object
20977
+ def update!(**args)
20978
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
20979
+ @sandbox_environments = args[:sandbox_environments] if args.key?(:sandbox_environments)
20980
+ end
20981
+ end
20982
+
19283
20983
  # Response message for DatasetService.ListSavedQueries.
19284
20984
  class GoogleCloudAiplatformV1beta1ListSavedQueriesResponse
19285
20985
  include Google::Apis::Core::Hashable
@@ -19703,6 +21403,19 @@ module Google
19703
21403
  # @return [String]
19704
21404
  attr_accessor :accelerator_type
19705
21405
 
21406
+ # Optional. Immutable. The Nvidia GPU partition size. When specified, the
21407
+ # requested accelerators will be partitioned into smaller GPU partitions. For
21408
+ # example, if the request is for 8 units of NVIDIA A100 GPUs, and
21409
+ # gpu_partition_size="1g.10gb", the service will create 8 * 7 = 56 partitioned
21410
+ # MIG instances. The partition size must be a value supported by the requested
21411
+ # accelerator. Refer to [Nvidia GPU Partitioning](https://cloud.google.com/
21412
+ # kubernetes-engine/docs/how-to/gpus-multi#multi-instance_gpu_partitions) for
21413
+ # the available partition sizes. If set, the accelerator_count should be set to
21414
+ # 1.
21415
+ # Corresponds to the JSON property `gpuPartitionSize`
21416
+ # @return [String]
21417
+ attr_accessor :gpu_partition_size
21418
+
19706
21419
  # Immutable. The type of the machine. See the [list of machine types supported
19707
21420
  # for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-
19708
21421
  # compute#machine-types) See the [list of machine types supported for custom
@@ -19741,6 +21454,7 @@ module Google
19741
21454
  def update!(**args)
19742
21455
  @accelerator_count = args[:accelerator_count] if args.key?(:accelerator_count)
19743
21456
  @accelerator_type = args[:accelerator_type] if args.key?(:accelerator_type)
21457
+ @gpu_partition_size = args[:gpu_partition_size] if args.key?(:gpu_partition_size)
19744
21458
  @machine_type = args[:machine_type] if args.key?(:machine_type)
19745
21459
  @multihost_gpu_node_count = args[:multihost_gpu_node_count] if args.key?(:multihost_gpu_node_count)
19746
21460
  @reservation_affinity = args[:reservation_affinity] if args.key?(:reservation_affinity)
@@ -19852,6 +21566,12 @@ module Google
19852
21566
  # @return [String]
19853
21567
  attr_accessor :display_name
19854
21568
 
21569
+ # Optional. Timestamp of when this resource is considered expired. This is *
21570
+ # always* provided on output, regardless of what `expiration` was sent on input.
21571
+ # Corresponds to the JSON property `expireTime`
21572
+ # @return [String]
21573
+ attr_accessor :expire_time
21574
+
19855
21575
  # Required. Semantic knowledge extracted from the source content.
19856
21576
  # Corresponds to the JSON property `fact`
19857
21577
  # @return [String]
@@ -19870,6 +21590,12 @@ module Google
19870
21590
  # @return [Hash<String,String>]
19871
21591
  attr_accessor :scope
19872
21592
 
21593
+ # Optional. Input only. The TTL for this resource. The expiration time is
21594
+ # computed: now + TTL.
21595
+ # Corresponds to the JSON property `ttl`
21596
+ # @return [String]
21597
+ attr_accessor :ttl
21598
+
19873
21599
  # Output only. Timestamp when this Memory was most recently updated.
19874
21600
  # Corresponds to the JSON property `updateTime`
19875
21601
  # @return [String]
@@ -19884,13 +21610,212 @@ module Google
19884
21610
  @create_time = args[:create_time] if args.key?(:create_time)
19885
21611
  @description = args[:description] if args.key?(:description)
19886
21612
  @display_name = args[:display_name] if args.key?(:display_name)
21613
+ @expire_time = args[:expire_time] if args.key?(:expire_time)
19887
21614
  @fact = args[:fact] if args.key?(:fact)
19888
21615
  @name = args[:name] if args.key?(:name)
19889
21616
  @scope = args[:scope] if args.key?(:scope)
21617
+ @ttl = args[:ttl] if args.key?(:ttl)
19890
21618
  @update_time = args[:update_time] if args.key?(:update_time)
19891
21619
  end
19892
21620
  end
19893
21621
 
21622
+ # Configuration for organizing memories for a particular scope.
21623
+ class GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfig
21624
+ include Google::Apis::Core::Hashable
21625
+
21626
+ # Optional. Examples of how to generate memories for a particular scope.
21627
+ # Corresponds to the JSON property `generateMemoriesExamples`
21628
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExample>]
21629
+ attr_accessor :generate_memories_examples
21630
+
21631
+ # Optional. Topics of information that should be extracted from conversations
21632
+ # and stored as memories. If not set, then Memory Bank's default topics will be
21633
+ # used.
21634
+ # Corresponds to the JSON property `memoryTopics`
21635
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigMemoryTopic>]
21636
+ attr_accessor :memory_topics
21637
+
21638
+ # Optional. The scope keys (i.e. 'user_id') for which to use this config. A
21639
+ # request's scope must include all of the provided keys for the config to be
21640
+ # used (order does not matter). If empty, then the config will be used for all
21641
+ # requests that do not have a more specific config. Only one default config is
21642
+ # allowed per Memory Bank.
21643
+ # Corresponds to the JSON property `scopeKeys`
21644
+ # @return [Array<String>]
21645
+ attr_accessor :scope_keys
21646
+
21647
+ def initialize(**args)
21648
+ update!(**args)
21649
+ end
21650
+
21651
+ # Update properties of this object
21652
+ def update!(**args)
21653
+ @generate_memories_examples = args[:generate_memories_examples] if args.key?(:generate_memories_examples)
21654
+ @memory_topics = args[:memory_topics] if args.key?(:memory_topics)
21655
+ @scope_keys = args[:scope_keys] if args.key?(:scope_keys)
21656
+ end
21657
+ end
21658
+
21659
+ # An example of how to generate memories for a particular scope.
21660
+ class GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExample
21661
+ include Google::Apis::Core::Hashable
21662
+
21663
+ # A conversation source for the example. This is similar to `
21664
+ # DirectContentsSource`.
21665
+ # Corresponds to the JSON property `conversationSource`
21666
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSource]
21667
+ attr_accessor :conversation_source
21668
+
21669
+ # Optional. The memories that are expected to be generated from the input
21670
+ # conversation. An empty list indicates that no memories are expected to be
21671
+ # generated for the input conversation.
21672
+ # Corresponds to the JSON property `generatedMemories`
21673
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExampleGeneratedMemory>]
21674
+ attr_accessor :generated_memories
21675
+
21676
+ def initialize(**args)
21677
+ update!(**args)
21678
+ end
21679
+
21680
+ # Update properties of this object
21681
+ def update!(**args)
21682
+ @conversation_source = args[:conversation_source] if args.key?(:conversation_source)
21683
+ @generated_memories = args[:generated_memories] if args.key?(:generated_memories)
21684
+ end
21685
+ end
21686
+
21687
+ # A conversation source for the example. This is similar to `
21688
+ # DirectContentsSource`.
21689
+ class GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSource
21690
+ include Google::Apis::Core::Hashable
21691
+
21692
+ # Optional. The input conversation events for the example.
21693
+ # Corresponds to the JSON property `events`
21694
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSourceEvent>]
21695
+ attr_accessor :events
21696
+
21697
+ def initialize(**args)
21698
+ update!(**args)
21699
+ end
21700
+
21701
+ # Update properties of this object
21702
+ def update!(**args)
21703
+ @events = args[:events] if args.key?(:events)
21704
+ end
21705
+ end
21706
+
21707
+ # A single conversation event.
21708
+ class GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSourceEvent
21709
+ include Google::Apis::Core::Hashable
21710
+
21711
+ # The base structured datatype containing multi-part content of a message. A `
21712
+ # Content` includes a `role` field designating the producer of the `Content` and
21713
+ # a `parts` field containing multi-part data that contains the content of the
21714
+ # message turn.
21715
+ # Corresponds to the JSON property `content`
21716
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
21717
+ attr_accessor :content
21718
+
21719
+ def initialize(**args)
21720
+ update!(**args)
21721
+ end
21722
+
21723
+ # Update properties of this object
21724
+ def update!(**args)
21725
+ @content = args[:content] if args.key?(:content)
21726
+ end
21727
+ end
21728
+
21729
+ # A memory generated by the operation.
21730
+ class GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExampleGeneratedMemory
21731
+ include Google::Apis::Core::Hashable
21732
+
21733
+ # Required. The fact to generate a memory from.
21734
+ # Corresponds to the JSON property `fact`
21735
+ # @return [String]
21736
+ attr_accessor :fact
21737
+
21738
+ def initialize(**args)
21739
+ update!(**args)
21740
+ end
21741
+
21742
+ # Update properties of this object
21743
+ def update!(**args)
21744
+ @fact = args[:fact] if args.key?(:fact)
21745
+ end
21746
+ end
21747
+
21748
+ # A topic of information that should be extracted from conversations and stored
21749
+ # as memories.
21750
+ class GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigMemoryTopic
21751
+ include Google::Apis::Core::Hashable
21752
+
21753
+ # A custom memory topic defined by the developer.
21754
+ # Corresponds to the JSON property `customMemoryTopic`
21755
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigMemoryTopicCustomMemoryTopic]
21756
+ attr_accessor :custom_memory_topic
21757
+
21758
+ # A managed memory topic defined by the system.
21759
+ # Corresponds to the JSON property `managedMemoryTopic`
21760
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigMemoryTopicManagedMemoryTopic]
21761
+ attr_accessor :managed_memory_topic
21762
+
21763
+ def initialize(**args)
21764
+ update!(**args)
21765
+ end
21766
+
21767
+ # Update properties of this object
21768
+ def update!(**args)
21769
+ @custom_memory_topic = args[:custom_memory_topic] if args.key?(:custom_memory_topic)
21770
+ @managed_memory_topic = args[:managed_memory_topic] if args.key?(:managed_memory_topic)
21771
+ end
21772
+ end
21773
+
21774
+ # A custom memory topic defined by the developer.
21775
+ class GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigMemoryTopicCustomMemoryTopic
21776
+ include Google::Apis::Core::Hashable
21777
+
21778
+ # Required. Description of the memory topic. This should explain what
21779
+ # information should be extracted for this topic.
21780
+ # Corresponds to the JSON property `description`
21781
+ # @return [String]
21782
+ attr_accessor :description
21783
+
21784
+ # Required. The label of the topic.
21785
+ # Corresponds to the JSON property `label`
21786
+ # @return [String]
21787
+ attr_accessor :label
21788
+
21789
+ def initialize(**args)
21790
+ update!(**args)
21791
+ end
21792
+
21793
+ # Update properties of this object
21794
+ def update!(**args)
21795
+ @description = args[:description] if args.key?(:description)
21796
+ @label = args[:label] if args.key?(:label)
21797
+ end
21798
+ end
21799
+
21800
+ # A managed memory topic defined by the system.
21801
+ class GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigMemoryTopicManagedMemoryTopic
21802
+ include Google::Apis::Core::Hashable
21803
+
21804
+ # Required. The managed topic.
21805
+ # Corresponds to the JSON property `managedTopicEnum`
21806
+ # @return [String]
21807
+ attr_accessor :managed_topic_enum
21808
+
21809
+ def initialize(**args)
21810
+ update!(**args)
21811
+ end
21812
+
21813
+ # Update properties of this object
21814
+ def update!(**args)
21815
+ @managed_topic_enum = args[:managed_topic_enum] if args.key?(:managed_topic_enum)
21816
+ end
21817
+ end
21818
+
19894
21819
  # Request message for ModelService.MergeVersionAliases.
19895
21820
  class GoogleCloudAiplatformV1beta1MergeVersionAliasesRequest
19896
21821
  include Google::Apis::Core::Hashable
@@ -19917,6 +21842,27 @@ module Google
19917
21842
  end
19918
21843
  end
19919
21844
 
21845
+ # Metadata for a chunk.
21846
+ class GoogleCloudAiplatformV1beta1Metadata
21847
+ include Google::Apis::Core::Hashable
21848
+
21849
+ # Optional. Attributes attached to the data. The keys have semantic conventions
21850
+ # and the consumers of the attributes should know how to deserialize the value
21851
+ # bytes based on the keys.
21852
+ # Corresponds to the JSON property `attributes`
21853
+ # @return [Hash<String,String>]
21854
+ attr_accessor :attributes
21855
+
21856
+ def initialize(**args)
21857
+ update!(**args)
21858
+ end
21859
+
21860
+ # Update properties of this object
21861
+ def update!(**args)
21862
+ @attributes = args[:attributes] if args.key?(:attributes)
21863
+ end
21864
+ end
21865
+
19920
21866
  # Instance of a general MetadataSchema.
19921
21867
  class GoogleCloudAiplatformV1beta1MetadataSchema
19922
21868
  include Google::Apis::Core::Hashable
@@ -20100,6 +22046,11 @@ module Google
20100
22046
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PointwiseMetricSpec]
20101
22047
  attr_accessor :pointwise_metric_spec
20102
22048
 
22049
+ # The spec for a pre-defined metric.
22050
+ # Corresponds to the JSON property `predefinedMetricSpec`
22051
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PredefinedMetricSpec]
22052
+ attr_accessor :predefined_metric_spec
22053
+
20103
22054
  # Spec for rouge score metric - calculates the recall of n-grams in prediction
20104
22055
  # as compared to reference - returns a score ranging between 0 and 1.
20105
22056
  # Corresponds to the JSON property `rougeSpec`
@@ -20117,10 +22068,43 @@ module Google
20117
22068
  @exact_match_spec = args[:exact_match_spec] if args.key?(:exact_match_spec)
20118
22069
  @pairwise_metric_spec = args[:pairwise_metric_spec] if args.key?(:pairwise_metric_spec)
20119
22070
  @pointwise_metric_spec = args[:pointwise_metric_spec] if args.key?(:pointwise_metric_spec)
22071
+ @predefined_metric_spec = args[:predefined_metric_spec] if args.key?(:predefined_metric_spec)
20120
22072
  @rouge_spec = args[:rouge_spec] if args.key?(:rouge_spec)
20121
22073
  end
20122
22074
  end
20123
22075
 
22076
+ # Result for a single metric on a single instance.
22077
+ class GoogleCloudAiplatformV1beta1MetricResult
22078
+ include Google::Apis::Core::Hashable
22079
+
22080
+ # The explanation for the metric result.
22081
+ # Corresponds to the JSON property `explanation`
22082
+ # @return [String]
22083
+ attr_accessor :explanation
22084
+
22085
+ # For rubric-based metrics, the verdicts for each rubric.
22086
+ # Corresponds to the JSON property `rubricVerdicts`
22087
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RubricVerdict>]
22088
+ attr_accessor :rubric_verdicts
22089
+
22090
+ # The score for the metric. Please refer to each metric's documentation for the
22091
+ # meaning of the score.
22092
+ # Corresponds to the JSON property `score`
22093
+ # @return [Float]
22094
+ attr_accessor :score
22095
+
22096
+ def initialize(**args)
22097
+ update!(**args)
22098
+ end
22099
+
22100
+ # Update properties of this object
22101
+ def update!(**args)
22102
+ @explanation = args[:explanation] if args.key?(:explanation)
22103
+ @rubric_verdicts = args[:rubric_verdicts] if args.key?(:rubric_verdicts)
22104
+ @score = args[:score] if args.key?(:score)
22105
+ end
22106
+ end
22107
+
20124
22108
  # Input for MetricX metric.
20125
22109
  class GoogleCloudAiplatformV1beta1MetricxInput
20126
22110
  include Google::Apis::Core::Hashable
@@ -20949,6 +22933,32 @@ module Google
20949
22933
  end
20950
22934
  end
20951
22935
 
22936
+ # Configuration for Model Armor integrations of prompt and responses.
22937
+ class GoogleCloudAiplatformV1beta1ModelArmorConfig
22938
+ include Google::Apis::Core::Hashable
22939
+
22940
+ # Optional. The name of the Model Armor template to use for prompt sanitization.
22941
+ # Corresponds to the JSON property `promptTemplateName`
22942
+ # @return [String]
22943
+ attr_accessor :prompt_template_name
22944
+
22945
+ # Optional. The name of the Model Armor template to use for response
22946
+ # sanitization.
22947
+ # Corresponds to the JSON property `responseTemplateName`
22948
+ # @return [String]
22949
+ attr_accessor :response_template_name
22950
+
22951
+ def initialize(**args)
22952
+ update!(**args)
22953
+ end
22954
+
22955
+ # Update properties of this object
22956
+ def update!(**args)
22957
+ @prompt_template_name = args[:prompt_template_name] if args.key?(:prompt_template_name)
22958
+ @response_template_name = args[:response_template_name] if args.key?(:response_template_name)
22959
+ end
22960
+ end
22961
+
20952
22962
  # User input field to specify the base model source. Currently it only supports
20953
22963
  # specifing the Model Garden models and Genie models.
20954
22964
  class GoogleCloudAiplatformV1beta1ModelBaseModelSource
@@ -25517,6 +27527,60 @@ module Google
25517
27527
  end
25518
27528
  end
25519
27529
 
27530
+ # Defines a specification for a single output field.
27531
+ class GoogleCloudAiplatformV1beta1OutputFieldSpec
27532
+ include Google::Apis::Core::Hashable
27533
+
27534
+ # Required. The name of the output field.
27535
+ # Corresponds to the JSON property `fieldName`
27536
+ # @return [String]
27537
+ attr_accessor :field_name
27538
+
27539
+ # Optional. The data type of the field. Defaults to CONTENT if not set.
27540
+ # Corresponds to the JSON property `fieldType`
27541
+ # @return [String]
27542
+ attr_accessor :field_type
27543
+
27544
+ # Optional. Optional, but recommended. Additional guidance specific to this
27545
+ # field to provide targeted instructions for the LLM to generate the content of
27546
+ # a single output field. While the LLM can sometimes infer content from the
27547
+ # field name, providing explicit guidance is preferred.
27548
+ # Corresponds to the JSON property `guidance`
27549
+ # @return [String]
27550
+ attr_accessor :guidance
27551
+
27552
+ def initialize(**args)
27553
+ update!(**args)
27554
+ end
27555
+
27556
+ # Update properties of this object
27557
+ def update!(**args)
27558
+ @field_name = args[:field_name] if args.key?(:field_name)
27559
+ @field_type = args[:field_type] if args.key?(:field_type)
27560
+ @guidance = args[:guidance] if args.key?(:guidance)
27561
+ end
27562
+ end
27563
+
27564
+ # Describes the info for output of EvaluationService.EvaluateDataset.
27565
+ class GoogleCloudAiplatformV1beta1OutputInfo
27566
+ include Google::Apis::Core::Hashable
27567
+
27568
+ # Output only. The full path of the Cloud Storage directory created, into which
27569
+ # the evaluation results and aggregation results are written.
27570
+ # Corresponds to the JSON property `gcsOutputDirectory`
27571
+ # @return [String]
27572
+ attr_accessor :gcs_output_directory
27573
+
27574
+ def initialize(**args)
27575
+ update!(**args)
27576
+ end
27577
+
27578
+ # Update properties of this object
27579
+ def update!(**args)
27580
+ @gcs_output_directory = args[:gcs_output_directory] if args.key?(:gcs_output_directory)
27581
+ end
27582
+ end
27583
+
25520
27584
  # PSC config that is used to automatically create PSC endpoints in the user
25521
27585
  # projects.
25522
27586
  class GoogleCloudAiplatformV1beta1PscAutomationConfig
@@ -27253,6 +29317,32 @@ module Google
27253
29317
  end
27254
29318
  end
27255
29319
 
29320
+ # The spec for a pre-defined metric.
29321
+ class GoogleCloudAiplatformV1beta1PredefinedMetricSpec
29322
+ include Google::Apis::Core::Hashable
29323
+
29324
+ # Required. The name of a pre-defined metric, such as "instruction_following_v1"
29325
+ # or "text_quality_v1".
29326
+ # Corresponds to the JSON property `metricSpecName`
29327
+ # @return [String]
29328
+ attr_accessor :metric_spec_name
29329
+
29330
+ # Optional. The parameters needed to run the pre-defined metric.
29331
+ # Corresponds to the JSON property `metricSpecParameters`
29332
+ # @return [Hash<String,Object>]
29333
+ attr_accessor :metric_spec_parameters
29334
+
29335
+ def initialize(**args)
29336
+ update!(**args)
29337
+ end
29338
+
29339
+ # Update properties of this object
29340
+ def update!(**args)
29341
+ @metric_spec_name = args[:metric_spec_name] if args.key?(:metric_spec_name)
29342
+ @metric_spec_parameters = args[:metric_spec_parameters] if args.key?(:metric_spec_parameters)
29343
+ end
29344
+ end
29345
+
27256
29346
  # Assigns input data to training, validation, and test sets based on the value
27257
29347
  # of a provided key. Supported only for tabular Datasets.
27258
29348
  class GoogleCloudAiplatformV1beta1PredefinedSplit
@@ -27537,6 +29627,18 @@ module Google
27537
29627
  class GoogleCloudAiplatformV1beta1PreferenceOptimizationDataStats
27538
29628
  include Google::Apis::Core::Hashable
27539
29629
 
29630
+ # Output only. A partial sample of the indices (starting from 1) of the dropped
29631
+ # examples.
29632
+ # Corresponds to the JSON property `droppedExampleIndices`
29633
+ # @return [Array<Fixnum>]
29634
+ attr_accessor :dropped_example_indices
29635
+
29636
+ # Output only. For each index in `dropped_example_indices`, the user-facing
29637
+ # reason why the example was dropped.
29638
+ # Corresponds to the JSON property `droppedExampleReasons`
29639
+ # @return [Array<String>]
29640
+ attr_accessor :dropped_example_reasons
29641
+
27540
29642
  # Distribution computed over a tuning dataset.
27541
29643
  # Corresponds to the JSON property `scoreVariancePerExampleDistribution`
27542
29644
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DatasetDistribution]
@@ -27583,6 +29685,8 @@ module Google
27583
29685
 
27584
29686
  # Update properties of this object
27585
29687
  def update!(**args)
29688
+ @dropped_example_indices = args[:dropped_example_indices] if args.key?(:dropped_example_indices)
29689
+ @dropped_example_reasons = args[:dropped_example_reasons] if args.key?(:dropped_example_reasons)
27586
29690
  @score_variance_per_example_distribution = args[:score_variance_per_example_distribution] if args.key?(:score_variance_per_example_distribution)
27587
29691
  @scores_distribution = args[:scores_distribution] if args.key?(:scores_distribution)
27588
29692
  @total_billable_token_count = args[:total_billable_token_count] if args.key?(:total_billable_token_count)
@@ -27636,6 +29740,11 @@ module Google
27636
29740
  class GoogleCloudAiplatformV1beta1PreferenceOptimizationSpec
27637
29741
  include Google::Apis::Core::Hashable
27638
29742
 
29743
+ # Evaluation Config for Tuning Job.
29744
+ # Corresponds to the JSON property `evaluationConfig`
29745
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationConfig]
29746
+ attr_accessor :evaluation_config
29747
+
27639
29748
  # Hyperparameters for Preference Optimization.
27640
29749
  # Corresponds to the JSON property `hyperParameters`
27641
29750
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PreferenceOptimizationHyperParameters]
@@ -27659,6 +29768,7 @@ module Google
27659
29768
 
27660
29769
  # Update properties of this object
27661
29770
  def update!(**args)
29771
+ @evaluation_config = args[:evaluation_config] if args.key?(:evaluation_config)
27662
29772
  @hyper_parameters = args[:hyper_parameters] if args.key?(:hyper_parameters)
27663
29773
  @training_dataset_uri = args[:training_dataset_uri] if args.key?(:training_dataset_uri)
27664
29774
  @validation_dataset_uri = args[:validation_dataset_uri] if args.key?(:validation_dataset_uri)
@@ -29754,7 +31864,8 @@ module Google
29754
31864
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagEmbeddingModelConfig]
29755
31865
  attr_accessor :rag_embedding_model_config
29756
31866
 
29757
- # Output only. Number of RagFiles in the RagCorpus.
31867
+ # Output only. Number of RagFiles in the RagCorpus. NOTE: This field is not
31868
+ # populated in the response of VertexRagDataService.ListRagCorpora.
29758
31869
  # Corresponds to the JSON property `ragFilesCount`
29759
31870
  # @return [Fixnum]
29760
31871
  attr_accessor :rag_files_count
@@ -31518,6 +33629,12 @@ module Google
31518
33629
  class GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfig
31519
33630
  include Google::Apis::Core::Hashable
31520
33631
 
33632
+ # Optional. Configuration for how to customize Memory Bank behavior for a
33633
+ # particular scope.
33634
+ # Corresponds to the JSON property `customizationConfigs`
33635
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfig>]
33636
+ attr_accessor :customization_configs
33637
+
31521
33638
  # Configuration for how to generate memories.
31522
33639
  # Corresponds to the JSON property `generationConfig`
31523
33640
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigGenerationConfig]
@@ -31528,14 +33645,22 @@ module Google
31528
33645
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigSimilaritySearchConfig]
31529
33646
  attr_accessor :similarity_search_config
31530
33647
 
33648
+ # Configuration for automatically setting the TTL ("time-to-live") of the
33649
+ # memories in the Memory Bank.
33650
+ # Corresponds to the JSON property `ttlConfig`
33651
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigTtlConfig]
33652
+ attr_accessor :ttl_config
33653
+
31531
33654
  def initialize(**args)
31532
33655
  update!(**args)
31533
33656
  end
31534
33657
 
31535
33658
  # Update properties of this object
31536
33659
  def update!(**args)
33660
+ @customization_configs = args[:customization_configs] if args.key?(:customization_configs)
31537
33661
  @generation_config = args[:generation_config] if args.key?(:generation_config)
31538
33662
  @similarity_search_config = args[:similarity_search_config] if args.key?(:similarity_search_config)
33663
+ @ttl_config = args[:ttl_config] if args.key?(:ttl_config)
31539
33664
  end
31540
33665
  end
31541
33666
 
@@ -31580,6 +33705,70 @@ module Google
31580
33705
  end
31581
33706
  end
31582
33707
 
33708
+ # Configuration for automatically setting the TTL ("time-to-live") of the
33709
+ # memories in the Memory Bank.
33710
+ class GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigTtlConfig
33711
+ include Google::Apis::Core::Hashable
33712
+
33713
+ # Optional. The default TTL duration of the memories in the Memory Bank. This
33714
+ # applies to all operations that create or update a memory.
33715
+ # Corresponds to the JSON property `defaultTtl`
33716
+ # @return [String]
33717
+ attr_accessor :default_ttl
33718
+
33719
+ # Configuration for TTL of the memories in the Memory Bank based on the action
33720
+ # that created or updated the memory.
33721
+ # Corresponds to the JSON property `granularTtlConfig`
33722
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigTtlConfigGranularTtlConfig]
33723
+ attr_accessor :granular_ttl_config
33724
+
33725
+ def initialize(**args)
33726
+ update!(**args)
33727
+ end
33728
+
33729
+ # Update properties of this object
33730
+ def update!(**args)
33731
+ @default_ttl = args[:default_ttl] if args.key?(:default_ttl)
33732
+ @granular_ttl_config = args[:granular_ttl_config] if args.key?(:granular_ttl_config)
33733
+ end
33734
+ end
33735
+
33736
+ # Configuration for TTL of the memories in the Memory Bank based on the action
33737
+ # that created or updated the memory.
33738
+ class GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigTtlConfigGranularTtlConfig
33739
+ include Google::Apis::Core::Hashable
33740
+
33741
+ # Optional. The TTL duration for memories uploaded via CreateMemory.
33742
+ # Corresponds to the JSON property `createTtl`
33743
+ # @return [String]
33744
+ attr_accessor :create_ttl
33745
+
33746
+ # Optional. The TTL duration for memories newly generated via GenerateMemories (
33747
+ # GenerateMemoriesResponse.GeneratedMemory.Action.CREATED).
33748
+ # Corresponds to the JSON property `generateCreatedTtl`
33749
+ # @return [String]
33750
+ attr_accessor :generate_created_ttl
33751
+
33752
+ # Optional. The TTL duration for memories updated via GenerateMemories (
33753
+ # GenerateMemoriesResponse.GeneratedMemory.Action.UPDATED). In the case of an
33754
+ # UPDATE action, the `expire_time` of the existing memory will be updated to the
33755
+ # new value (now + TTL).
33756
+ # Corresponds to the JSON property `generateUpdatedTtl`
33757
+ # @return [String]
33758
+ attr_accessor :generate_updated_ttl
33759
+
33760
+ def initialize(**args)
33761
+ update!(**args)
33762
+ end
33763
+
33764
+ # Update properties of this object
33765
+ def update!(**args)
33766
+ @create_ttl = args[:create_ttl] if args.key?(:create_ttl)
33767
+ @generate_created_ttl = args[:generate_created_ttl] if args.key?(:generate_created_ttl)
33768
+ @generate_updated_ttl = args[:generate_updated_ttl] if args.key?(:generate_updated_ttl)
33769
+ end
33770
+ end
33771
+
31583
33772
  # ReasoningEngine configurations
31584
33773
  class GoogleCloudAiplatformV1beta1ReasoningEngineSpec
31585
33774
  include Google::Apis::Core::Hashable
@@ -31634,6 +33823,17 @@ module Google
31634
33823
  class GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec
31635
33824
  include Google::Apis::Core::Hashable
31636
33825
 
33826
+ # The agent server mode.
33827
+ # Corresponds to the JSON property `agentServerMode`
33828
+ # @return [String]
33829
+ attr_accessor :agent_server_mode
33830
+
33831
+ # Optional. Concurrency for each container and agent server. Recommended value:
33832
+ # 2 * cpu + 1. Defaults to 9.
33833
+ # Corresponds to the JSON property `containerConcurrency`
33834
+ # @return [Fixnum]
33835
+ attr_accessor :container_concurrency
33836
+
31637
33837
  # Optional. Environment variables to be set with the Reasoning Engine deployment.
31638
33838
  # The environment variables can be updated through the UpdateReasoningEngine
31639
33839
  # API.
@@ -31641,6 +33841,35 @@ module Google
31641
33841
  # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EnvVar>]
31642
33842
  attr_accessor :env
31643
33843
 
33844
+ # Optional. The maximum number of application instances that can be launched to
33845
+ # handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-
33846
+ # I is enabled, the acceptable range is [1, 100].
33847
+ # Corresponds to the JSON property `maxInstances`
33848
+ # @return [Fixnum]
33849
+ attr_accessor :max_instances
33850
+
33851
+ # Optional. The minimum number of application instances that will be kept
33852
+ # running at all times. Defaults to 1. Range: [0, 10].
33853
+ # Corresponds to the JSON property `minInstances`
33854
+ # @return [Fixnum]
33855
+ attr_accessor :min_instances
33856
+
33857
+ # Configuration for PSC-I.
33858
+ # Corresponds to the JSON property `pscInterfaceConfig`
33859
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PscInterfaceConfig]
33860
+ attr_accessor :psc_interface_config
33861
+
33862
+ # Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are
33863
+ # supported. Defaults to `"cpu": "4", "memory": "4Gi"`. * The only supported
33864
+ # values for CPU are '1', '2', '4', '6' and '8'. For more information, go to
33865
+ # https://cloud.google.com/run/docs/configuring/cpu. * The only supported values
33866
+ # for memory are '1Gi', '2Gi', ... '32 Gi'. * For required cpu on different
33867
+ # memory values, go to https://cloud.google.com/run/docs/configuring/memory-
33868
+ # limits
33869
+ # Corresponds to the JSON property `resourceLimits`
33870
+ # @return [Hash<String,String>]
33871
+ attr_accessor :resource_limits
33872
+
31644
33873
  # Optional. Environment variables where the value is a secret in Cloud Secret
31645
33874
  # Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/
31646
33875
  # secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.
@@ -31654,7 +33883,13 @@ module Google
31654
33883
 
31655
33884
  # Update properties of this object
31656
33885
  def update!(**args)
33886
+ @agent_server_mode = args[:agent_server_mode] if args.key?(:agent_server_mode)
33887
+ @container_concurrency = args[:container_concurrency] if args.key?(:container_concurrency)
31657
33888
  @env = args[:env] if args.key?(:env)
33889
+ @max_instances = args[:max_instances] if args.key?(:max_instances)
33890
+ @min_instances = args[:min_instances] if args.key?(:min_instances)
33891
+ @psc_interface_config = args[:psc_interface_config] if args.key?(:psc_interface_config)
33892
+ @resource_limits = args[:resource_limits] if args.key?(:resource_limits)
31658
33893
  @secret_env = args[:secret_env] if args.key?(:secret_env)
31659
33894
  end
31660
33895
  end
@@ -31775,6 +34010,136 @@ module Google
31775
34010
  end
31776
34011
  end
31777
34012
 
34013
+ # Request message for ModelService.RecommendSpec.
34014
+ class GoogleCloudAiplatformV1beta1RecommendSpecRequest
34015
+ include Google::Apis::Core::Hashable
34016
+
34017
+ # Optional. If true, check machine availability for the recommended regions.
34018
+ # Only return the machine spec in regions where the machine is available.
34019
+ # Corresponds to the JSON property `checkMachineAvailability`
34020
+ # @return [Boolean]
34021
+ attr_accessor :check_machine_availability
34022
+ alias_method :check_machine_availability?, :check_machine_availability
34023
+
34024
+ # Optional. If true, check user quota for the recommended regions. Returns all
34025
+ # the machine spec in regions they are available, and also the user quota state
34026
+ # for each machine type in each region.
34027
+ # Corresponds to the JSON property `checkUserQuota`
34028
+ # @return [Boolean]
34029
+ attr_accessor :check_user_quota
34030
+ alias_method :check_user_quota?, :check_user_quota
34031
+
34032
+ # Required. The Google Cloud Storage URI of the custom model, storing weights
34033
+ # and config files (which can be used to infer the base model).
34034
+ # Corresponds to the JSON property `gcsUri`
34035
+ # @return [String]
34036
+ attr_accessor :gcs_uri
34037
+
34038
+ def initialize(**args)
34039
+ update!(**args)
34040
+ end
34041
+
34042
+ # Update properties of this object
34043
+ def update!(**args)
34044
+ @check_machine_availability = args[:check_machine_availability] if args.key?(:check_machine_availability)
34045
+ @check_user_quota = args[:check_user_quota] if args.key?(:check_user_quota)
34046
+ @gcs_uri = args[:gcs_uri] if args.key?(:gcs_uri)
34047
+ end
34048
+ end
34049
+
34050
+ # Response message for ModelService.RecommendSpec.
34051
+ class GoogleCloudAiplatformV1beta1RecommendSpecResponse
34052
+ include Google::Apis::Core::Hashable
34053
+
34054
+ # Output only. The base model used to finetune the custom model.
34055
+ # Corresponds to the JSON property `baseModel`
34056
+ # @return [String]
34057
+ attr_accessor :base_model
34058
+
34059
+ # Output only. Recommendations of deployment options for the given custom
34060
+ # weights model.
34061
+ # Corresponds to the JSON property `recommendations`
34062
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RecommendSpecResponseRecommendation>]
34063
+ attr_accessor :recommendations
34064
+
34065
+ # Output only. The machine and model container specs.
34066
+ # Corresponds to the JSON property `specs`
34067
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RecommendSpecResponseMachineAndModelContainerSpec>]
34068
+ attr_accessor :specs
34069
+
34070
+ def initialize(**args)
34071
+ update!(**args)
34072
+ end
34073
+
34074
+ # Update properties of this object
34075
+ def update!(**args)
34076
+ @base_model = args[:base_model] if args.key?(:base_model)
34077
+ @recommendations = args[:recommendations] if args.key?(:recommendations)
34078
+ @specs = args[:specs] if args.key?(:specs)
34079
+ end
34080
+ end
34081
+
34082
+ # A machine and model container spec.
34083
+ class GoogleCloudAiplatformV1beta1RecommendSpecResponseMachineAndModelContainerSpec
34084
+ include Google::Apis::Core::Hashable
34085
+
34086
+ # Specification of a container for serving predictions. Some fields in this
34087
+ # message correspond to fields in the [Kubernetes Container v1 core
34088
+ # specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/
34089
+ # v1.23/#container-v1-core).
34090
+ # Corresponds to the JSON property `containerSpec`
34091
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelContainerSpec]
34092
+ attr_accessor :container_spec
34093
+
34094
+ # Specification of a single machine.
34095
+ # Corresponds to the JSON property `machineSpec`
34096
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MachineSpec]
34097
+ attr_accessor :machine_spec
34098
+
34099
+ def initialize(**args)
34100
+ update!(**args)
34101
+ end
34102
+
34103
+ # Update properties of this object
34104
+ def update!(**args)
34105
+ @container_spec = args[:container_spec] if args.key?(:container_spec)
34106
+ @machine_spec = args[:machine_spec] if args.key?(:machine_spec)
34107
+ end
34108
+ end
34109
+
34110
+ # Recommendation of one deployment option for the given custom weights model in
34111
+ # one region. Contains the machine and container spec, and user accelerator
34112
+ # quota state.
34113
+ class GoogleCloudAiplatformV1beta1RecommendSpecResponseRecommendation
34114
+ include Google::Apis::Core::Hashable
34115
+
34116
+ # The region for the deployment spec (machine).
34117
+ # Corresponds to the JSON property `region`
34118
+ # @return [String]
34119
+ attr_accessor :region
34120
+
34121
+ # A machine and model container spec.
34122
+ # Corresponds to the JSON property `spec`
34123
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RecommendSpecResponseMachineAndModelContainerSpec]
34124
+ attr_accessor :spec
34125
+
34126
+ # Output only. The user accelerator quota state.
34127
+ # Corresponds to the JSON property `userQuotaState`
34128
+ # @return [String]
34129
+ attr_accessor :user_quota_state
34130
+
34131
+ def initialize(**args)
34132
+ update!(**args)
34133
+ end
34134
+
34135
+ # Update properties of this object
34136
+ def update!(**args)
34137
+ @region = args[:region] if args.key?(:region)
34138
+ @spec = args[:spec] if args.key?(:spec)
34139
+ @user_quota_state = args[:user_quota_state] if args.key?(:user_quota_state)
34140
+ end
34141
+ end
34142
+
31778
34143
  # Request message for MetadataService.DeleteContextChildrenRequest.
31779
34144
  class GoogleCloudAiplatformV1beta1RemoveContextChildrenRequest
31780
34145
  include Google::Apis::Core::Hashable
@@ -32773,6 +35138,48 @@ module Google
32773
35138
  end
32774
35139
  end
32775
35140
 
35141
+ # Message representing a single testable criterion for evaluation. One input
35142
+ # prompt could have multiple rubrics.
35143
+ class GoogleCloudAiplatformV1beta1Rubric
35144
+ include Google::Apis::Core::Hashable
35145
+
35146
+ # Content of the rubric, defining the testable criteria.
35147
+ # Corresponds to the JSON property `content`
35148
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RubricContent]
35149
+ attr_accessor :content
35150
+
35151
+ # Optional. The relative importance of this rubric.
35152
+ # Corresponds to the JSON property `importance`
35153
+ # @return [String]
35154
+ attr_accessor :importance
35155
+
35156
+ # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g.
35157
+ # , in RubricVerdict.
35158
+ # Corresponds to the JSON property `rubricId`
35159
+ # @return [String]
35160
+ attr_accessor :rubric_id
35161
+
35162
+ # Optional. A type designator for the rubric, which can inform how it's
35163
+ # evaluated or interpreted by systems or users. It's recommended to use
35164
+ # consistent, well-defined, upper snake_case strings. Examples: "
35165
+ # SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE".
35166
+ # Corresponds to the JSON property `type`
35167
+ # @return [String]
35168
+ attr_accessor :type
35169
+
35170
+ def initialize(**args)
35171
+ update!(**args)
35172
+ end
35173
+
35174
+ # Update properties of this object
35175
+ def update!(**args)
35176
+ @content = args[:content] if args.key?(:content)
35177
+ @importance = args[:importance] if args.key?(:importance)
35178
+ @rubric_id = args[:rubric_id] if args.key?(:rubric_id)
35179
+ @type = args[:type] if args.key?(:type)
35180
+ end
35181
+ end
35182
+
32776
35183
  # Instance and metric spec for RubricBasedInstructionFollowing metric.
32777
35184
  class GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingInput
32778
35185
  include Google::Apis::Core::Hashable
@@ -32861,6 +35268,45 @@ module Google
32861
35268
  end
32862
35269
  end
32863
35270
 
35271
+ # Content of the rubric, defining the testable criteria.
35272
+ class GoogleCloudAiplatformV1beta1RubricContent
35273
+ include Google::Apis::Core::Hashable
35274
+
35275
+ # Defines criteria based on a specific property.
35276
+ # Corresponds to the JSON property `property`
35277
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RubricContentProperty]
35278
+ attr_accessor :property
35279
+
35280
+ def initialize(**args)
35281
+ update!(**args)
35282
+ end
35283
+
35284
+ # Update properties of this object
35285
+ def update!(**args)
35286
+ @property = args[:property] if args.key?(:property)
35287
+ end
35288
+ end
35289
+
35290
+ # Defines criteria based on a specific property.
35291
+ class GoogleCloudAiplatformV1beta1RubricContentProperty
35292
+ include Google::Apis::Core::Hashable
35293
+
35294
+ # Description of the property being evaluated. Example: "The model's response is
35295
+ # grammatically correct."
35296
+ # Corresponds to the JSON property `description`
35297
+ # @return [String]
35298
+ attr_accessor :description
35299
+
35300
+ def initialize(**args)
35301
+ update!(**args)
35302
+ end
35303
+
35304
+ # Update properties of this object
35305
+ def update!(**args)
35306
+ @description = args[:description] if args.key?(:description)
35307
+ end
35308
+ end
35309
+
32864
35310
  # Rubric critique result.
32865
35311
  class GoogleCloudAiplatformV1beta1RubricCritiqueResult
32866
35312
  include Google::Apis::Core::Hashable
@@ -32888,6 +35334,116 @@ module Google
32888
35334
  end
32889
35335
  end
32890
35336
 
35337
+ # Specification for how rubrics should be generated.
35338
+ class GoogleCloudAiplatformV1beta1RubricGenerationSpec
35339
+ include Google::Apis::Core::Hashable
35340
+
35341
+ # The configs for autorater. This is applicable to both EvaluateInstances and
35342
+ # EvaluateDataset.
35343
+ # Corresponds to the JSON property `modelConfig`
35344
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AutoraterConfig]
35345
+ attr_accessor :model_config
35346
+
35347
+ # Template for the prompt used to generate rubrics. The details should be
35348
+ # updated based on the most-recent recipe requirements.
35349
+ # Corresponds to the JSON property `promptTemplate`
35350
+ # @return [String]
35351
+ attr_accessor :prompt_template
35352
+
35353
+ # The type of rubric content to be generated.
35354
+ # Corresponds to the JSON property `rubricContentType`
35355
+ # @return [String]
35356
+ attr_accessor :rubric_content_type
35357
+
35358
+ # Optional. An optional, pre-defined list of allowed types for generated rubrics.
35359
+ # If this field is provided, it implies `include_rubric_type` should be true,
35360
+ # and the generated rubric types should be chosen from this ontology.
35361
+ # Corresponds to the JSON property `rubricTypeOntology`
35362
+ # @return [Array<String>]
35363
+ attr_accessor :rubric_type_ontology
35364
+
35365
+ def initialize(**args)
35366
+ update!(**args)
35367
+ end
35368
+
35369
+ # Update properties of this object
35370
+ def update!(**args)
35371
+ @model_config = args[:model_config] if args.key?(:model_config)
35372
+ @prompt_template = args[:prompt_template] if args.key?(:prompt_template)
35373
+ @rubric_content_type = args[:rubric_content_type] if args.key?(:rubric_content_type)
35374
+ @rubric_type_ontology = args[:rubric_type_ontology] if args.key?(:rubric_type_ontology)
35375
+ end
35376
+ end
35377
+
35378
+ # A group of rubrics, used for grouping rubrics based on a metric or a version.
35379
+ class GoogleCloudAiplatformV1beta1RubricGroup
35380
+ include Google::Apis::Core::Hashable
35381
+
35382
+ # Human-readable name for the group. This should be unique within a given
35383
+ # context if used for display or selection. Example: "Instruction Following V1",
35384
+ # "Content Quality - Summarization Task".
35385
+ # Corresponds to the JSON property `displayName`
35386
+ # @return [String]
35387
+ attr_accessor :display_name
35388
+
35389
+ # Unique identifier for the group.
35390
+ # Corresponds to the JSON property `groupId`
35391
+ # @return [String]
35392
+ attr_accessor :group_id
35393
+
35394
+ # Rubrics that are part of this group.
35395
+ # Corresponds to the JSON property `rubrics`
35396
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Rubric>]
35397
+ attr_accessor :rubrics
35398
+
35399
+ def initialize(**args)
35400
+ update!(**args)
35401
+ end
35402
+
35403
+ # Update properties of this object
35404
+ def update!(**args)
35405
+ @display_name = args[:display_name] if args.key?(:display_name)
35406
+ @group_id = args[:group_id] if args.key?(:group_id)
35407
+ @rubrics = args[:rubrics] if args.key?(:rubrics)
35408
+ end
35409
+ end
35410
+
35411
+ # Represents the verdict of an evaluation against a single rubric.
35412
+ class GoogleCloudAiplatformV1beta1RubricVerdict
35413
+ include Google::Apis::Core::Hashable
35414
+
35415
+ # Message representing a single testable criterion for evaluation. One input
35416
+ # prompt could have multiple rubrics.
35417
+ # Corresponds to the JSON property `evaluatedRubric`
35418
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Rubric]
35419
+ attr_accessor :evaluated_rubric
35420
+
35421
+ # Optional. Human-readable reasoning or explanation for the verdict. This can
35422
+ # include specific examples or details from the evaluated content that justify
35423
+ # the given verdict.
35424
+ # Corresponds to the JSON property `reasoning`
35425
+ # @return [String]
35426
+ attr_accessor :reasoning
35427
+
35428
+ # Required. Outcome of the evaluation against the rubric, represented as a
35429
+ # boolean. `true` indicates a "Pass", `false` indicates a "Fail".
35430
+ # Corresponds to the JSON property `verdict`
35431
+ # @return [Boolean]
35432
+ attr_accessor :verdict
35433
+ alias_method :verdict?, :verdict
35434
+
35435
+ def initialize(**args)
35436
+ update!(**args)
35437
+ end
35438
+
35439
+ # Update properties of this object
35440
+ def update!(**args)
35441
+ @evaluated_rubric = args[:evaluated_rubric] if args.key?(:evaluated_rubric)
35442
+ @reasoning = args[:reasoning] if args.key?(:reasoning)
35443
+ @verdict = args[:verdict] if args.key?(:verdict)
35444
+ end
35445
+ end
35446
+
32891
35447
  # The definition of a runtime artifact.
32892
35448
  class GoogleCloudAiplatformV1beta1RuntimeArtifact
32893
35449
  include Google::Apis::Core::Hashable
@@ -33316,6 +35872,120 @@ module Google
33316
35872
  end
33317
35873
  end
33318
35874
 
35875
+ # SandboxEnvironment is a containerized environment that provides a customizable
35876
+ # secure execution runtime for AI agents.
35877
+ class GoogleCloudAiplatformV1beta1SandboxEnvironment
35878
+ include Google::Apis::Core::Hashable
35879
+
35880
+ # Output only. The timestamp when this SandboxEnvironment was created.
35881
+ # Corresponds to the JSON property `createTime`
35882
+ # @return [String]
35883
+ attr_accessor :create_time
35884
+
35885
+ # Required. The display name of the SandboxEnvironment.
35886
+ # Corresponds to the JSON property `displayName`
35887
+ # @return [String]
35888
+ attr_accessor :display_name
35889
+
35890
+ # Output only. Additional information about the SandboxEnvironment.
35891
+ # Corresponds to the JSON property `metadata`
35892
+ # @return [Object]
35893
+ attr_accessor :metadata
35894
+
35895
+ # Identifier. The name of the SandboxEnvironment.
35896
+ # Corresponds to the JSON property `name`
35897
+ # @return [String]
35898
+ attr_accessor :name
35899
+
35900
+ # The specification of a SandboxEnvironment.
35901
+ # Corresponds to the JSON property `spec`
35902
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SandboxEnvironmentSpec]
35903
+ attr_accessor :spec
35904
+
35905
+ # Output only. The runtime state of the SandboxEnvironment.
35906
+ # Corresponds to the JSON property `state`
35907
+ # @return [String]
35908
+ attr_accessor :state
35909
+
35910
+ # Output only. The timestamp when this SandboxEnvironment was most recently
35911
+ # updated.
35912
+ # Corresponds to the JSON property `updateTime`
35913
+ # @return [String]
35914
+ attr_accessor :update_time
35915
+
35916
+ def initialize(**args)
35917
+ update!(**args)
35918
+ end
35919
+
35920
+ # Update properties of this object
35921
+ def update!(**args)
35922
+ @create_time = args[:create_time] if args.key?(:create_time)
35923
+ @display_name = args[:display_name] if args.key?(:display_name)
35924
+ @metadata = args[:metadata] if args.key?(:metadata)
35925
+ @name = args[:name] if args.key?(:name)
35926
+ @spec = args[:spec] if args.key?(:spec)
35927
+ @state = args[:state] if args.key?(:state)
35928
+ @update_time = args[:update_time] if args.key?(:update_time)
35929
+ end
35930
+ end
35931
+
35932
+ # The specification of a SandboxEnvironment.
35933
+ class GoogleCloudAiplatformV1beta1SandboxEnvironmentSpec
35934
+ include Google::Apis::Core::Hashable
35935
+
35936
+ # The code execution environment with customized settings.
35937
+ # Corresponds to the JSON property `codeExecutionEnvironment`
35938
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SandboxEnvironmentSpecCodeExecutionEnvironment]
35939
+ attr_accessor :code_execution_environment
35940
+
35941
+ def initialize(**args)
35942
+ update!(**args)
35943
+ end
35944
+
35945
+ # Update properties of this object
35946
+ def update!(**args)
35947
+ @code_execution_environment = args[:code_execution_environment] if args.key?(:code_execution_environment)
35948
+ end
35949
+ end
35950
+
35951
+ # The code execution environment with customized settings.
35952
+ class GoogleCloudAiplatformV1beta1SandboxEnvironmentSpecCodeExecutionEnvironment
35953
+ include Google::Apis::Core::Hashable
35954
+
35955
+ # The coding language supported in this environment.
35956
+ # Corresponds to the JSON property `codeLanguage`
35957
+ # @return [String]
35958
+ attr_accessor :code_language
35959
+
35960
+ # Optional. The additional dependencies to install in the code execution
35961
+ # environment. For example, "pandas==2.2.3".
35962
+ # Corresponds to the JSON property `dependencies`
35963
+ # @return [Array<String>]
35964
+ attr_accessor :dependencies
35965
+
35966
+ # Optional. The environment variables to set in the code execution environment.
35967
+ # Corresponds to the JSON property `env`
35968
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EnvVar>]
35969
+ attr_accessor :env
35970
+
35971
+ # The machine config of the code execution environment.
35972
+ # Corresponds to the JSON property `machineConfig`
35973
+ # @return [String]
35974
+ attr_accessor :machine_config
35975
+
35976
+ def initialize(**args)
35977
+ update!(**args)
35978
+ end
35979
+
35980
+ # Update properties of this object
35981
+ def update!(**args)
35982
+ @code_language = args[:code_language] if args.key?(:code_language)
35983
+ @dependencies = args[:dependencies] if args.key?(:dependencies)
35984
+ @env = args[:env] if args.key?(:env)
35985
+ @machine_config = args[:machine_config] if args.key?(:machine_config)
35986
+ end
35987
+ end
35988
+
33319
35989
  # A SavedQuery is a view of the dataset. It references a subset of annotations
33320
35990
  # by problem type and filters.
33321
35991
  class GoogleCloudAiplatformV1beta1SavedQuery
@@ -43597,6 +46267,37 @@ module Google
43597
46267
  end
43598
46268
  end
43599
46269
 
46270
+ # The summary metrics for the evaluation run.
46271
+ class GoogleCloudAiplatformV1beta1SummaryMetrics
46272
+ include Google::Apis::Core::Hashable
46273
+
46274
+ # Optional. The number of items that failed to be evaluated.
46275
+ # Corresponds to the JSON property `failedItems`
46276
+ # @return [Fixnum]
46277
+ attr_accessor :failed_items
46278
+
46279
+ # Optional. Map of metric name to metric value.
46280
+ # Corresponds to the JSON property `metrics`
46281
+ # @return [Hash<String,Object>]
46282
+ attr_accessor :metrics
46283
+
46284
+ # Optional. The total number of items that were evaluated.
46285
+ # Corresponds to the JSON property `totalItems`
46286
+ # @return [Fixnum]
46287
+ attr_accessor :total_items
46288
+
46289
+ def initialize(**args)
46290
+ update!(**args)
46291
+ end
46292
+
46293
+ # Update properties of this object
46294
+ def update!(**args)
46295
+ @failed_items = args[:failed_items] if args.key?(:failed_items)
46296
+ @metrics = args[:metrics] if args.key?(:metrics)
46297
+ @total_items = args[:total_items] if args.key?(:total_items)
46298
+ end
46299
+ end
46300
+
43600
46301
  # Hyperparameters for SFT.
43601
46302
  class GoogleCloudAiplatformV1beta1SupervisedHyperParameters
43602
46303
  include Google::Apis::Core::Hashable
@@ -43837,6 +46538,11 @@ module Google
43837
46538
  class GoogleCloudAiplatformV1beta1SupervisedTuningSpec
43838
46539
  include Google::Apis::Core::Hashable
43839
46540
 
46541
+ # Evaluation Config for Tuning Job.
46542
+ # Corresponds to the JSON property `evaluationConfig`
46543
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationConfig]
46544
+ attr_accessor :evaluation_config
46545
+
43840
46546
  # Optional. If set to true, disable intermediate checkpoints for SFT and only
43841
46547
  # the last checkpoint will be exported. Otherwise, enable intermediate
43842
46548
  # checkpoints for SFT. Default is false.
@@ -43875,6 +46581,7 @@ module Google
43875
46581
 
43876
46582
  # Update properties of this object
43877
46583
  def update!(**args)
46584
+ @evaluation_config = args[:evaluation_config] if args.key?(:evaluation_config)
43878
46585
  @export_last_checkpoint_only = args[:export_last_checkpoint_only] if args.key?(:export_last_checkpoint_only)
43879
46586
  @hyper_parameters = args[:hyper_parameters] if args.key?(:hyper_parameters)
43880
46587
  @training_dataset_uri = args[:training_dataset_uri] if args.key?(:training_dataset_uri)
@@ -43917,6 +46624,55 @@ module Google
43917
46624
  end
43918
46625
  end
43919
46626
 
46627
+ # Represents a single synthetic example, composed of multiple fields. Used for
46628
+ # providing few-shot examples in the request and for returning generated
46629
+ # examples in the response.
46630
+ class GoogleCloudAiplatformV1beta1SyntheticExample
46631
+ include Google::Apis::Core::Hashable
46632
+
46633
+ # Required. A list of fields that constitute an example.
46634
+ # Corresponds to the JSON property `fields`
46635
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SyntheticField>]
46636
+ attr_accessor :fields
46637
+
46638
+ def initialize(**args)
46639
+ update!(**args)
46640
+ end
46641
+
46642
+ # Update properties of this object
46643
+ def update!(**args)
46644
+ @fields = args[:fields] if args.key?(:fields)
46645
+ end
46646
+ end
46647
+
46648
+ # Represents a single named field within a SyntheticExample.
46649
+ class GoogleCloudAiplatformV1beta1SyntheticField
46650
+ include Google::Apis::Core::Hashable
46651
+
46652
+ # The base structured datatype containing multi-part content of a message. A `
46653
+ # Content` includes a `role` field designating the producer of the `Content` and
46654
+ # a `parts` field containing multi-part data that contains the content of the
46655
+ # message turn.
46656
+ # Corresponds to the JSON property `content`
46657
+ # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content]
46658
+ attr_accessor :content
46659
+
46660
+ # Optional. The name of the field.
46661
+ # Corresponds to the JSON property `fieldName`
46662
+ # @return [String]
46663
+ attr_accessor :field_name
46664
+
46665
+ def initialize(**args)
46666
+ update!(**args)
46667
+ end
46668
+
46669
+ # Update properties of this object
46670
+ def update!(**args)
46671
+ @content = args[:content] if args.key?(:content)
46672
+ @field_name = args[:field_name] if args.key?(:field_name)
46673
+ end
46674
+ end
46675
+
43920
46676
  # The storage details for TFRecord output content.
43921
46677
  class GoogleCloudAiplatformV1beta1TfRecordDestination
43922
46678
  include Google::Apis::Core::Hashable
@@ -43936,6 +46692,25 @@ module Google
43936
46692
  end
43937
46693
  end
43938
46694
 
46695
+ # Defines a generation strategy based on a high-level task description.
46696
+ class GoogleCloudAiplatformV1beta1TaskDescriptionStrategy
46697
+ include Google::Apis::Core::Hashable
46698
+
46699
+ # Required. A high-level description of the synthetic data to be generated.
46700
+ # Corresponds to the JSON property `taskDescription`
46701
+ # @return [String]
46702
+ attr_accessor :task_description
46703
+
46704
+ def initialize(**args)
46705
+ update!(**args)
46706
+ end
46707
+
46708
+ # Update properties of this object
46709
+ def update!(**args)
46710
+ @task_description = args[:task_description] if args.key?(:task_description)
46711
+ end
46712
+ end
46713
+
43939
46714
  # A tensor value type.
43940
46715
  class GoogleCloudAiplatformV1beta1Tensor
43941
46716
  include Google::Apis::Core::Hashable
@@ -46476,6 +49251,11 @@ module Google
46476
49251
  # @return [Google::Apis::AiplatformV1beta1::GoogleRpcStatus]
46477
49252
  attr_accessor :error
46478
49253
 
49254
+ # Output only. Evaluation runs for the Tuning Job.
49255
+ # Corresponds to the JSON property `evaluateDatasetRuns`
49256
+ # @return [Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluateDatasetRun>]
49257
+ attr_accessor :evaluate_dataset_runs
49258
+
46479
49259
  # Output only. The Experiment associated with this TuningJob.
46480
49260
  # Corresponds to the JSON property `experiment`
46481
49261
  # @return [String]
@@ -46579,6 +49359,12 @@ module Google
46579
49359
  # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TuningDataStats]
46580
49360
  attr_accessor :tuning_data_stats
46581
49361
 
49362
+ # Output only. The detail state of the tuning job (while the overall `JobState`
49363
+ # is running).
49364
+ # Corresponds to the JSON property `tuningJobState`
49365
+ # @return [String]
49366
+ attr_accessor :tuning_job_state
49367
+
46582
49368
  # Output only. Time when the TuningJob was most recently updated.
46583
49369
  # Corresponds to the JSON property `updateTime`
46584
49370
  # @return [String]
@@ -46603,6 +49389,7 @@ module Google
46603
49389
  @encryption_spec = args[:encryption_spec] if args.key?(:encryption_spec)
46604
49390
  @end_time = args[:end_time] if args.key?(:end_time)
46605
49391
  @error = args[:error] if args.key?(:error)
49392
+ @evaluate_dataset_runs = args[:evaluate_dataset_runs] if args.key?(:evaluate_dataset_runs)
46606
49393
  @experiment = args[:experiment] if args.key?(:experiment)
46607
49394
  @labels = args[:labels] if args.key?(:labels)
46608
49395
  @name = args[:name] if args.key?(:name)
@@ -46620,6 +49407,7 @@ module Google
46620
49407
  @tuned_model = args[:tuned_model] if args.key?(:tuned_model)
46621
49408
  @tuned_model_display_name = args[:tuned_model_display_name] if args.key?(:tuned_model_display_name)
46622
49409
  @tuning_data_stats = args[:tuning_data_stats] if args.key?(:tuning_data_stats)
49410
+ @tuning_job_state = args[:tuning_job_state] if args.key?(:tuning_job_state)
46623
49411
  @update_time = args[:update_time] if args.key?(:update_time)
46624
49412
  @veo_tuning_spec = args[:veo_tuning_spec] if args.key?(:veo_tuning_spec)
46625
49413
  end