google-apis-aiplatform_v1 0.64.0 → 0.66.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.
@@ -2607,6 +2607,86 @@ module Google
2607
2607
  end
2608
2608
  end
2609
2609
 
2610
+ # The request set for the evaluation run.
2611
+ class GoogleCloudAiplatformV1BigQueryRequestSet
2612
+ include Google::Apis::Core::Hashable
2613
+
2614
+ # Optional. Map of candidate name to candidate response column name. The column
2615
+ # will be in evaluation_item.CandidateResponse format.
2616
+ # Corresponds to the JSON property `candidateResponseColumns`
2617
+ # @return [Hash<String,String>]
2618
+ attr_accessor :candidate_response_columns
2619
+
2620
+ # Optional. The name of the column that contains the requests to evaluate. This
2621
+ # will be in evaluation_item.EvalPrompt format.
2622
+ # Corresponds to the JSON property `promptColumn`
2623
+ # @return [String]
2624
+ attr_accessor :prompt_column
2625
+
2626
+ # Optional. The name of the column that contains the rubrics. This will be in
2627
+ # evaluation_rubric.RubricGroup format (cl/762595858).
2628
+ # Corresponds to the JSON property `rubricsColumn`
2629
+ # @return [String]
2630
+ attr_accessor :rubrics_column
2631
+
2632
+ # The sampling config.
2633
+ # Corresponds to the JSON property `samplingConfig`
2634
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BigQueryRequestSetSamplingConfig]
2635
+ attr_accessor :sampling_config
2636
+
2637
+ # Required. The URI of a BigQuery table. e.g. bq://projectId.bqDatasetId.
2638
+ # bqTableId
2639
+ # Corresponds to the JSON property `uri`
2640
+ # @return [String]
2641
+ attr_accessor :uri
2642
+
2643
+ def initialize(**args)
2644
+ update!(**args)
2645
+ end
2646
+
2647
+ # Update properties of this object
2648
+ def update!(**args)
2649
+ @candidate_response_columns = args[:candidate_response_columns] if args.key?(:candidate_response_columns)
2650
+ @prompt_column = args[:prompt_column] if args.key?(:prompt_column)
2651
+ @rubrics_column = args[:rubrics_column] if args.key?(:rubrics_column)
2652
+ @sampling_config = args[:sampling_config] if args.key?(:sampling_config)
2653
+ @uri = args[:uri] if args.key?(:uri)
2654
+ end
2655
+ end
2656
+
2657
+ # The sampling config.
2658
+ class GoogleCloudAiplatformV1BigQueryRequestSetSamplingConfig
2659
+ include Google::Apis::Core::Hashable
2660
+
2661
+ # Optional. The total number of logged data to import. If available data is less
2662
+ # than the sampling count, all data will be imported. Default is 100.
2663
+ # Corresponds to the JSON property `samplingCount`
2664
+ # @return [Fixnum]
2665
+ attr_accessor :sampling_count
2666
+
2667
+ # Optional. How long to wait before sampling data from the BigQuery table. If
2668
+ # not specified, defaults to 0.
2669
+ # Corresponds to the JSON property `samplingDuration`
2670
+ # @return [String]
2671
+ attr_accessor :sampling_duration
2672
+
2673
+ # Optional. The sampling method to use.
2674
+ # Corresponds to the JSON property `samplingMethod`
2675
+ # @return [String]
2676
+ attr_accessor :sampling_method
2677
+
2678
+ def initialize(**args)
2679
+ update!(**args)
2680
+ end
2681
+
2682
+ # Update properties of this object
2683
+ def update!(**args)
2684
+ @sampling_count = args[:sampling_count] if args.key?(:sampling_count)
2685
+ @sampling_duration = args[:sampling_duration] if args.key?(:sampling_duration)
2686
+ @sampling_method = args[:sampling_method] if args.key?(:sampling_method)
2687
+ end
2688
+ end
2689
+
2610
2690
  # The BigQuery location for the input content.
2611
2691
  class GoogleCloudAiplatformV1BigQuerySource
2612
2692
  include Google::Apis::Core::Hashable
@@ -3028,6 +3108,19 @@ module Google
3028
3108
  end
3029
3109
  end
3030
3110
 
3111
+ # Request message for EvaluationManagementService.CancelEvaluationRun.
3112
+ class GoogleCloudAiplatformV1CancelEvaluationRunRequest
3113
+ include Google::Apis::Core::Hashable
3114
+
3115
+ def initialize(**args)
3116
+ update!(**args)
3117
+ end
3118
+
3119
+ # Update properties of this object
3120
+ def update!(**args)
3121
+ end
3122
+ end
3123
+
3031
3124
  # Request message for JobService.CancelHyperparameterTuningJob.
3032
3125
  class GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest
3033
3126
  include Google::Apis::Core::Hashable
@@ -3172,6 +3265,87 @@ module Google
3172
3265
  end
3173
3266
  end
3174
3267
 
3268
+ # Responses from model or agent.
3269
+ class GoogleCloudAiplatformV1CandidateResponse
3270
+ include Google::Apis::Core::Hashable
3271
+
3272
+ # Required. The name of the candidate that produced the response.
3273
+ # Corresponds to the JSON property `candidate`
3274
+ # @return [String]
3275
+ attr_accessor :candidate
3276
+
3277
+ # Text response.
3278
+ # Corresponds to the JSON property `text`
3279
+ # @return [String]
3280
+ attr_accessor :text
3281
+
3282
+ # Fields and values that can be used to populate the response template.
3283
+ # Corresponds to the JSON property `value`
3284
+ # @return [Object]
3285
+ attr_accessor :value
3286
+
3287
+ def initialize(**args)
3288
+ update!(**args)
3289
+ end
3290
+
3291
+ # Update properties of this object
3292
+ def update!(**args)
3293
+ @candidate = args[:candidate] if args.key?(:candidate)
3294
+ @text = args[:text] if args.key?(:text)
3295
+ @value = args[:value] if args.key?(:value)
3296
+ end
3297
+ end
3298
+
3299
+ # Result for a single candidate.
3300
+ class GoogleCloudAiplatformV1CandidateResult
3301
+ include Google::Apis::Core::Hashable
3302
+
3303
+ # Optional. Additional results for the metric.
3304
+ # Corresponds to the JSON property `additionalResults`
3305
+ # @return [Object]
3306
+ attr_accessor :additional_results
3307
+
3308
+ # Required. The candidate that is being evaluated. The value is the same as the
3309
+ # candidate name in the EvaluationRequest.
3310
+ # Corresponds to the JSON property `candidate`
3311
+ # @return [String]
3312
+ attr_accessor :candidate
3313
+
3314
+ # Optional. The explanation for the metric.
3315
+ # Corresponds to the JSON property `explanation`
3316
+ # @return [String]
3317
+ attr_accessor :explanation
3318
+
3319
+ # Required. The metric that was evaluated.
3320
+ # Corresponds to the JSON property `metric`
3321
+ # @return [String]
3322
+ attr_accessor :metric
3323
+
3324
+ # Optional. The rubric verdicts for the metric.
3325
+ # Corresponds to the JSON property `rubricVerdicts`
3326
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RubricVerdict>]
3327
+ attr_accessor :rubric_verdicts
3328
+
3329
+ # Optional. The score for the metric.
3330
+ # Corresponds to the JSON property `score`
3331
+ # @return [Float]
3332
+ attr_accessor :score
3333
+
3334
+ def initialize(**args)
3335
+ update!(**args)
3336
+ end
3337
+
3338
+ # Update properties of this object
3339
+ def update!(**args)
3340
+ @additional_results = args[:additional_results] if args.key?(:additional_results)
3341
+ @candidate = args[:candidate] if args.key?(:candidate)
3342
+ @explanation = args[:explanation] if args.key?(:explanation)
3343
+ @metric = args[:metric] if args.key?(:metric)
3344
+ @rubric_verdicts = args[:rubric_verdicts] if args.key?(:rubric_verdicts)
3345
+ @score = args[:score] if args.key?(:score)
3346
+ end
3347
+ end
3348
+
3175
3349
  # This message will be placed in the metadata field of a google.longrunning.
3176
3350
  # Operation associated with a CheckTrialEarlyStoppingState request.
3177
3351
  class GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata
@@ -6308,8 +6482,10 @@ module Google
6308
6482
  class GoogleCloudAiplatformV1DeployRequestEndpointConfig
6309
6483
  include Google::Apis::Core::Hashable
6310
6484
 
6311
- # Optional. By default, if dedicated endpoint is enabled, the endpoint will be
6312
- # exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your
6485
+ # Optional. By default, if dedicated endpoint is enabled and private service
6486
+ # connect config is not set, the endpoint will be exposed through a dedicated
6487
+ # DNS [Endpoint.dedicated_endpoint_dns]. If private service connect config is
6488
+ # set, the endpoint will be exposed through private service connect. Your
6313
6489
  # request to the dedicated DNS will be isolated from other users' traffic and
6314
6490
  # will have better performance and reliability. Note: Once you enabled dedicated
6315
6491
  # endpoint, you won't be able to send request to the shared DNS `region`-
@@ -6352,6 +6528,11 @@ module Google
6352
6528
  # @return [String]
6353
6529
  attr_accessor :endpoint_user_id
6354
6530
 
6531
+ # Represents configuration for private service connect.
6532
+ # Corresponds to the JSON property `privateServiceConnectConfig`
6533
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PrivateServiceConnectConfig]
6534
+ attr_accessor :private_service_connect_config
6535
+
6355
6536
  def initialize(**args)
6356
6537
  update!(**args)
6357
6538
  end
@@ -6362,6 +6543,7 @@ module Google
6362
6543
  @dedicated_endpoint_enabled = args[:dedicated_endpoint_enabled] if args.key?(:dedicated_endpoint_enabled)
6363
6544
  @endpoint_display_name = args[:endpoint_display_name] if args.key?(:endpoint_display_name)
6364
6545
  @endpoint_user_id = args[:endpoint_user_id] if args.key?(:endpoint_user_id)
6546
+ @private_service_connect_config = args[:private_service_connect_config] if args.key?(:private_service_connect_config)
6365
6547
  end
6366
6548
  end
6367
6549
 
@@ -8410,6 +8592,858 @@ module Google
8410
8592
  end
8411
8593
  end
8412
8594
 
8595
+ # EvaluationItem is a single evaluation request or result. The content of an
8596
+ # EvaluationItem is immutable - it cannot be updated once created.
8597
+ # EvaluationItems can be deleted when no longer needed.
8598
+ class GoogleCloudAiplatformV1EvaluationItem
8599
+ include Google::Apis::Core::Hashable
8600
+
8601
+ # Output only. Timestamp when this item was created.
8602
+ # Corresponds to the JSON property `createTime`
8603
+ # @return [String]
8604
+ attr_accessor :create_time
8605
+
8606
+ # Required. The display name of the EvaluationItem.
8607
+ # Corresponds to the JSON property `displayName`
8608
+ # @return [String]
8609
+ attr_accessor :display_name
8610
+
8611
+ # The `Status` type defines a logical error model that is suitable for different
8612
+ # programming environments, including REST APIs and RPC APIs. It is used by [
8613
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
8614
+ # data: error code, error message, and error details. You can find out more
8615
+ # about this error model and how to work with it in the [API Design Guide](https:
8616
+ # //cloud.google.com/apis/design/errors).
8617
+ # Corresponds to the JSON property `error`
8618
+ # @return [Google::Apis::AiplatformV1::GoogleRpcStatus]
8619
+ attr_accessor :error
8620
+
8621
+ # Required. The type of the EvaluationItem.
8622
+ # Corresponds to the JSON property `evaluationItemType`
8623
+ # @return [String]
8624
+ attr_accessor :evaluation_item_type
8625
+
8626
+ # Single evaluation request.
8627
+ # Corresponds to the JSON property `evaluationRequest`
8628
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRequest]
8629
+ attr_accessor :evaluation_request
8630
+
8631
+ # Evaluation result.
8632
+ # Corresponds to the JSON property `evaluationResponse`
8633
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationResult]
8634
+ attr_accessor :evaluation_response
8635
+
8636
+ # The GCS object where the request or response is stored.
8637
+ # Corresponds to the JSON property `gcsUri`
8638
+ # @return [String]
8639
+ attr_accessor :gcs_uri
8640
+
8641
+ # Optional. Labels for the EvaluationItem.
8642
+ # Corresponds to the JSON property `labels`
8643
+ # @return [Hash<String,String>]
8644
+ attr_accessor :labels
8645
+
8646
+ # Optional. Metadata for the EvaluationItem.
8647
+ # Corresponds to the JSON property `metadata`
8648
+ # @return [Object]
8649
+ attr_accessor :metadata
8650
+
8651
+ # Identifier. The resource name of the EvaluationItem. Format: `projects/`
8652
+ # project`/locations/`location`/evaluationItems/`evaluation_item``
8653
+ # Corresponds to the JSON property `name`
8654
+ # @return [String]
8655
+ attr_accessor :name
8656
+
8657
+ def initialize(**args)
8658
+ update!(**args)
8659
+ end
8660
+
8661
+ # Update properties of this object
8662
+ def update!(**args)
8663
+ @create_time = args[:create_time] if args.key?(:create_time)
8664
+ @display_name = args[:display_name] if args.key?(:display_name)
8665
+ @error = args[:error] if args.key?(:error)
8666
+ @evaluation_item_type = args[:evaluation_item_type] if args.key?(:evaluation_item_type)
8667
+ @evaluation_request = args[:evaluation_request] if args.key?(:evaluation_request)
8668
+ @evaluation_response = args[:evaluation_response] if args.key?(:evaluation_response)
8669
+ @gcs_uri = args[:gcs_uri] if args.key?(:gcs_uri)
8670
+ @labels = args[:labels] if args.key?(:labels)
8671
+ @metadata = args[:metadata] if args.key?(:metadata)
8672
+ @name = args[:name] if args.key?(:name)
8673
+ end
8674
+ end
8675
+
8676
+ # Prompt to be evaluated.
8677
+ class GoogleCloudAiplatformV1EvaluationPrompt
8678
+ include Google::Apis::Core::Hashable
8679
+
8680
+ # Message to hold a prompt template and the values to populate the template.
8681
+ # Corresponds to the JSON property `promptTemplateData`
8682
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationPromptPromptTemplateData]
8683
+ attr_accessor :prompt_template_data
8684
+
8685
+ # Text prompt.
8686
+ # Corresponds to the JSON property `text`
8687
+ # @return [String]
8688
+ attr_accessor :text
8689
+
8690
+ # Fields and values that can be used to populate the prompt template.
8691
+ # Corresponds to the JSON property `value`
8692
+ # @return [Object]
8693
+ attr_accessor :value
8694
+
8695
+ def initialize(**args)
8696
+ update!(**args)
8697
+ end
8698
+
8699
+ # Update properties of this object
8700
+ def update!(**args)
8701
+ @prompt_template_data = args[:prompt_template_data] if args.key?(:prompt_template_data)
8702
+ @text = args[:text] if args.key?(:text)
8703
+ @value = args[:value] if args.key?(:value)
8704
+ end
8705
+ end
8706
+
8707
+ # Message to hold a prompt template and the values to populate the template.
8708
+ class GoogleCloudAiplatformV1EvaluationPromptPromptTemplateData
8709
+ include Google::Apis::Core::Hashable
8710
+
8711
+ # The values for fields in the prompt template.
8712
+ # Corresponds to the JSON property `values`
8713
+ # @return [Hash<String,Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content>]
8714
+ attr_accessor :values
8715
+
8716
+ def initialize(**args)
8717
+ update!(**args)
8718
+ end
8719
+
8720
+ # Update properties of this object
8721
+ def update!(**args)
8722
+ @values = args[:values] if args.key?(:values)
8723
+ end
8724
+ end
8725
+
8726
+ # Single evaluation request.
8727
+ class GoogleCloudAiplatformV1EvaluationRequest
8728
+ include Google::Apis::Core::Hashable
8729
+
8730
+ # Optional. Responses from model under test and other baseline models for
8731
+ # comparison.
8732
+ # Corresponds to the JSON property `candidateResponses`
8733
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CandidateResponse>]
8734
+ attr_accessor :candidate_responses
8735
+
8736
+ # Responses from model or agent.
8737
+ # Corresponds to the JSON property `goldenResponse`
8738
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CandidateResponse]
8739
+ attr_accessor :golden_response
8740
+
8741
+ # Prompt to be evaluated.
8742
+ # Corresponds to the JSON property `prompt`
8743
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationPrompt]
8744
+ attr_accessor :prompt
8745
+
8746
+ # Optional. Named groups of rubrics associated with this prompt. The key is a
8747
+ # user-defined name for the rubric group.
8748
+ # Corresponds to the JSON property `rubrics`
8749
+ # @return [Hash<String,Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RubricGroup>]
8750
+ attr_accessor :rubrics
8751
+
8752
+ def initialize(**args)
8753
+ update!(**args)
8754
+ end
8755
+
8756
+ # Update properties of this object
8757
+ def update!(**args)
8758
+ @candidate_responses = args[:candidate_responses] if args.key?(:candidate_responses)
8759
+ @golden_response = args[:golden_response] if args.key?(:golden_response)
8760
+ @prompt = args[:prompt] if args.key?(:prompt)
8761
+ @rubrics = args[:rubrics] if args.key?(:rubrics)
8762
+ end
8763
+ end
8764
+
8765
+ # Evaluation result.
8766
+ class GoogleCloudAiplatformV1EvaluationResult
8767
+ include Google::Apis::Core::Hashable
8768
+
8769
+ # Optional. The results for the metric.
8770
+ # Corresponds to the JSON property `candidateResults`
8771
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CandidateResult>]
8772
+ attr_accessor :candidate_results
8773
+
8774
+ # Required. The request item that was evaluated. Format: projects/`project`/
8775
+ # locations/`location`/evaluationItems/`evaluation_item`
8776
+ # Corresponds to the JSON property `evaluationRequest`
8777
+ # @return [String]
8778
+ attr_accessor :evaluation_request
8779
+
8780
+ # Required. The evaluation run that was used to generate the result. Format:
8781
+ # projects/`project`/locations/`location`/evaluationRuns/`evaluation_run`
8782
+ # Corresponds to the JSON property `evaluationRun`
8783
+ # @return [String]
8784
+ attr_accessor :evaluation_run
8785
+
8786
+ # Optional. Metadata about the evaluation result.
8787
+ # Corresponds to the JSON property `metadata`
8788
+ # @return [Object]
8789
+ attr_accessor :metadata
8790
+
8791
+ # Required. The metric that was evaluated.
8792
+ # Corresponds to the JSON property `metric`
8793
+ # @return [String]
8794
+ attr_accessor :metric
8795
+
8796
+ # Single evaluation request.
8797
+ # Corresponds to the JSON property `request`
8798
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRequest]
8799
+ attr_accessor :request
8800
+
8801
+ def initialize(**args)
8802
+ update!(**args)
8803
+ end
8804
+
8805
+ # Update properties of this object
8806
+ def update!(**args)
8807
+ @candidate_results = args[:candidate_results] if args.key?(:candidate_results)
8808
+ @evaluation_request = args[:evaluation_request] if args.key?(:evaluation_request)
8809
+ @evaluation_run = args[:evaluation_run] if args.key?(:evaluation_run)
8810
+ @metadata = args[:metadata] if args.key?(:metadata)
8811
+ @metric = args[:metric] if args.key?(:metric)
8812
+ @request = args[:request] if args.key?(:request)
8813
+ end
8814
+ end
8815
+
8816
+ # The results of the evaluation run.
8817
+ class GoogleCloudAiplatformV1EvaluationResults
8818
+ include Google::Apis::Core::Hashable
8819
+
8820
+ # The evaluation set where item level results are stored.
8821
+ # Corresponds to the JSON property `evaluationSet`
8822
+ # @return [String]
8823
+ attr_accessor :evaluation_set
8824
+
8825
+ # The summary metrics for the evaluation run.
8826
+ # Corresponds to the JSON property `summaryMetrics`
8827
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SummaryMetrics]
8828
+ attr_accessor :summary_metrics
8829
+
8830
+ def initialize(**args)
8831
+ update!(**args)
8832
+ end
8833
+
8834
+ # Update properties of this object
8835
+ def update!(**args)
8836
+ @evaluation_set = args[:evaluation_set] if args.key?(:evaluation_set)
8837
+ @summary_metrics = args[:summary_metrics] if args.key?(:summary_metrics)
8838
+ end
8839
+ end
8840
+
8841
+ # Configuration for a rubric group to be generated/saved for evaluation.
8842
+ class GoogleCloudAiplatformV1EvaluationRubricConfig
8843
+ include Google::Apis::Core::Hashable
8844
+
8845
+ # Specification for a pre-defined metric.
8846
+ # Corresponds to the JSON property `predefinedRubricGenerationSpec`
8847
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec]
8848
+ attr_accessor :predefined_rubric_generation_spec
8849
+
8850
+ # Specification for how rubrics should be generated.
8851
+ # Corresponds to the JSON property `rubricGenerationSpec`
8852
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec]
8853
+ attr_accessor :rubric_generation_spec
8854
+
8855
+ # Required. The key used to save the generated rubrics. If a generation spec is
8856
+ # provided, this key will be used for the name of the generated rubric group.
8857
+ # Otherwise, this key will be used to look up the existing rubric group on the
8858
+ # evaluation item. Note that if a rubric group key is specified on both a rubric
8859
+ # config and an evaluation metric, the key from the metric will be used to
8860
+ # select the rubrics for evaluation.
8861
+ # Corresponds to the JSON property `rubricGroupKey`
8862
+ # @return [String]
8863
+ attr_accessor :rubric_group_key
8864
+
8865
+ def initialize(**args)
8866
+ update!(**args)
8867
+ end
8868
+
8869
+ # Update properties of this object
8870
+ def update!(**args)
8871
+ @predefined_rubric_generation_spec = args[:predefined_rubric_generation_spec] if args.key?(:predefined_rubric_generation_spec)
8872
+ @rubric_generation_spec = args[:rubric_generation_spec] if args.key?(:rubric_generation_spec)
8873
+ @rubric_group_key = args[:rubric_group_key] if args.key?(:rubric_group_key)
8874
+ end
8875
+ end
8876
+
8877
+ # EvaluationRun is a resource that represents a single evaluation run, which
8878
+ # includes a set of prompts, model responses, evaluation configuration and the
8879
+ # resulting metrics.
8880
+ class GoogleCloudAiplatformV1EvaluationRun
8881
+ include Google::Apis::Core::Hashable
8882
+
8883
+ # Output only. Time when the evaluation run was completed.
8884
+ # Corresponds to the JSON property `completionTime`
8885
+ # @return [String]
8886
+ attr_accessor :completion_time
8887
+
8888
+ # Output only. Time when the evaluation run was created.
8889
+ # Corresponds to the JSON property `createTime`
8890
+ # @return [String]
8891
+ attr_accessor :create_time
8892
+
8893
+ # The data source for the evaluation run.
8894
+ # Corresponds to the JSON property `dataSource`
8895
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRunDataSource]
8896
+ attr_accessor :data_source
8897
+
8898
+ # Required. The display name of the Evaluation Run.
8899
+ # Corresponds to the JSON property `displayName`
8900
+ # @return [String]
8901
+ attr_accessor :display_name
8902
+
8903
+ # The `Status` type defines a logical error model that is suitable for different
8904
+ # programming environments, including REST APIs and RPC APIs. It is used by [
8905
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
8906
+ # data: error code, error message, and error details. You can find out more
8907
+ # about this error model and how to work with it in the [API Design Guide](https:
8908
+ # //cloud.google.com/apis/design/errors).
8909
+ # Corresponds to the JSON property `error`
8910
+ # @return [Google::Apis::AiplatformV1::GoogleRpcStatus]
8911
+ attr_accessor :error
8912
+
8913
+ # The Evalution configuration used for the evaluation run.
8914
+ # Corresponds to the JSON property `evaluationConfig`
8915
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRunEvaluationConfig]
8916
+ attr_accessor :evaluation_config
8917
+
8918
+ # The results of the evaluation run.
8919
+ # Corresponds to the JSON property `evaluationResults`
8920
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationResults]
8921
+ attr_accessor :evaluation_results
8922
+
8923
+ # Output only. The specific evaluation set of the evaluation run. For runs with
8924
+ # an evaluation set input, this will be that same set. For runs with BigQuery
8925
+ # input, it's the sampled BigQuery dataset.
8926
+ # Corresponds to the JSON property `evaluationSetSnapshot`
8927
+ # @return [String]
8928
+ attr_accessor :evaluation_set_snapshot
8929
+
8930
+ # Optional. The candidate to inference config map for the evaluation run. The
8931
+ # candidate can be up to 128 characters long and can consist of any UTF-8
8932
+ # characters.
8933
+ # Corresponds to the JSON property `inferenceConfigs`
8934
+ # @return [Hash<String,Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRunInferenceConfig>]
8935
+ attr_accessor :inference_configs
8936
+
8937
+ # Optional. Labels for the evaluation run.
8938
+ # Corresponds to the JSON property `labels`
8939
+ # @return [Hash<String,String>]
8940
+ attr_accessor :labels
8941
+
8942
+ # Optional. Metadata about the evaluation run, can be used by the caller to
8943
+ # store additional tracking information about the evaluation run.
8944
+ # Corresponds to the JSON property `metadata`
8945
+ # @return [Object]
8946
+ attr_accessor :metadata
8947
+
8948
+ # Identifier. The resource name of the EvaluationRun. This is a unique
8949
+ # identifier. Format: `projects/`project`/locations/`location`/evaluationRuns/`
8950
+ # evaluation_run``
8951
+ # Corresponds to the JSON property `name`
8952
+ # @return [String]
8953
+ attr_accessor :name
8954
+
8955
+ # Output only. The state of the evaluation run.
8956
+ # Corresponds to the JSON property `state`
8957
+ # @return [String]
8958
+ attr_accessor :state
8959
+
8960
+ def initialize(**args)
8961
+ update!(**args)
8962
+ end
8963
+
8964
+ # Update properties of this object
8965
+ def update!(**args)
8966
+ @completion_time = args[:completion_time] if args.key?(:completion_time)
8967
+ @create_time = args[:create_time] if args.key?(:create_time)
8968
+ @data_source = args[:data_source] if args.key?(:data_source)
8969
+ @display_name = args[:display_name] if args.key?(:display_name)
8970
+ @error = args[:error] if args.key?(:error)
8971
+ @evaluation_config = args[:evaluation_config] if args.key?(:evaluation_config)
8972
+ @evaluation_results = args[:evaluation_results] if args.key?(:evaluation_results)
8973
+ @evaluation_set_snapshot = args[:evaluation_set_snapshot] if args.key?(:evaluation_set_snapshot)
8974
+ @inference_configs = args[:inference_configs] if args.key?(:inference_configs)
8975
+ @labels = args[:labels] if args.key?(:labels)
8976
+ @metadata = args[:metadata] if args.key?(:metadata)
8977
+ @name = args[:name] if args.key?(:name)
8978
+ @state = args[:state] if args.key?(:state)
8979
+ end
8980
+ end
8981
+
8982
+ # The data source for the evaluation run.
8983
+ class GoogleCloudAiplatformV1EvaluationRunDataSource
8984
+ include Google::Apis::Core::Hashable
8985
+
8986
+ # The request set for the evaluation run.
8987
+ # Corresponds to the JSON property `bigqueryRequestSet`
8988
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BigQueryRequestSet]
8989
+ attr_accessor :bigquery_request_set
8990
+
8991
+ # The EvaluationSet resource name. Format: `projects/`project`/locations/`
8992
+ # location`/evaluationSets/`evaluation_set``
8993
+ # Corresponds to the JSON property `evaluationSet`
8994
+ # @return [String]
8995
+ attr_accessor :evaluation_set
8996
+
8997
+ def initialize(**args)
8998
+ update!(**args)
8999
+ end
9000
+
9001
+ # Update properties of this object
9002
+ def update!(**args)
9003
+ @bigquery_request_set = args[:bigquery_request_set] if args.key?(:bigquery_request_set)
9004
+ @evaluation_set = args[:evaluation_set] if args.key?(:evaluation_set)
9005
+ end
9006
+ end
9007
+
9008
+ # The Evalution configuration used for the evaluation run.
9009
+ class GoogleCloudAiplatformV1EvaluationRunEvaluationConfig
9010
+ include Google::Apis::Core::Hashable
9011
+
9012
+ # The autorater config used for the evaluation run.
9013
+ # Corresponds to the JSON property `autoraterConfig`
9014
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig]
9015
+ attr_accessor :autorater_config
9016
+
9017
+ # Required. The metrics to be calculated in the evaluation run.
9018
+ # Corresponds to the JSON property `metrics`
9019
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRunMetric>]
9020
+ attr_accessor :metrics
9021
+
9022
+ # The output config for the evaluation run.
9023
+ # Corresponds to the JSON property `outputConfig`
9024
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRunEvaluationConfigOutputConfig]
9025
+ attr_accessor :output_config
9026
+
9027
+ # Prompt template used for inference.
9028
+ # Corresponds to the JSON property `promptTemplate`
9029
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRunEvaluationConfigPromptTemplate]
9030
+ attr_accessor :prompt_template
9031
+
9032
+ # Optional. The rubric configs for the evaluation run. They are used to generate
9033
+ # rubrics which can be used by rubric-based metrics. Multiple rubric configs can
9034
+ # be specified for rubric generation but only one rubric config can be used for
9035
+ # a rubric-based metric. If more than one rubric config is provided, the
9036
+ # evaluation metric must specify a rubric group key. Note that if a generation
9037
+ # spec is specified on both a rubric config and an evaluation metric, the
9038
+ # rubrics generated for the metric will be used for evaluation.
9039
+ # Corresponds to the JSON property `rubricConfigs`
9040
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRubricConfig>]
9041
+ attr_accessor :rubric_configs
9042
+
9043
+ def initialize(**args)
9044
+ update!(**args)
9045
+ end
9046
+
9047
+ # Update properties of this object
9048
+ def update!(**args)
9049
+ @autorater_config = args[:autorater_config] if args.key?(:autorater_config)
9050
+ @metrics = args[:metrics] if args.key?(:metrics)
9051
+ @output_config = args[:output_config] if args.key?(:output_config)
9052
+ @prompt_template = args[:prompt_template] if args.key?(:prompt_template)
9053
+ @rubric_configs = args[:rubric_configs] if args.key?(:rubric_configs)
9054
+ end
9055
+ end
9056
+
9057
+ # The autorater config used for the evaluation run.
9058
+ class GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig
9059
+ include Google::Apis::Core::Hashable
9060
+
9061
+ # Optional. The fully qualified name of the publisher model or tuned autorater
9062
+ # endpoint to use. Publisher model format: `projects/`project`/locations/`
9063
+ # location`/publishers/*/models/*` Tuned model endpoint format: `projects/`
9064
+ # project`/locations/`location`/endpoints/`endpoint``
9065
+ # Corresponds to the JSON property `autoraterModel`
9066
+ # @return [String]
9067
+ attr_accessor :autorater_model
9068
+
9069
+ # Generation config.
9070
+ # Corresponds to the JSON property `generationConfig`
9071
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerationConfig]
9072
+ attr_accessor :generation_config
9073
+
9074
+ # Optional. Number of samples for each instance in the dataset. If not specified,
9075
+ # the default is 4. Minimum value is 1, maximum value is 32.
9076
+ # Corresponds to the JSON property `sampleCount`
9077
+ # @return [Fixnum]
9078
+ attr_accessor :sample_count
9079
+
9080
+ def initialize(**args)
9081
+ update!(**args)
9082
+ end
9083
+
9084
+ # Update properties of this object
9085
+ def update!(**args)
9086
+ @autorater_model = args[:autorater_model] if args.key?(:autorater_model)
9087
+ @generation_config = args[:generation_config] if args.key?(:generation_config)
9088
+ @sample_count = args[:sample_count] if args.key?(:sample_count)
9089
+ end
9090
+ end
9091
+
9092
+ # The output config for the evaluation run.
9093
+ class GoogleCloudAiplatformV1EvaluationRunEvaluationConfigOutputConfig
9094
+ include Google::Apis::Core::Hashable
9095
+
9096
+ # The BigQuery location for the output content.
9097
+ # Corresponds to the JSON property `bigqueryDestination`
9098
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BigQueryDestination]
9099
+ attr_accessor :bigquery_destination
9100
+
9101
+ # The Google Cloud Storage location where the output is to be written to.
9102
+ # Corresponds to the JSON property `gcsDestination`
9103
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GcsDestination]
9104
+ attr_accessor :gcs_destination
9105
+
9106
+ def initialize(**args)
9107
+ update!(**args)
9108
+ end
9109
+
9110
+ # Update properties of this object
9111
+ def update!(**args)
9112
+ @bigquery_destination = args[:bigquery_destination] if args.key?(:bigquery_destination)
9113
+ @gcs_destination = args[:gcs_destination] if args.key?(:gcs_destination)
9114
+ end
9115
+ end
9116
+
9117
+ # Prompt template used for inference.
9118
+ class GoogleCloudAiplatformV1EvaluationRunEvaluationConfigPromptTemplate
9119
+ include Google::Apis::Core::Hashable
9120
+
9121
+ # Prompt template stored in Cloud Storage. Format: "gs://my-bucket/file-name.txt"
9122
+ # .
9123
+ # Corresponds to the JSON property `gcsUri`
9124
+ # @return [String]
9125
+ attr_accessor :gcs_uri
9126
+
9127
+ # Inline prompt template. Template variables should be in the format "`var_name`"
9128
+ # . Example: "Translate the following from `source_lang` to `target_lang`: `text`
9129
+ # "
9130
+ # Corresponds to the JSON property `promptTemplate`
9131
+ # @return [String]
9132
+ attr_accessor :prompt_template
9133
+
9134
+ def initialize(**args)
9135
+ update!(**args)
9136
+ end
9137
+
9138
+ # Update properties of this object
9139
+ def update!(**args)
9140
+ @gcs_uri = args[:gcs_uri] if args.key?(:gcs_uri)
9141
+ @prompt_template = args[:prompt_template] if args.key?(:prompt_template)
9142
+ end
9143
+ end
9144
+
9145
+ # An inference config used for model inference during the evaluation run.
9146
+ class GoogleCloudAiplatformV1EvaluationRunInferenceConfig
9147
+ include Google::Apis::Core::Hashable
9148
+
9149
+ # Generation config.
9150
+ # Corresponds to the JSON property `generationConfig`
9151
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerationConfig]
9152
+ attr_accessor :generation_config
9153
+
9154
+ # Required. The fully qualified name of the publisher model or endpoint to use.
9155
+ # Publisher model format: `projects/`project`/locations/`location`/publishers/*/
9156
+ # models/*` Endpoint format: `projects/`project`/locations/`location`/endpoints/`
9157
+ # endpoint``
9158
+ # Corresponds to the JSON property `model`
9159
+ # @return [String]
9160
+ attr_accessor :model
9161
+
9162
+ def initialize(**args)
9163
+ update!(**args)
9164
+ end
9165
+
9166
+ # Update properties of this object
9167
+ def update!(**args)
9168
+ @generation_config = args[:generation_config] if args.key?(:generation_config)
9169
+ @model = args[:model] if args.key?(:model)
9170
+ end
9171
+ end
9172
+
9173
+ # The metric used for evaluation runs.
9174
+ class GoogleCloudAiplatformV1EvaluationRunMetric
9175
+ include Google::Apis::Core::Hashable
9176
+
9177
+ # Specification for an LLM based metric.
9178
+ # Corresponds to the JSON property `llmBasedMetricSpec`
9179
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRunMetricLlmBasedMetricSpec]
9180
+ attr_accessor :llm_based_metric_spec
9181
+
9182
+ # Required. The name of the metric.
9183
+ # Corresponds to the JSON property `metric`
9184
+ # @return [String]
9185
+ attr_accessor :metric
9186
+
9187
+ # Specification for a pre-defined metric.
9188
+ # Corresponds to the JSON property `predefinedMetricSpec`
9189
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec]
9190
+ attr_accessor :predefined_metric_spec
9191
+
9192
+ # Specification for a metric that is based on rubrics.
9193
+ # Corresponds to the JSON property `rubricBasedMetricSpec`
9194
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpec]
9195
+ attr_accessor :rubric_based_metric_spec
9196
+
9197
+ def initialize(**args)
9198
+ update!(**args)
9199
+ end
9200
+
9201
+ # Update properties of this object
9202
+ def update!(**args)
9203
+ @llm_based_metric_spec = args[:llm_based_metric_spec] if args.key?(:llm_based_metric_spec)
9204
+ @metric = args[:metric] if args.key?(:metric)
9205
+ @predefined_metric_spec = args[:predefined_metric_spec] if args.key?(:predefined_metric_spec)
9206
+ @rubric_based_metric_spec = args[:rubric_based_metric_spec] if args.key?(:rubric_based_metric_spec)
9207
+ end
9208
+ end
9209
+
9210
+ # Specification for an LLM based metric.
9211
+ class GoogleCloudAiplatformV1EvaluationRunMetricLlmBasedMetricSpec
9212
+ include Google::Apis::Core::Hashable
9213
+
9214
+ # Optional. Optional additional configuration for the metric.
9215
+ # Corresponds to the JSON property `additionalConfig`
9216
+ # @return [Hash<String,Object>]
9217
+ attr_accessor :additional_config
9218
+
9219
+ # The autorater config used for the evaluation run.
9220
+ # Corresponds to the JSON property `judgeAutoraterConfig`
9221
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig]
9222
+ attr_accessor :judge_autorater_config
9223
+
9224
+ # Required. Template for the prompt sent to the judge model.
9225
+ # Corresponds to the JSON property `metricPromptTemplate`
9226
+ # @return [String]
9227
+ attr_accessor :metric_prompt_template
9228
+
9229
+ # Specification for a pre-defined metric.
9230
+ # Corresponds to the JSON property `predefinedRubricGenerationSpec`
9231
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec]
9232
+ attr_accessor :predefined_rubric_generation_spec
9233
+
9234
+ # Specification for how rubrics should be generated.
9235
+ # Corresponds to the JSON property `rubricGenerationSpec`
9236
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec]
9237
+ attr_accessor :rubric_generation_spec
9238
+
9239
+ # Use a pre-defined group of rubrics associated with the input. Refers to a key
9240
+ # in the rubric_groups map of EvaluationInstance.
9241
+ # Corresponds to the JSON property `rubricGroupKey`
9242
+ # @return [String]
9243
+ attr_accessor :rubric_group_key
9244
+
9245
+ # Optional. System instructions for the judge model.
9246
+ # Corresponds to the JSON property `systemInstruction`
9247
+ # @return [String]
9248
+ attr_accessor :system_instruction
9249
+
9250
+ def initialize(**args)
9251
+ update!(**args)
9252
+ end
9253
+
9254
+ # Update properties of this object
9255
+ def update!(**args)
9256
+ @additional_config = args[:additional_config] if args.key?(:additional_config)
9257
+ @judge_autorater_config = args[:judge_autorater_config] if args.key?(:judge_autorater_config)
9258
+ @metric_prompt_template = args[:metric_prompt_template] if args.key?(:metric_prompt_template)
9259
+ @predefined_rubric_generation_spec = args[:predefined_rubric_generation_spec] if args.key?(:predefined_rubric_generation_spec)
9260
+ @rubric_generation_spec = args[:rubric_generation_spec] if args.key?(:rubric_generation_spec)
9261
+ @rubric_group_key = args[:rubric_group_key] if args.key?(:rubric_group_key)
9262
+ @system_instruction = args[:system_instruction] if args.key?(:system_instruction)
9263
+ end
9264
+ end
9265
+
9266
+ # Specification for a pre-defined metric.
9267
+ class GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec
9268
+ include Google::Apis::Core::Hashable
9269
+
9270
+ # Required. The name of a pre-defined metric, such as "instruction_following_v1"
9271
+ # or "text_quality_v1".
9272
+ # Corresponds to the JSON property `metricSpecName`
9273
+ # @return [String]
9274
+ attr_accessor :metric_spec_name
9275
+
9276
+ # Optional. The parameters needed to run the pre-defined metric.
9277
+ # Corresponds to the JSON property `parameters`
9278
+ # @return [Hash<String,Object>]
9279
+ attr_accessor :parameters
9280
+
9281
+ def initialize(**args)
9282
+ update!(**args)
9283
+ end
9284
+
9285
+ # Update properties of this object
9286
+ def update!(**args)
9287
+ @metric_spec_name = args[:metric_spec_name] if args.key?(:metric_spec_name)
9288
+ @parameters = args[:parameters] if args.key?(:parameters)
9289
+ end
9290
+ end
9291
+
9292
+ # Specification for a metric that is based on rubrics.
9293
+ class GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpec
9294
+ include Google::Apis::Core::Hashable
9295
+
9296
+ # Defines a list of rubrics, used when providing rubrics inline.
9297
+ # Corresponds to the JSON property `inlineRubrics`
9298
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpecRepeatedRubrics]
9299
+ attr_accessor :inline_rubrics
9300
+
9301
+ # The autorater config used for the evaluation run.
9302
+ # Corresponds to the JSON property `judgeAutoraterConfig`
9303
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig]
9304
+ attr_accessor :judge_autorater_config
9305
+
9306
+ # Optional. Template for the prompt used by the judge model to evaluate against
9307
+ # rubrics.
9308
+ # Corresponds to the JSON property `metricPromptTemplate`
9309
+ # @return [String]
9310
+ attr_accessor :metric_prompt_template
9311
+
9312
+ # Specification for how rubrics should be generated.
9313
+ # Corresponds to the JSON property `rubricGenerationSpec`
9314
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec]
9315
+ attr_accessor :rubric_generation_spec
9316
+
9317
+ # Use a pre-defined group of rubrics associated with the input content. This
9318
+ # refers to a key in the `rubric_groups` map of `RubricEnhancedContents`.
9319
+ # Corresponds to the JSON property `rubricGroupKey`
9320
+ # @return [String]
9321
+ attr_accessor :rubric_group_key
9322
+
9323
+ def initialize(**args)
9324
+ update!(**args)
9325
+ end
9326
+
9327
+ # Update properties of this object
9328
+ def update!(**args)
9329
+ @inline_rubrics = args[:inline_rubrics] if args.key?(:inline_rubrics)
9330
+ @judge_autorater_config = args[:judge_autorater_config] if args.key?(:judge_autorater_config)
9331
+ @metric_prompt_template = args[:metric_prompt_template] if args.key?(:metric_prompt_template)
9332
+ @rubric_generation_spec = args[:rubric_generation_spec] if args.key?(:rubric_generation_spec)
9333
+ @rubric_group_key = args[:rubric_group_key] if args.key?(:rubric_group_key)
9334
+ end
9335
+ end
9336
+
9337
+ # Defines a list of rubrics, used when providing rubrics inline.
9338
+ class GoogleCloudAiplatformV1EvaluationRunMetricRubricBasedMetricSpecRepeatedRubrics
9339
+ include Google::Apis::Core::Hashable
9340
+
9341
+ # The list of rubrics.
9342
+ # Corresponds to the JSON property `rubrics`
9343
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Rubric>]
9344
+ attr_accessor :rubrics
9345
+
9346
+ def initialize(**args)
9347
+ update!(**args)
9348
+ end
9349
+
9350
+ # Update properties of this object
9351
+ def update!(**args)
9352
+ @rubrics = args[:rubrics] if args.key?(:rubrics)
9353
+ end
9354
+ end
9355
+
9356
+ # Specification for how rubrics should be generated.
9357
+ class GoogleCloudAiplatformV1EvaluationRunMetricRubricGenerationSpec
9358
+ include Google::Apis::Core::Hashable
9359
+
9360
+ # The autorater config used for the evaluation run.
9361
+ # Corresponds to the JSON property `modelConfig`
9362
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig]
9363
+ attr_accessor :model_config
9364
+
9365
+ # Optional. Template for the prompt used to generate rubrics. The details should
9366
+ # be updated based on the most-recent recipe requirements.
9367
+ # Corresponds to the JSON property `promptTemplate`
9368
+ # @return [String]
9369
+ attr_accessor :prompt_template
9370
+
9371
+ # Optional. The type of rubric content to be generated.
9372
+ # Corresponds to the JSON property `rubricContentType`
9373
+ # @return [String]
9374
+ attr_accessor :rubric_content_type
9375
+
9376
+ # Optional. An optional, pre-defined list of allowed types for generated rubrics.
9377
+ # If this field is provided, it implies `include_rubric_type` should be true,
9378
+ # and the generated rubric types should be chosen from this ontology.
9379
+ # Corresponds to the JSON property `rubricTypeOntology`
9380
+ # @return [Array<String>]
9381
+ attr_accessor :rubric_type_ontology
9382
+
9383
+ def initialize(**args)
9384
+ update!(**args)
9385
+ end
9386
+
9387
+ # Update properties of this object
9388
+ def update!(**args)
9389
+ @model_config = args[:model_config] if args.key?(:model_config)
9390
+ @prompt_template = args[:prompt_template] if args.key?(:prompt_template)
9391
+ @rubric_content_type = args[:rubric_content_type] if args.key?(:rubric_content_type)
9392
+ @rubric_type_ontology = args[:rubric_type_ontology] if args.key?(:rubric_type_ontology)
9393
+ end
9394
+ end
9395
+
9396
+ # EvaluationSet is a collection of related EvaluationItems that are evaluated
9397
+ # together.
9398
+ class GoogleCloudAiplatformV1EvaluationSet
9399
+ include Google::Apis::Core::Hashable
9400
+
9401
+ # Output only. Timestamp when this item was created.
9402
+ # Corresponds to the JSON property `createTime`
9403
+ # @return [String]
9404
+ attr_accessor :create_time
9405
+
9406
+ # Required. The display name of the EvaluationSet.
9407
+ # Corresponds to the JSON property `displayName`
9408
+ # @return [String]
9409
+ attr_accessor :display_name
9410
+
9411
+ # Required. The EvaluationItems that are part of this dataset.
9412
+ # Corresponds to the JSON property `evaluationItems`
9413
+ # @return [Array<String>]
9414
+ attr_accessor :evaluation_items
9415
+
9416
+ # Optional. Metadata for the EvaluationSet.
9417
+ # Corresponds to the JSON property `metadata`
9418
+ # @return [Object]
9419
+ attr_accessor :metadata
9420
+
9421
+ # Identifier. The resource name of the EvaluationSet. Format: `projects/`project`
9422
+ # /locations/`location`/evaluationSets/`evaluation_set``
9423
+ # Corresponds to the JSON property `name`
9424
+ # @return [String]
9425
+ attr_accessor :name
9426
+
9427
+ # Output only. Timestamp when this item was last updated.
9428
+ # Corresponds to the JSON property `updateTime`
9429
+ # @return [String]
9430
+ attr_accessor :update_time
9431
+
9432
+ def initialize(**args)
9433
+ update!(**args)
9434
+ end
9435
+
9436
+ # Update properties of this object
9437
+ def update!(**args)
9438
+ @create_time = args[:create_time] if args.key?(:create_time)
9439
+ @display_name = args[:display_name] if args.key?(:display_name)
9440
+ @evaluation_items = args[:evaluation_items] if args.key?(:evaluation_items)
9441
+ @metadata = args[:metadata] if args.key?(:metadata)
9442
+ @name = args[:name] if args.key?(:name)
9443
+ @update_time = args[:update_time] if args.key?(:update_time)
9444
+ end
9445
+ end
9446
+
8413
9447
  # An edge describing the relationship between an Artifact and an Execution in a
8414
9448
  # lineage graph.
8415
9449
  class GoogleCloudAiplatformV1Event
@@ -12971,7 +14005,9 @@ module Google
12971
14005
  # @return [String]
12972
14006
  attr_accessor :model_version
12973
14007
 
12974
- # Content filter results for a prompt sent in the request.
14008
+ # Content filter results for a prompt sent in the request. Note: This is sent
14009
+ # only in the first stream chunk and only if no candidates were generated due to
14010
+ # content violations.
12975
14011
  # Corresponds to the JSON property `promptFeedback`
12976
14012
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback]
12977
14013
  attr_accessor :prompt_feedback
@@ -12982,7 +14018,8 @@ module Google
12982
14018
  # @return [String]
12983
14019
  attr_accessor :response_id
12984
14020
 
12985
- # Usage metadata about response(s).
14021
+ # Usage metadata about the content generation request and response. This message
14022
+ # provides a detailed breakdown of token usage and other relevant metrics.
12986
14023
  # Corresponds to the JSON property `usageMetadata`
12987
14024
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata]
12988
14025
  attr_accessor :usage_metadata
@@ -13002,21 +14039,25 @@ module Google
13002
14039
  end
13003
14040
  end
13004
14041
 
13005
- # Content filter results for a prompt sent in the request.
14042
+ # Content filter results for a prompt sent in the request. Note: This is sent
14043
+ # only in the first stream chunk and only if no candidates were generated due to
14044
+ # content violations.
13006
14045
  class GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback
13007
14046
  include Google::Apis::Core::Hashable
13008
14047
 
13009
- # Output only. Blocked reason.
14048
+ # Output only. The reason why the prompt was blocked.
13010
14049
  # Corresponds to the JSON property `blockReason`
13011
14050
  # @return [String]
13012
14051
  attr_accessor :block_reason
13013
14052
 
13014
- # Output only. A readable block reason message.
14053
+ # Output only. A readable message that explains the reason why the prompt was
14054
+ # blocked.
13015
14055
  # Corresponds to the JSON property `blockReasonMessage`
13016
14056
  # @return [String]
13017
14057
  attr_accessor :block_reason_message
13018
14058
 
13019
- # Output only. Safety ratings.
14059
+ # Output only. A list of safety ratings for the prompt. There is one rating per
14060
+ # category.
13020
14061
  # Corresponds to the JSON property `safetyRatings`
13021
14062
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SafetyRating>]
13022
14063
  attr_accessor :safety_ratings
@@ -13033,67 +14074,73 @@ module Google
13033
14074
  end
13034
14075
  end
13035
14076
 
13036
- # Usage metadata about response(s).
14077
+ # Usage metadata about the content generation request and response. This message
14078
+ # provides a detailed breakdown of token usage and other relevant metrics.
13037
14079
  class GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata
13038
14080
  include Google::Apis::Core::Hashable
13039
14081
 
13040
- # Output only. List of modalities of the cached content in the request input.
14082
+ # Output only. A detailed breakdown of the token count for each modality in the
14083
+ # cached content.
13041
14084
  # Corresponds to the JSON property `cacheTokensDetails`
13042
14085
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModalityTokenCount>]
13043
14086
  attr_accessor :cache_tokens_details
13044
14087
 
13045
- # Output only. Number of tokens in the cached part in the input (the cached
13046
- # content).
14088
+ # Output only. The number of tokens in the cached content that was used for this
14089
+ # request.
13047
14090
  # Corresponds to the JSON property `cachedContentTokenCount`
13048
14091
  # @return [Fixnum]
13049
14092
  attr_accessor :cached_content_token_count
13050
14093
 
13051
- # Number of tokens in the response(s).
14094
+ # The total number of tokens in the generated candidates.
13052
14095
  # Corresponds to the JSON property `candidatesTokenCount`
13053
14096
  # @return [Fixnum]
13054
14097
  attr_accessor :candidates_token_count
13055
14098
 
13056
- # Output only. List of modalities that were returned in the response.
14099
+ # Output only. A detailed breakdown of the token count for each modality in the
14100
+ # generated candidates.
13057
14101
  # Corresponds to the JSON property `candidatesTokensDetails`
13058
14102
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModalityTokenCount>]
13059
14103
  attr_accessor :candidates_tokens_details
13060
14104
 
13061
- # Number of tokens in the request. When `cached_content` is set, this is still
13062
- # the total effective prompt size meaning this includes the number of tokens in
13063
- # the cached content.
14105
+ # The total number of tokens in the prompt. This includes any text, images, or
14106
+ # other media provided in the request. When `cached_content` is set, this also
14107
+ # includes the number of tokens in the cached content.
13064
14108
  # Corresponds to the JSON property `promptTokenCount`
13065
14109
  # @return [Fixnum]
13066
14110
  attr_accessor :prompt_token_count
13067
14111
 
13068
- # Output only. List of modalities that were processed in the request input.
14112
+ # Output only. A detailed breakdown of the token count for each modality in the
14113
+ # prompt.
13069
14114
  # Corresponds to the JSON property `promptTokensDetails`
13070
14115
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModalityTokenCount>]
13071
14116
  attr_accessor :prompt_tokens_details
13072
14117
 
13073
- # Output only. Number of tokens present in thoughts output.
14118
+ # Output only. The number of tokens that were part of the model's generated "
14119
+ # thoughts" output, if applicable.
13074
14120
  # Corresponds to the JSON property `thoughtsTokenCount`
13075
14121
  # @return [Fixnum]
13076
14122
  attr_accessor :thoughts_token_count
13077
14123
 
13078
- # Output only. Number of tokens present in tool-use prompt(s).
14124
+ # Output only. The number of tokens in the results from tool executions, which
14125
+ # are provided back to the model as input, if applicable.
13079
14126
  # Corresponds to the JSON property `toolUsePromptTokenCount`
13080
14127
  # @return [Fixnum]
13081
14128
  attr_accessor :tool_use_prompt_token_count
13082
14129
 
13083
- # Output only. List of modalities that were processed for tool-use request
13084
- # inputs.
14130
+ # Output only. A detailed breakdown by modality of the token counts from the
14131
+ # results of tool executions, which are provided back to the model as input.
13085
14132
  # Corresponds to the JSON property `toolUsePromptTokensDetails`
13086
14133
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModalityTokenCount>]
13087
14134
  attr_accessor :tool_use_prompt_tokens_details
13088
14135
 
13089
- # Total token count for prompt, response candidates, and tool-use prompts (if
13090
- # present).
14136
+ # The total number of tokens for the entire request. This is the sum of `
14137
+ # prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`,
14138
+ # and `thoughts_token_count`.
13091
14139
  # Corresponds to the JSON property `totalTokenCount`
13092
14140
  # @return [Fixnum]
13093
14141
  attr_accessor :total_token_count
13094
14142
 
13095
- # Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go
13096
- # or Provisioned Throughput quota.
14143
+ # Output only. The traffic type for this request.
13097
14144
  # Corresponds to the JSON property `trafficType`
13098
14145
  # @return [String]
13099
14146
  attr_accessor :traffic_type
@@ -13170,6 +14217,64 @@ module Google
13170
14217
  end
13171
14218
  end
13172
14219
 
14220
+ # Request message for DataFoundryService.GenerateSyntheticData.
14221
+ class GoogleCloudAiplatformV1GenerateSyntheticDataRequest
14222
+ include Google::Apis::Core::Hashable
14223
+
14224
+ # Required. The number of synthetic examples to generate. For this stateless API,
14225
+ # the count is limited to a small number.
14226
+ # Corresponds to the JSON property `count`
14227
+ # @return [Fixnum]
14228
+ attr_accessor :count
14229
+
14230
+ # Optional. A list of few-shot examples to guide the model's output style and
14231
+ # format.
14232
+ # Corresponds to the JSON property `examples`
14233
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SyntheticExample>]
14234
+ attr_accessor :examples
14235
+
14236
+ # Required. The schema of the desired output, defined by a list of fields.
14237
+ # Corresponds to the JSON property `outputFieldSpecs`
14238
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1OutputFieldSpec>]
14239
+ attr_accessor :output_field_specs
14240
+
14241
+ # Defines a generation strategy based on a high-level task description.
14242
+ # Corresponds to the JSON property `taskDescription`
14243
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TaskDescriptionStrategy]
14244
+ attr_accessor :task_description
14245
+
14246
+ def initialize(**args)
14247
+ update!(**args)
14248
+ end
14249
+
14250
+ # Update properties of this object
14251
+ def update!(**args)
14252
+ @count = args[:count] if args.key?(:count)
14253
+ @examples = args[:examples] if args.key?(:examples)
14254
+ @output_field_specs = args[:output_field_specs] if args.key?(:output_field_specs)
14255
+ @task_description = args[:task_description] if args.key?(:task_description)
14256
+ end
14257
+ end
14258
+
14259
+ # The response containing the generated data.
14260
+ class GoogleCloudAiplatformV1GenerateSyntheticDataResponse
14261
+ include Google::Apis::Core::Hashable
14262
+
14263
+ # A list of generated synthetic examples.
14264
+ # Corresponds to the JSON property `syntheticExamples`
14265
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SyntheticExample>]
14266
+ attr_accessor :synthetic_examples
14267
+
14268
+ def initialize(**args)
14269
+ update!(**args)
14270
+ end
14271
+
14272
+ # Update properties of this object
14273
+ def update!(**args)
14274
+ @synthetic_examples = args[:synthetic_examples] if args.key?(:synthetic_examples)
14275
+ end
14276
+ end
14277
+
13173
14278
  # Generate video response.
13174
14279
  class GoogleCloudAiplatformV1GenerateVideoResponse
13175
14280
  include Google::Apis::Core::Hashable
@@ -13596,12 +14701,19 @@ module Google
13596
14701
  class GoogleCloudAiplatformV1GoogleMaps
13597
14702
  include Google::Apis::Core::Hashable
13598
14703
 
14704
+ # Optional. If true, include the widget context token in the response.
14705
+ # Corresponds to the JSON property `enableWidget`
14706
+ # @return [Boolean]
14707
+ attr_accessor :enable_widget
14708
+ alias_method :enable_widget?, :enable_widget
14709
+
13599
14710
  def initialize(**args)
13600
14711
  update!(**args)
13601
14712
  end
13602
14713
 
13603
14714
  # Update properties of this object
13604
14715
  def update!(**args)
14716
+ @enable_widget = args[:enable_widget] if args.key?(:enable_widget)
13605
14717
  end
13606
14718
  end
13607
14719
 
@@ -13771,17 +14883,17 @@ module Google
13771
14883
  # @return [String]
13772
14884
  attr_accessor :place_id
13773
14885
 
13774
- # Text of the chunk.
14886
+ # Text of the place answer.
13775
14887
  # Corresponds to the JSON property `text`
13776
14888
  # @return [String]
13777
14889
  attr_accessor :text
13778
14890
 
13779
- # Title of the chunk.
14891
+ # Title of the place.
13780
14892
  # Corresponds to the JSON property `title`
13781
14893
  # @return [String]
13782
14894
  attr_accessor :title
13783
14895
 
13784
- # URI reference of the chunk.
14896
+ # URI reference of the place.
13785
14897
  # Corresponds to the JSON property `uri`
13786
14898
  # @return [String]
13787
14899
  attr_accessor :uri
@@ -13804,11 +14916,6 @@ module Google
13804
14916
  class GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources
13805
14917
  include Google::Apis::Core::Hashable
13806
14918
 
13807
- # A link where users can flag a problem with the generated answer.
13808
- # Corresponds to the JSON property `flagContentUri`
13809
- # @return [String]
13810
- attr_accessor :flag_content_uri
13811
-
13812
14919
  # Snippets of reviews that are used to generate the answer.
13813
14920
  # Corresponds to the JSON property `reviewSnippets`
13814
14921
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet>]
@@ -13820,72 +14927,28 @@ module Google
13820
14927
 
13821
14928
  # Update properties of this object
13822
14929
  def update!(**args)
13823
- @flag_content_uri = args[:flag_content_uri] if args.key?(:flag_content_uri)
13824
14930
  @review_snippets = args[:review_snippets] if args.key?(:review_snippets)
13825
14931
  end
13826
14932
  end
13827
14933
 
13828
- # Author attribution for a photo or review.
13829
- class GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution
13830
- include Google::Apis::Core::Hashable
13831
-
13832
- # Name of the author of the Photo or Review.
13833
- # Corresponds to the JSON property `displayName`
13834
- # @return [String]
13835
- attr_accessor :display_name
13836
-
13837
- # Profile photo URI of the author of the Photo or Review.
13838
- # Corresponds to the JSON property `photoUri`
13839
- # @return [String]
13840
- attr_accessor :photo_uri
13841
-
13842
- # URI of the author of the Photo or Review.
13843
- # Corresponds to the JSON property `uri`
13844
- # @return [String]
13845
- attr_accessor :uri
13846
-
13847
- def initialize(**args)
13848
- update!(**args)
13849
- end
13850
-
13851
- # Update properties of this object
13852
- def update!(**args)
13853
- @display_name = args[:display_name] if args.key?(:display_name)
13854
- @photo_uri = args[:photo_uri] if args.key?(:photo_uri)
13855
- @uri = args[:uri] if args.key?(:uri)
13856
- end
13857
- end
13858
-
13859
14934
  # Encapsulates a review snippet.
13860
14935
  class GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet
13861
14936
  include Google::Apis::Core::Hashable
13862
14937
 
13863
- # Author attribution for a photo or review.
13864
- # Corresponds to the JSON property `authorAttribution`
13865
- # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution]
13866
- attr_accessor :author_attribution
13867
-
13868
- # A link where users can flag a problem with the review.
13869
- # Corresponds to the JSON property `flagContentUri`
13870
- # @return [String]
13871
- attr_accessor :flag_content_uri
13872
-
13873
14938
  # A link to show the review on Google Maps.
13874
14939
  # Corresponds to the JSON property `googleMapsUri`
13875
14940
  # @return [String]
13876
14941
  attr_accessor :google_maps_uri
13877
14942
 
13878
- # A string of formatted recent time, expressing the review time relative to the
13879
- # current time in a form appropriate for the language and country.
13880
- # Corresponds to the JSON property `relativePublishTimeDescription`
14943
+ # Id of the review referencing the place.
14944
+ # Corresponds to the JSON property `reviewId`
13881
14945
  # @return [String]
13882
- attr_accessor :relative_publish_time_description
14946
+ attr_accessor :review_id
13883
14947
 
13884
- # A reference representing this place review which may be used to look up this
13885
- # place review again.
13886
- # Corresponds to the JSON property `review`
14948
+ # Title of the review.
14949
+ # Corresponds to the JSON property `title`
13887
14950
  # @return [String]
13888
- attr_accessor :review
14951
+ attr_accessor :title
13889
14952
 
13890
14953
  def initialize(**args)
13891
14954
  update!(**args)
@@ -13893,11 +14956,9 @@ module Google
13893
14956
 
13894
14957
  # Update properties of this object
13895
14958
  def update!(**args)
13896
- @author_attribution = args[:author_attribution] if args.key?(:author_attribution)
13897
- @flag_content_uri = args[:flag_content_uri] if args.key?(:flag_content_uri)
13898
14959
  @google_maps_uri = args[:google_maps_uri] if args.key?(:google_maps_uri)
13899
- @relative_publish_time_description = args[:relative_publish_time_description] if args.key?(:relative_publish_time_description)
13900
- @review = args[:review] if args.key?(:review)
14960
+ @review_id = args[:review_id] if args.key?(:review_id)
14961
+ @title = args[:title] if args.key?(:title)
13901
14962
  end
13902
14963
  end
13903
14964
 
@@ -14008,6 +15069,12 @@ module Google
14008
15069
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchEntryPoint]
14009
15070
  attr_accessor :search_entry_point
14010
15071
 
15072
+ # Optional. Output only. List of source flagging uris. This is currently
15073
+ # populated only for Google Maps grounding.
15074
+ # Corresponds to the JSON property `sourceFlaggingUris`
15075
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri>]
15076
+ attr_accessor :source_flagging_uris
15077
+
14011
15078
  # Optional. Web search queries for the following-up web search.
14012
15079
  # Corresponds to the JSON property `webSearchQueries`
14013
15080
  # @return [Array<String>]
@@ -14024,10 +15091,37 @@ module Google
14024
15091
  @grounding_supports = args[:grounding_supports] if args.key?(:grounding_supports)
14025
15092
  @retrieval_metadata = args[:retrieval_metadata] if args.key?(:retrieval_metadata)
14026
15093
  @search_entry_point = args[:search_entry_point] if args.key?(:search_entry_point)
15094
+ @source_flagging_uris = args[:source_flagging_uris] if args.key?(:source_flagging_uris)
14027
15095
  @web_search_queries = args[:web_search_queries] if args.key?(:web_search_queries)
14028
15096
  end
14029
15097
  end
14030
15098
 
15099
+ # Source content flagging uri for a place or review. This is currently populated
15100
+ # only for Google Maps grounding.
15101
+ class GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri
15102
+ include Google::Apis::Core::Hashable
15103
+
15104
+ # A link where users can flag a problem with the source (place or review).
15105
+ # Corresponds to the JSON property `flagContentUri`
15106
+ # @return [String]
15107
+ attr_accessor :flag_content_uri
15108
+
15109
+ # Id of the place or review.
15110
+ # Corresponds to the JSON property `sourceId`
15111
+ # @return [String]
15112
+ attr_accessor :source_id
15113
+
15114
+ def initialize(**args)
15115
+ update!(**args)
15116
+ end
15117
+
15118
+ # Update properties of this object
15119
+ def update!(**args)
15120
+ @flag_content_uri = args[:flag_content_uri] if args.key?(:flag_content_uri)
15121
+ @source_id = args[:source_id] if args.key?(:source_id)
15122
+ end
15123
+ end
15124
+
14031
15125
  # Grounding support.
14032
15126
  class GoogleCloudAiplatformV1GroundingSupport
14033
15127
  include Google::Apis::Core::Hashable
@@ -15406,6 +16500,46 @@ module Google
15406
16500
  end
15407
16501
  end
15408
16502
 
16503
+ # Request message for PredictionService.Invoke.
16504
+ class GoogleCloudAiplatformV1InvokeRequest
16505
+ include Google::Apis::Core::Hashable
16506
+
16507
+ # ID of the DeployedModel that serves the invoke request.
16508
+ # Corresponds to the JSON property `deployedModelId`
16509
+ # @return [String]
16510
+ attr_accessor :deployed_model_id
16511
+
16512
+ # Message that represents an arbitrary HTTP body. It should only be used for
16513
+ # payload formats that can't be represented as JSON, such as raw binary or an
16514
+ # HTML page. This message can be used both in streaming and non-streaming API
16515
+ # methods in the request as well as the response. It can be used as a top-level
16516
+ # request field, which is convenient if one wants to extract parameters from
16517
+ # either the URL or HTTP template into the request fields and also want access
16518
+ # to the raw HTTP body. Example: message GetResourceRequest ` // A unique
16519
+ # request id. string request_id = 1; // The raw HTTP body is bound to this field.
16520
+ # google.api.HttpBody http_body = 2; ` service ResourceService ` rpc
16521
+ # GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc
16522
+ # UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); ` Example
16523
+ # with streaming methods: service CaldavService ` rpc GetCalendar(stream google.
16524
+ # api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream
16525
+ # google.api.HttpBody) returns (stream google.api.HttpBody); ` Use of this type
16526
+ # only changes how the request and response bodies are handled, all other
16527
+ # features will continue to work unchanged.
16528
+ # Corresponds to the JSON property `httpBody`
16529
+ # @return [Google::Apis::AiplatformV1::GoogleApiHttpBody]
16530
+ attr_accessor :http_body
16531
+
16532
+ def initialize(**args)
16533
+ update!(**args)
16534
+ end
16535
+
16536
+ # Update properties of this object
16537
+ def update!(**args)
16538
+ @deployed_model_id = args[:deployed_model_id] if args.key?(:deployed_model_id)
16539
+ @http_body = args[:http_body] if args.key?(:http_body)
16540
+ end
16541
+ end
16542
+
15409
16543
  # The Jira source for the ImportRagFilesRequest.
15410
16544
  class GoogleCloudAiplatformV1JiraSource
15411
16545
  include Google::Apis::Core::Hashable
@@ -15470,6 +16604,63 @@ module Google
15470
16604
  end
15471
16605
  end
15472
16606
 
16607
+ # Specification for an LLM based metric.
16608
+ class GoogleCloudAiplatformV1LlmBasedMetricSpec
16609
+ include Google::Apis::Core::Hashable
16610
+
16611
+ # Optional. Optional additional configuration for the metric.
16612
+ # Corresponds to the JSON property `additionalConfig`
16613
+ # @return [Hash<String,Object>]
16614
+ attr_accessor :additional_config
16615
+
16616
+ # The configs for autorater. This is applicable to both EvaluateInstances and
16617
+ # EvaluateDataset.
16618
+ # Corresponds to the JSON property `judgeAutoraterConfig`
16619
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AutoraterConfig]
16620
+ attr_accessor :judge_autorater_config
16621
+
16622
+ # Required. Template for the prompt sent to the judge model.
16623
+ # Corresponds to the JSON property `metricPromptTemplate`
16624
+ # @return [String]
16625
+ attr_accessor :metric_prompt_template
16626
+
16627
+ # The spec for a pre-defined metric.
16628
+ # Corresponds to the JSON property `predefinedRubricGenerationSpec`
16629
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredefinedMetricSpec]
16630
+ attr_accessor :predefined_rubric_generation_spec
16631
+
16632
+ # Specification for how rubrics should be generated.
16633
+ # Corresponds to the JSON property `rubricGenerationSpec`
16634
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RubricGenerationSpec]
16635
+ attr_accessor :rubric_generation_spec
16636
+
16637
+ # Use a pre-defined group of rubrics associated with the input. Refers to a key
16638
+ # in the rubric_groups map of EvaluationInstance.
16639
+ # Corresponds to the JSON property `rubricGroupKey`
16640
+ # @return [String]
16641
+ attr_accessor :rubric_group_key
16642
+
16643
+ # Optional. System instructions for the judge model.
16644
+ # Corresponds to the JSON property `systemInstruction`
16645
+ # @return [String]
16646
+ attr_accessor :system_instruction
16647
+
16648
+ def initialize(**args)
16649
+ update!(**args)
16650
+ end
16651
+
16652
+ # Update properties of this object
16653
+ def update!(**args)
16654
+ @additional_config = args[:additional_config] if args.key?(:additional_config)
16655
+ @judge_autorater_config = args[:judge_autorater_config] if args.key?(:judge_autorater_config)
16656
+ @metric_prompt_template = args[:metric_prompt_template] if args.key?(:metric_prompt_template)
16657
+ @predefined_rubric_generation_spec = args[:predefined_rubric_generation_spec] if args.key?(:predefined_rubric_generation_spec)
16658
+ @rubric_generation_spec = args[:rubric_generation_spec] if args.key?(:rubric_generation_spec)
16659
+ @rubric_group_key = args[:rubric_group_key] if args.key?(:rubric_group_key)
16660
+ @system_instruction = args[:system_instruction] if args.key?(:system_instruction)
16661
+ end
16662
+ end
16663
+
15473
16664
  # Contains information about the Large Model.
15474
16665
  class GoogleCloudAiplatformV1LargeModelReference
15475
16666
  include Google::Apis::Core::Hashable
@@ -15856,6 +17047,81 @@ module Google
15856
17047
  end
15857
17048
  end
15858
17049
 
17050
+ # Response message for EvaluationManagementService.ListEvaluationItems.
17051
+ class GoogleCloudAiplatformV1ListEvaluationItemsResponse
17052
+ include Google::Apis::Core::Hashable
17053
+
17054
+ # List of EvaluationItems in the requested page.
17055
+ # Corresponds to the JSON property `evaluationItems`
17056
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationItem>]
17057
+ attr_accessor :evaluation_items
17058
+
17059
+ # A token to retrieve the next page of results.
17060
+ # Corresponds to the JSON property `nextPageToken`
17061
+ # @return [String]
17062
+ attr_accessor :next_page_token
17063
+
17064
+ def initialize(**args)
17065
+ update!(**args)
17066
+ end
17067
+
17068
+ # Update properties of this object
17069
+ def update!(**args)
17070
+ @evaluation_items = args[:evaluation_items] if args.key?(:evaluation_items)
17071
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
17072
+ end
17073
+ end
17074
+
17075
+ # Response message for EvaluationManagementService.ListEvaluationRuns.
17076
+ class GoogleCloudAiplatformV1ListEvaluationRunsResponse
17077
+ include Google::Apis::Core::Hashable
17078
+
17079
+ # List of EvaluationRuns in the requested page.
17080
+ # Corresponds to the JSON property `evaluationRuns`
17081
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRun>]
17082
+ attr_accessor :evaluation_runs
17083
+
17084
+ # A token to retrieve the next page of results.
17085
+ # Corresponds to the JSON property `nextPageToken`
17086
+ # @return [String]
17087
+ attr_accessor :next_page_token
17088
+
17089
+ def initialize(**args)
17090
+ update!(**args)
17091
+ end
17092
+
17093
+ # Update properties of this object
17094
+ def update!(**args)
17095
+ @evaluation_runs = args[:evaluation_runs] if args.key?(:evaluation_runs)
17096
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
17097
+ end
17098
+ end
17099
+
17100
+ # Response message for EvaluationManagementService.ListEvaluationSets.
17101
+ class GoogleCloudAiplatformV1ListEvaluationSetsResponse
17102
+ include Google::Apis::Core::Hashable
17103
+
17104
+ # List of EvaluationSets in the requested page.
17105
+ # Corresponds to the JSON property `evaluationSets`
17106
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationSet>]
17107
+ attr_accessor :evaluation_sets
17108
+
17109
+ # A token to retrieve the next page of results.
17110
+ # Corresponds to the JSON property `nextPageToken`
17111
+ # @return [String]
17112
+ attr_accessor :next_page_token
17113
+
17114
+ def initialize(**args)
17115
+ update!(**args)
17116
+ end
17117
+
17118
+ # Update properties of this object
17119
+ def update!(**args)
17120
+ @evaluation_sets = args[:evaluation_sets] if args.key?(:evaluation_sets)
17121
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
17122
+ end
17123
+ end
17124
+
15859
17125
  # Response message for MetadataService.ListExecutions.
15860
17126
  class GoogleCloudAiplatformV1ListExecutionsResponse
15861
17127
  include Google::Apis::Core::Hashable
@@ -17344,6 +18610,11 @@ module Google
17344
18610
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ExactMatchSpec]
17345
18611
  attr_accessor :exact_match_spec
17346
18612
 
18613
+ # Specification for an LLM based metric.
18614
+ # Corresponds to the JSON property `llmBasedMetricSpec`
18615
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1LlmBasedMetricSpec]
18616
+ attr_accessor :llm_based_metric_spec
18617
+
17347
18618
  # Spec for pairwise metric.
17348
18619
  # Corresponds to the JSON property `pairwiseMetricSpec`
17349
18620
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PairwiseMetricSpec]
@@ -17374,6 +18645,7 @@ module Google
17374
18645
  @aggregation_metrics = args[:aggregation_metrics] if args.key?(:aggregation_metrics)
17375
18646
  @bleu_spec = args[:bleu_spec] if args.key?(:bleu_spec)
17376
18647
  @exact_match_spec = args[:exact_match_spec] if args.key?(:exact_match_spec)
18648
+ @llm_based_metric_spec = args[:llm_based_metric_spec] if args.key?(:llm_based_metric_spec)
17377
18649
  @pairwise_metric_spec = args[:pairwise_metric_spec] if args.key?(:pairwise_metric_spec)
17378
18650
  @pointwise_metric_spec = args[:pointwise_metric_spec] if args.key?(:pointwise_metric_spec)
17379
18651
  @predefined_metric_spec = args[:predefined_metric_spec] if args.key?(:predefined_metric_spec)
@@ -17385,18 +18657,28 @@ module Google
17385
18657
  class GoogleCloudAiplatformV1MetricResult
17386
18658
  include Google::Apis::Core::Hashable
17387
18659
 
17388
- # The explanation for the metric result.
18660
+ # The `Status` type defines a logical error model that is suitable for different
18661
+ # programming environments, including REST APIs and RPC APIs. It is used by [
18662
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
18663
+ # data: error code, error message, and error details. You can find out more
18664
+ # about this error model and how to work with it in the [API Design Guide](https:
18665
+ # //cloud.google.com/apis/design/errors).
18666
+ # Corresponds to the JSON property `error`
18667
+ # @return [Google::Apis::AiplatformV1::GoogleRpcStatus]
18668
+ attr_accessor :error
18669
+
18670
+ # Output only. The explanation for the metric result.
17389
18671
  # Corresponds to the JSON property `explanation`
17390
18672
  # @return [String]
17391
18673
  attr_accessor :explanation
17392
18674
 
17393
- # For rubric-based metrics, the verdicts for each rubric.
18675
+ # Output only. For rubric-based metrics, the verdicts for each rubric.
17394
18676
  # Corresponds to the JSON property `rubricVerdicts`
17395
18677
  # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RubricVerdict>]
17396
18678
  attr_accessor :rubric_verdicts
17397
18679
 
17398
- # The score for the metric. Please refer to each metric's documentation for the
17399
- # meaning of the score.
18680
+ # Output only. The score for the metric. Please refer to each metric's
18681
+ # documentation for the meaning of the score.
17400
18682
  # Corresponds to the JSON property `score`
17401
18683
  # @return [Float]
17402
18684
  attr_accessor :score
@@ -17407,6 +18689,7 @@ module Google
17407
18689
 
17408
18690
  # Update properties of this object
17409
18691
  def update!(**args)
18692
+ @error = args[:error] if args.key?(:error)
17410
18693
  @explanation = args[:explanation] if args.key?(:explanation)
17411
18694
  @rubric_verdicts = args[:rubric_verdicts] if args.key?(:rubric_verdicts)
17412
18695
  @score = args[:score] if args.key?(:score)
@@ -21603,6 +22886,40 @@ module Google
21603
22886
  end
21604
22887
  end
21605
22888
 
22889
+ # Defines a specification for a single output field.
22890
+ class GoogleCloudAiplatformV1OutputFieldSpec
22891
+ include Google::Apis::Core::Hashable
22892
+
22893
+ # Required. The name of the output field.
22894
+ # Corresponds to the JSON property `fieldName`
22895
+ # @return [String]
22896
+ attr_accessor :field_name
22897
+
22898
+ # Optional. The data type of the field. Defaults to CONTENT if not set.
22899
+ # Corresponds to the JSON property `fieldType`
22900
+ # @return [String]
22901
+ attr_accessor :field_type
22902
+
22903
+ # Optional. Optional, but recommended. Additional guidance specific to this
22904
+ # field to provide targeted instructions for the LLM to generate the content of
22905
+ # a single output field. While the LLM can sometimes infer content from the
22906
+ # field name, providing explicit guidance is preferred.
22907
+ # Corresponds to the JSON property `guidance`
22908
+ # @return [String]
22909
+ attr_accessor :guidance
22910
+
22911
+ def initialize(**args)
22912
+ update!(**args)
22913
+ end
22914
+
22915
+ # Update properties of this object
22916
+ def update!(**args)
22917
+ @field_name = args[:field_name] if args.key?(:field_name)
22918
+ @field_type = args[:field_type] if args.key?(:field_type)
22919
+ @guidance = args[:guidance] if args.key?(:guidance)
22920
+ end
22921
+ end
22922
+
21606
22923
  # PSC config that is used to automatically create PSC endpoints in the user
21607
22924
  # projects.
21608
22925
  class GoogleCloudAiplatformV1PscAutomationConfig
@@ -26532,6 +27849,11 @@ module Google
26532
27849
  # @return [String]
26533
27850
  attr_accessor :etag
26534
27851
 
27852
+ # Labels for the ReasoningEngine.
27853
+ # Corresponds to the JSON property `labels`
27854
+ # @return [Hash<String,String>]
27855
+ attr_accessor :labels
27856
+
26535
27857
  # Identifier. The resource name of the ReasoningEngine. Format: `projects/`
26536
27858
  # project`/locations/`location`/reasoningEngines/`reasoning_engine``
26537
27859
  # Corresponds to the JSON property `name`
@@ -26559,6 +27881,7 @@ module Google
26559
27881
  @display_name = args[:display_name] if args.key?(:display_name)
26560
27882
  @encryption_spec = args[:encryption_spec] if args.key?(:encryption_spec)
26561
27883
  @etag = args[:etag] if args.key?(:etag)
27884
+ @labels = args[:labels] if args.key?(:labels)
26562
27885
  @name = args[:name] if args.key?(:name)
26563
27886
  @spec = args[:spec] if args.key?(:spec)
26564
27887
  @update_time = args[:update_time] if args.key?(:update_time)
@@ -37495,6 +38818,37 @@ module Google
37495
38818
  end
37496
38819
  end
37497
38820
 
38821
+ # The summary metrics for the evaluation run.
38822
+ class GoogleCloudAiplatformV1SummaryMetrics
38823
+ include Google::Apis::Core::Hashable
38824
+
38825
+ # Optional. The number of items that failed to be evaluated.
38826
+ # Corresponds to the JSON property `failedItems`
38827
+ # @return [Fixnum]
38828
+ attr_accessor :failed_items
38829
+
38830
+ # Optional. Map of metric name to metric value.
38831
+ # Corresponds to the JSON property `metrics`
38832
+ # @return [Hash<String,Object>]
38833
+ attr_accessor :metrics
38834
+
38835
+ # Optional. The total number of items that were evaluated.
38836
+ # Corresponds to the JSON property `totalItems`
38837
+ # @return [Fixnum]
38838
+ attr_accessor :total_items
38839
+
38840
+ def initialize(**args)
38841
+ update!(**args)
38842
+ end
38843
+
38844
+ # Update properties of this object
38845
+ def update!(**args)
38846
+ @failed_items = args[:failed_items] if args.key?(:failed_items)
38847
+ @metrics = args[:metrics] if args.key?(:metrics)
38848
+ @total_items = args[:total_items] if args.key?(:total_items)
38849
+ end
38850
+ end
38851
+
37498
38852
  # Hyperparameters for SFT.
37499
38853
  class GoogleCloudAiplatformV1SupervisedHyperParameters
37500
38854
  include Google::Apis::Core::Hashable
@@ -37794,6 +39148,55 @@ module Google
37794
39148
  end
37795
39149
  end
37796
39150
 
39151
+ # Represents a single synthetic example, composed of multiple fields. Used for
39152
+ # providing few-shot examples in the request and for returning generated
39153
+ # examples in the response.
39154
+ class GoogleCloudAiplatformV1SyntheticExample
39155
+ include Google::Apis::Core::Hashable
39156
+
39157
+ # Required. A list of fields that constitute an example.
39158
+ # Corresponds to the JSON property `fields`
39159
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SyntheticField>]
39160
+ attr_accessor :fields
39161
+
39162
+ def initialize(**args)
39163
+ update!(**args)
39164
+ end
39165
+
39166
+ # Update properties of this object
39167
+ def update!(**args)
39168
+ @fields = args[:fields] if args.key?(:fields)
39169
+ end
39170
+ end
39171
+
39172
+ # Represents a single named field within a SyntheticExample.
39173
+ class GoogleCloudAiplatformV1SyntheticField
39174
+ include Google::Apis::Core::Hashable
39175
+
39176
+ # The base structured datatype containing multi-part content of a message. A `
39177
+ # Content` includes a `role` field designating the producer of the `Content` and
39178
+ # a `parts` field containing multi-part data that contains the content of the
39179
+ # message turn.
39180
+ # Corresponds to the JSON property `content`
39181
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content]
39182
+ attr_accessor :content
39183
+
39184
+ # Optional. The name of the field.
39185
+ # Corresponds to the JSON property `fieldName`
39186
+ # @return [String]
39187
+ attr_accessor :field_name
39188
+
39189
+ def initialize(**args)
39190
+ update!(**args)
39191
+ end
39192
+
39193
+ # Update properties of this object
39194
+ def update!(**args)
39195
+ @content = args[:content] if args.key?(:content)
39196
+ @field_name = args[:field_name] if args.key?(:field_name)
39197
+ end
39198
+ end
39199
+
37797
39200
  # The storage details for TFRecord output content.
37798
39201
  class GoogleCloudAiplatformV1TfRecordDestination
37799
39202
  include Google::Apis::Core::Hashable
@@ -37813,6 +39216,25 @@ module Google
37813
39216
  end
37814
39217
  end
37815
39218
 
39219
+ # Defines a generation strategy based on a high-level task description.
39220
+ class GoogleCloudAiplatformV1TaskDescriptionStrategy
39221
+ include Google::Apis::Core::Hashable
39222
+
39223
+ # Required. A high-level description of the synthetic data to be generated.
39224
+ # Corresponds to the JSON property `taskDescription`
39225
+ # @return [String]
39226
+ attr_accessor :task_description
39227
+
39228
+ def initialize(**args)
39229
+ update!(**args)
39230
+ end
39231
+
39232
+ # Update properties of this object
39233
+ def update!(**args)
39234
+ @task_description = args[:task_description] if args.key?(:task_description)
39235
+ end
39236
+ end
39237
+
37816
39238
  # A tensor value type.
37817
39239
  class GoogleCloudAiplatformV1Tensor
37818
39240
  include Google::Apis::Core::Hashable