google-apis-aiplatform_v1 0.9.0 → 0.10.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.
@@ -2709,6 +2709,61 @@ module Google
2709
2709
  end
2710
2710
  end
2711
2711
 
2712
+ # A response candidate generated from the model.
2713
+ class GoogleCloudAiplatformV1Candidate
2714
+ include Google::Apis::Core::Hashable
2715
+
2716
+ # A collection of source attributions for a piece of content.
2717
+ # Corresponds to the JSON property `citationMetadata`
2718
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CitationMetadata]
2719
+ attr_accessor :citation_metadata
2720
+
2721
+ # The base structured datatype containing multi-part content of a message. A `
2722
+ # Content` includes a `role` field designating the producer of the `Content` and
2723
+ # a `parts` field containing multi-part data that contains the content of the
2724
+ # message turn.
2725
+ # Corresponds to the JSON property `content`
2726
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content]
2727
+ attr_accessor :content
2728
+
2729
+ # Output only. Describes the reason the mode stopped generating tokens in more
2730
+ # detail. This is only filled when `finish_reason` is set.
2731
+ # Corresponds to the JSON property `finishMessage`
2732
+ # @return [String]
2733
+ attr_accessor :finish_message
2734
+
2735
+ # Output only. The reason why the model stopped generating tokens. If empty, the
2736
+ # model has not stopped generating the tokens.
2737
+ # Corresponds to the JSON property `finishReason`
2738
+ # @return [String]
2739
+ attr_accessor :finish_reason
2740
+
2741
+ # Output only. Index of the candidate.
2742
+ # Corresponds to the JSON property `index`
2743
+ # @return [Fixnum]
2744
+ attr_accessor :index
2745
+
2746
+ # Output only. List of ratings for the safety of a response candidate. There is
2747
+ # at most one rating per category.
2748
+ # Corresponds to the JSON property `safetyRatings`
2749
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SafetyRating>]
2750
+ attr_accessor :safety_ratings
2751
+
2752
+ def initialize(**args)
2753
+ update!(**args)
2754
+ end
2755
+
2756
+ # Update properties of this object
2757
+ def update!(**args)
2758
+ @citation_metadata = args[:citation_metadata] if args.key?(:citation_metadata)
2759
+ @content = args[:content] if args.key?(:content)
2760
+ @finish_message = args[:finish_message] if args.key?(:finish_message)
2761
+ @finish_reason = args[:finish_reason] if args.key?(:finish_reason)
2762
+ @index = args[:index] if args.key?(:index)
2763
+ @safety_ratings = args[:safety_ratings] if args.key?(:safety_ratings)
2764
+ end
2765
+ end
2766
+
2712
2767
  # This message will be placed in the metadata field of a google.longrunning.
2713
2768
  # Operation associated with a CheckTrialEarlyStoppingState request.
2714
2769
  class GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateMetatdata
@@ -2774,6 +2829,81 @@ module Google
2774
2829
  end
2775
2830
  end
2776
2831
 
2832
+ # Source attributions for content.
2833
+ class GoogleCloudAiplatformV1Citation
2834
+ include Google::Apis::Core::Hashable
2835
+
2836
+ # Output only. End index into the content.
2837
+ # Corresponds to the JSON property `endIndex`
2838
+ # @return [Fixnum]
2839
+ attr_accessor :end_index
2840
+
2841
+ # Output only. License of the attribution.
2842
+ # Corresponds to the JSON property `license`
2843
+ # @return [String]
2844
+ attr_accessor :license
2845
+
2846
+ # Represents a whole or partial calendar date, such as a birthday. The time of
2847
+ # day and time zone are either specified elsewhere or are insignificant. The
2848
+ # date is relative to the Gregorian Calendar. This can represent one of the
2849
+ # following: * A full date, with non-zero year, month, and day values. * A month
2850
+ # and day, with a zero year (for example, an anniversary). * A year on its own,
2851
+ # with a zero month and a zero day. * A year and month, with a zero day (for
2852
+ # example, a credit card expiration date). Related types: * google.type.
2853
+ # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
2854
+ # Corresponds to the JSON property `publicationDate`
2855
+ # @return [Google::Apis::AiplatformV1::GoogleTypeDate]
2856
+ attr_accessor :publication_date
2857
+
2858
+ # Output only. Start index into the content.
2859
+ # Corresponds to the JSON property `startIndex`
2860
+ # @return [Fixnum]
2861
+ attr_accessor :start_index
2862
+
2863
+ # Output only. Title of the attribution.
2864
+ # Corresponds to the JSON property `title`
2865
+ # @return [String]
2866
+ attr_accessor :title
2867
+
2868
+ # Output only. Url reference of the attribution.
2869
+ # Corresponds to the JSON property `uri`
2870
+ # @return [String]
2871
+ attr_accessor :uri
2872
+
2873
+ def initialize(**args)
2874
+ update!(**args)
2875
+ end
2876
+
2877
+ # Update properties of this object
2878
+ def update!(**args)
2879
+ @end_index = args[:end_index] if args.key?(:end_index)
2880
+ @license = args[:license] if args.key?(:license)
2881
+ @publication_date = args[:publication_date] if args.key?(:publication_date)
2882
+ @start_index = args[:start_index] if args.key?(:start_index)
2883
+ @title = args[:title] if args.key?(:title)
2884
+ @uri = args[:uri] if args.key?(:uri)
2885
+ end
2886
+ end
2887
+
2888
+ # A collection of source attributions for a piece of content.
2889
+ class GoogleCloudAiplatformV1CitationMetadata
2890
+ include Google::Apis::Core::Hashable
2891
+
2892
+ # Output only. List of citations.
2893
+ # Corresponds to the JSON property `citations`
2894
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Citation>]
2895
+ attr_accessor :citations
2896
+
2897
+ def initialize(**args)
2898
+ update!(**args)
2899
+ end
2900
+
2901
+ # Update properties of this object
2902
+ def update!(**args)
2903
+ @citations = args[:citations] if args.key?(:citations)
2904
+ end
2905
+ end
2906
+
2777
2907
  # Request message for VizierService.CompleteTrial.
2778
2908
  class GoogleCloudAiplatformV1CompleteTrialRequest
2779
2909
  include Google::Apis::Core::Hashable
@@ -6893,8 +7023,8 @@ module Google
6893
7023
  attr_accessor :data_stats
6894
7024
 
6895
7025
  # All of the files that are exported in this export operation. For custom code
6896
- # training export, only three (training, validation and test) GCS paths in
6897
- # wildcard format are populated (e.g., gs://.../training-*).
7026
+ # training export, only three (training, validation and test) Cloud Storage
7027
+ # paths in wildcard format are populated (for example, gs://.../training-*).
6898
7028
  # Corresponds to the JSON property `exportedFiles`
6899
7029
  # @return [Array<String>]
6900
7030
  attr_accessor :exported_files
@@ -7390,7 +7520,7 @@ module Google
7390
7520
  attr_accessor :value_type
7391
7521
 
7392
7522
  # Only applicable for Vertex AI Feature Store. The name of the BigQuery Table/
7393
- # View columnn hosting data for this version. If no value is provided, will use
7523
+ # View column hosting data for this version. If no value is provided, will use
7394
7524
  # feature_id.
7395
7525
  # Corresponds to the JSON property `versionColumnName`
7396
7526
  # @return [String]
@@ -8861,6 +8991,103 @@ module Google
8861
8991
  end
8862
8992
  end
8863
8993
 
8994
+ # A predicted [FunctionCall] returned from the model that contains a string
8995
+ # representing the [FunctionDeclaration.name] and a structured JSON object
8996
+ # containing the parameters and their values.
8997
+ class GoogleCloudAiplatformV1FunctionCall
8998
+ include Google::Apis::Core::Hashable
8999
+
9000
+ # Optional. Required. The function parameters and values in JSON object format.
9001
+ # See [FunctionDeclaration.parameters] for parameter details.
9002
+ # Corresponds to the JSON property `args`
9003
+ # @return [Hash<String,Object>]
9004
+ attr_accessor :args
9005
+
9006
+ # Required. The name of the function to call. Matches [FunctionDeclaration.name].
9007
+ # Corresponds to the JSON property `name`
9008
+ # @return [String]
9009
+ attr_accessor :name
9010
+
9011
+ def initialize(**args)
9012
+ update!(**args)
9013
+ end
9014
+
9015
+ # Update properties of this object
9016
+ def update!(**args)
9017
+ @args = args[:args] if args.key?(:args)
9018
+ @name = args[:name] if args.key?(:name)
9019
+ end
9020
+ end
9021
+
9022
+ # Structured representation of a function declaration as defined by the [OpenAPI
9023
+ # 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this
9024
+ # declaration are the function name and parameters. This FunctionDeclaration is
9025
+ # a representation of a block of code that can be used as a `Tool` by the model
9026
+ # and executed by the client.
9027
+ class GoogleCloudAiplatformV1FunctionDeclaration
9028
+ include Google::Apis::Core::Hashable
9029
+
9030
+ # Optional. Description and purpose of the function. Model uses it to decide how
9031
+ # and whether to call the function.
9032
+ # Corresponds to the JSON property `description`
9033
+ # @return [String]
9034
+ attr_accessor :description
9035
+
9036
+ # Required. The name of the function to call. Must start with a letter or an
9037
+ # underscore. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a
9038
+ # maximum length of 64.
9039
+ # Corresponds to the JSON property `name`
9040
+ # @return [String]
9041
+ attr_accessor :name
9042
+
9043
+ # Schema is used to define the format of input/output data. Represents a select
9044
+ # subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#
9045
+ # schema). More fields may be added in the future as needed.
9046
+ # Corresponds to the JSON property `parameters`
9047
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schema]
9048
+ attr_accessor :parameters
9049
+
9050
+ def initialize(**args)
9051
+ update!(**args)
9052
+ end
9053
+
9054
+ # Update properties of this object
9055
+ def update!(**args)
9056
+ @description = args[:description] if args.key?(:description)
9057
+ @name = args[:name] if args.key?(:name)
9058
+ @parameters = args[:parameters] if args.key?(:parameters)
9059
+ end
9060
+ end
9061
+
9062
+ # The result output from a [FunctionCall] that contains a string representing
9063
+ # the [FunctionDeclaration.name] and a structured JSON object containing any
9064
+ # output from the function is used as context to the model. This should contain
9065
+ # the result of a [FunctionCall] made based on model prediction.
9066
+ class GoogleCloudAiplatformV1FunctionResponse
9067
+ include Google::Apis::Core::Hashable
9068
+
9069
+ # Required. The name of the function to call. Matches [FunctionDeclaration.name]
9070
+ # and [FunctionCall.name].
9071
+ # Corresponds to the JSON property `name`
9072
+ # @return [String]
9073
+ attr_accessor :name
9074
+
9075
+ # Required. The function response in JSON object format.
9076
+ # Corresponds to the JSON property `response`
9077
+ # @return [Hash<String,Object>]
9078
+ attr_accessor :response
9079
+
9080
+ def initialize(**args)
9081
+ update!(**args)
9082
+ end
9083
+
9084
+ # Update properties of this object
9085
+ def update!(**args)
9086
+ @name = args[:name] if args.key?(:name)
9087
+ @response = args[:response] if args.key?(:response)
9088
+ end
9089
+ end
9090
+
8864
9091
  # The Google Cloud Storage location where the output is to be written to.
8865
9092
  class GoogleCloudAiplatformV1GcsDestination
8866
9093
  include Google::Apis::Core::Hashable
@@ -8903,6 +9130,198 @@ module Google
8903
9130
  end
8904
9131
  end
8905
9132
 
9133
+ # Request message for [PredictionService.GenerateContent].
9134
+ class GoogleCloudAiplatformV1GenerateContentRequest
9135
+ include Google::Apis::Core::Hashable
9136
+
9137
+ # Required. The content of the current conversation with the model. For single-
9138
+ # turn queries, this is a single instance. For multi-turn queries, this is a
9139
+ # repeated field that contains conversation history + latest request.
9140
+ # Corresponds to the JSON property `contents`
9141
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content>]
9142
+ attr_accessor :contents
9143
+
9144
+ # Required. The name of the Endpoint requested to serve the prediction. Format: `
9145
+ # projects/`project`/locations/`location`/endpoints/`endpoint``
9146
+ # Corresponds to the JSON property `endpoint`
9147
+ # @return [String]
9148
+ attr_accessor :endpoint
9149
+
9150
+ # Generation config.
9151
+ # Corresponds to the JSON property `generationConfig`
9152
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerationConfig]
9153
+ attr_accessor :generation_config
9154
+
9155
+ # Optional. Per request settings for blocking unsafe content. Enforced on
9156
+ # GenerateContentResponse.candidates.
9157
+ # Corresponds to the JSON property `safetySettings`
9158
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SafetySetting>]
9159
+ attr_accessor :safety_settings
9160
+
9161
+ # Optional. A list of `Tools` the model may use to generate the next response. A
9162
+ # `Tool` is a piece of code that enables the system to interact with external
9163
+ # systems to perform an action, or set of actions, outside of knowledge and
9164
+ # scope of the model. The only supported tool is currently `Function`
9165
+ # Corresponds to the JSON property `tools`
9166
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Tool>]
9167
+ attr_accessor :tools
9168
+
9169
+ def initialize(**args)
9170
+ update!(**args)
9171
+ end
9172
+
9173
+ # Update properties of this object
9174
+ def update!(**args)
9175
+ @contents = args[:contents] if args.key?(:contents)
9176
+ @endpoint = args[:endpoint] if args.key?(:endpoint)
9177
+ @generation_config = args[:generation_config] if args.key?(:generation_config)
9178
+ @safety_settings = args[:safety_settings] if args.key?(:safety_settings)
9179
+ @tools = args[:tools] if args.key?(:tools)
9180
+ end
9181
+ end
9182
+
9183
+ # Response message for [PredictionService.GenerateContent].
9184
+ class GoogleCloudAiplatformV1GenerateContentResponse
9185
+ include Google::Apis::Core::Hashable
9186
+
9187
+ # Output only. Generated candidates.
9188
+ # Corresponds to the JSON property `candidates`
9189
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Candidate>]
9190
+ attr_accessor :candidates
9191
+
9192
+ # Content filter results for a prompt sent in the request.
9193
+ # Corresponds to the JSON property `promptFeedback`
9194
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback]
9195
+ attr_accessor :prompt_feedback
9196
+
9197
+ # Usage metadata about response(s).
9198
+ # Corresponds to the JSON property `usageMetadata`
9199
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata]
9200
+ attr_accessor :usage_metadata
9201
+
9202
+ def initialize(**args)
9203
+ update!(**args)
9204
+ end
9205
+
9206
+ # Update properties of this object
9207
+ def update!(**args)
9208
+ @candidates = args[:candidates] if args.key?(:candidates)
9209
+ @prompt_feedback = args[:prompt_feedback] if args.key?(:prompt_feedback)
9210
+ @usage_metadata = args[:usage_metadata] if args.key?(:usage_metadata)
9211
+ end
9212
+ end
9213
+
9214
+ # Content filter results for a prompt sent in the request.
9215
+ class GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback
9216
+ include Google::Apis::Core::Hashable
9217
+
9218
+ # Output only. Blocked reason.
9219
+ # Corresponds to the JSON property `blockReason`
9220
+ # @return [String]
9221
+ attr_accessor :block_reason
9222
+
9223
+ # Output only. A readable block reason message.
9224
+ # Corresponds to the JSON property `blockReasonMessage`
9225
+ # @return [String]
9226
+ attr_accessor :block_reason_message
9227
+
9228
+ # Output only. Safety ratings.
9229
+ # Corresponds to the JSON property `safetyRatings`
9230
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SafetyRating>]
9231
+ attr_accessor :safety_ratings
9232
+
9233
+ def initialize(**args)
9234
+ update!(**args)
9235
+ end
9236
+
9237
+ # Update properties of this object
9238
+ def update!(**args)
9239
+ @block_reason = args[:block_reason] if args.key?(:block_reason)
9240
+ @block_reason_message = args[:block_reason_message] if args.key?(:block_reason_message)
9241
+ @safety_ratings = args[:safety_ratings] if args.key?(:safety_ratings)
9242
+ end
9243
+ end
9244
+
9245
+ # Usage metadata about response(s).
9246
+ class GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata
9247
+ include Google::Apis::Core::Hashable
9248
+
9249
+ # Number of tokens in the response(s).
9250
+ # Corresponds to the JSON property `candidatesTokenCount`
9251
+ # @return [Fixnum]
9252
+ attr_accessor :candidates_token_count
9253
+
9254
+ # Number of tokens in the request.
9255
+ # Corresponds to the JSON property `promptTokenCount`
9256
+ # @return [Fixnum]
9257
+ attr_accessor :prompt_token_count
9258
+
9259
+ #
9260
+ # Corresponds to the JSON property `totalTokenCount`
9261
+ # @return [Fixnum]
9262
+ attr_accessor :total_token_count
9263
+
9264
+ def initialize(**args)
9265
+ update!(**args)
9266
+ end
9267
+
9268
+ # Update properties of this object
9269
+ def update!(**args)
9270
+ @candidates_token_count = args[:candidates_token_count] if args.key?(:candidates_token_count)
9271
+ @prompt_token_count = args[:prompt_token_count] if args.key?(:prompt_token_count)
9272
+ @total_token_count = args[:total_token_count] if args.key?(:total_token_count)
9273
+ end
9274
+ end
9275
+
9276
+ # Generation config.
9277
+ class GoogleCloudAiplatformV1GenerationConfig
9278
+ include Google::Apis::Core::Hashable
9279
+
9280
+ # Optional. Number of candidates to generate.
9281
+ # Corresponds to the JSON property `candidateCount`
9282
+ # @return [Fixnum]
9283
+ attr_accessor :candidate_count
9284
+
9285
+ # Optional. The maximum number of output tokens to generate per message.
9286
+ # Corresponds to the JSON property `maxOutputTokens`
9287
+ # @return [Fixnum]
9288
+ attr_accessor :max_output_tokens
9289
+
9290
+ # Optional. Stop sequences.
9291
+ # Corresponds to the JSON property `stopSequences`
9292
+ # @return [Array<String>]
9293
+ attr_accessor :stop_sequences
9294
+
9295
+ # Optional. Controls the randomness of predictions.
9296
+ # Corresponds to the JSON property `temperature`
9297
+ # @return [Float]
9298
+ attr_accessor :temperature
9299
+
9300
+ # Optional. If specified, top-k sampling will be used.
9301
+ # Corresponds to the JSON property `topK`
9302
+ # @return [Float]
9303
+ attr_accessor :top_k
9304
+
9305
+ # Optional. If specified, nucleus sampling will be used.
9306
+ # Corresponds to the JSON property `topP`
9307
+ # @return [Float]
9308
+ attr_accessor :top_p
9309
+
9310
+ def initialize(**args)
9311
+ update!(**args)
9312
+ end
9313
+
9314
+ # Update properties of this object
9315
+ def update!(**args)
9316
+ @candidate_count = args[:candidate_count] if args.key?(:candidate_count)
9317
+ @max_output_tokens = args[:max_output_tokens] if args.key?(:max_output_tokens)
9318
+ @stop_sequences = args[:stop_sequences] if args.key?(:stop_sequences)
9319
+ @temperature = args[:temperature] if args.key?(:temperature)
9320
+ @top_k = args[:top_k] if args.key?(:top_k)
9321
+ @top_p = args[:top_p] if args.key?(:top_p)
9322
+ end
9323
+ end
9324
+
8906
9325
  # Generic Metadata shared by all operations.
8907
9326
  class GoogleCloudAiplatformV1GenericOperationMetadata
8908
9327
  include Google::Apis::Core::Hashable
@@ -12896,7 +13315,8 @@ module Google
12896
13315
 
12897
13316
  # The metadata of the ModelEvaluation. For the ModelEvaluation uploaded from
12898
13317
  # Managed Pipeline, metadata contains a structured value with keys of "
12899
- # pipeline_job_id", "evaluation_dataset_type", "evaluation_dataset_path".
13318
+ # pipeline_job_id", "evaluation_dataset_type", "evaluation_dataset_path", "
13319
+ # row_based_metrics_path".
12900
13320
  # Corresponds to the JSON property `metadata`
12901
13321
  # @return [Object]
12902
13322
  attr_accessor :metadata
@@ -14442,6 +14862,42 @@ module Google
14442
14862
  end
14443
14863
  end
14444
14864
 
14865
+ # Notebook Reservation Affinity for consuming Zonal reservation.
14866
+ class GoogleCloudAiplatformV1NotebookReservationAffinity
14867
+ include Google::Apis::Core::Hashable
14868
+
14869
+ # Required. Specifies the type of reservation from which this instance can
14870
+ # consume resources: RESERVATION_ANY (default), RESERVATION_SPECIFIC, or
14871
+ # RESERVATION_NONE. See Consuming reserved instances for examples.
14872
+ # Corresponds to the JSON property `consumeReservationType`
14873
+ # @return [String]
14874
+ attr_accessor :consume_reservation_type
14875
+
14876
+ # Optional. Corresponds to the label key of a reservation resource. To target a
14877
+ # RESERVATION_SPECIFIC by name, use compute.googleapis.com/reservation-name as
14878
+ # the key and specify the name of your reservation as its value.
14879
+ # Corresponds to the JSON property `key`
14880
+ # @return [String]
14881
+ attr_accessor :key
14882
+
14883
+ # Optional. Corresponds to the label values of a reservation resource. This must
14884
+ # be the full path name of Reservation.
14885
+ # Corresponds to the JSON property `values`
14886
+ # @return [Array<String>]
14887
+ attr_accessor :values
14888
+
14889
+ def initialize(**args)
14890
+ update!(**args)
14891
+ end
14892
+
14893
+ # Update properties of this object
14894
+ def update!(**args)
14895
+ @consume_reservation_type = args[:consume_reservation_type] if args.key?(:consume_reservation_type)
14896
+ @key = args[:key] if args.key?(:key)
14897
+ @values = args[:values] if args.key?(:values)
14898
+ end
14899
+ end
14900
+
14445
14901
  # A runtime is a virtual machine allocated to a particular user for a particular
14446
14902
  # Notebook file on temporary basis with lifetime limited to 24 hours.
14447
14903
  class GoogleCloudAiplatformV1NotebookRuntime
@@ -14477,6 +14933,12 @@ module Google
14477
14933
  # @return [String]
14478
14934
  attr_accessor :health_state
14479
14935
 
14936
+ # Output only. Whether NotebookRuntime is upgradable.
14937
+ # Corresponds to the JSON property `isUpgradable`
14938
+ # @return [Boolean]
14939
+ attr_accessor :is_upgradable
14940
+ alias_method :is_upgradable?, :is_upgradable
14941
+
14480
14942
  # The labels with user-defined metadata to organize your NotebookRuntime. Label
14481
14943
  # keys and values can be no longer than 64 characters (Unicode codepoints), can
14482
14944
  # only contain lowercase letters, numeric characters, underscores and dashes.
@@ -14499,6 +14961,12 @@ module Google
14499
14961
  # @return [String]
14500
14962
  attr_accessor :name
14501
14963
 
14964
+ # Optional. The Compute Engine tags to add to runtime (see [Tagging instances](
14965
+ # https://cloud.google.com/vpc/docs/add-remove-network-tags)).
14966
+ # Corresponds to the JSON property `networkTags`
14967
+ # @return [Array<String>]
14968
+ attr_accessor :network_tags
14969
+
14502
14970
  # Points to a NotebookRuntimeTemplateRef.
14503
14971
  # Corresponds to the JSON property `notebookRuntimeTemplateRef`
14504
14972
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookRuntimeTemplateRef]
@@ -14514,6 +14982,11 @@ module Google
14514
14982
  # @return [String]
14515
14983
  attr_accessor :proxy_uri
14516
14984
 
14985
+ # Notebook Reservation Affinity for consuming Zonal reservation.
14986
+ # Corresponds to the JSON property `reservationAffinity`
14987
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookReservationAffinity]
14988
+ attr_accessor :reservation_affinity
14989
+
14517
14990
  # Output only. The runtime (instance) state of the NotebookRuntime.
14518
14991
  # Corresponds to the JSON property `runtimeState`
14519
14992
  # @return [String]
@@ -14550,11 +15023,14 @@ module Google
14550
15023
  @display_name = args[:display_name] if args.key?(:display_name)
14551
15024
  @expiration_time = args[:expiration_time] if args.key?(:expiration_time)
14552
15025
  @health_state = args[:health_state] if args.key?(:health_state)
15026
+ @is_upgradable = args[:is_upgradable] if args.key?(:is_upgradable)
14553
15027
  @labels = args[:labels] if args.key?(:labels)
14554
15028
  @name = args[:name] if args.key?(:name)
15029
+ @network_tags = args[:network_tags] if args.key?(:network_tags)
14555
15030
  @notebook_runtime_template_ref = args[:notebook_runtime_template_ref] if args.key?(:notebook_runtime_template_ref)
14556
15031
  @notebook_runtime_type = args[:notebook_runtime_type] if args.key?(:notebook_runtime_type)
14557
15032
  @proxy_uri = args[:proxy_uri] if args.key?(:proxy_uri)
15033
+ @reservation_affinity = args[:reservation_affinity] if args.key?(:reservation_affinity)
14558
15034
  @runtime_state = args[:runtime_state] if args.key?(:runtime_state)
14559
15035
  @runtime_user = args[:runtime_user] if args.key?(:runtime_user)
14560
15036
  @service_account = args[:service_account] if args.key?(:service_account)
@@ -14637,11 +15113,22 @@ module Google
14637
15113
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NetworkSpec]
14638
15114
  attr_accessor :network_spec
14639
15115
 
15116
+ # Optional. The Compute Engine tags to add to runtime (see [Tagging instances](
15117
+ # https://cloud.google.com/vpc/docs/add-remove-network-tags)).
15118
+ # Corresponds to the JSON property `networkTags`
15119
+ # @return [Array<String>]
15120
+ attr_accessor :network_tags
15121
+
14640
15122
  # Optional. Immutable. The type of the notebook runtime template.
14641
15123
  # Corresponds to the JSON property `notebookRuntimeType`
14642
15124
  # @return [String]
14643
15125
  attr_accessor :notebook_runtime_type
14644
15126
 
15127
+ # Notebook Reservation Affinity for consuming Zonal reservation.
15128
+ # Corresponds to the JSON property `reservationAffinity`
15129
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookReservationAffinity]
15130
+ attr_accessor :reservation_affinity
15131
+
14645
15132
  # The service account that the runtime workload runs as. You can use any service
14646
15133
  # account within the same project, but you must have the service account user
14647
15134
  # permission to use the instance. If not specified, the [Compute Engine default
@@ -14651,6 +15138,13 @@ module Google
14651
15138
  # @return [String]
14652
15139
  attr_accessor :service_account
14653
15140
 
15141
+ # A set of Shielded Instance options. See [Images using supported Shielded VM
15142
+ # features](https://cloud.google.com/compute/docs/instances/modifying-shielded-
15143
+ # vm).
15144
+ # Corresponds to the JSON property `shieldedVmConfig`
15145
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ShieldedVmConfig]
15146
+ attr_accessor :shielded_vm_config
15147
+
14654
15148
  # Output only. Timestamp when this NotebookRuntimeTemplate was most recently
14655
15149
  # updated.
14656
15150
  # Corresponds to the JSON property `updateTime`
@@ -14675,8 +15169,11 @@ module Google
14675
15169
  @machine_spec = args[:machine_spec] if args.key?(:machine_spec)
14676
15170
  @name = args[:name] if args.key?(:name)
14677
15171
  @network_spec = args[:network_spec] if args.key?(:network_spec)
15172
+ @network_tags = args[:network_tags] if args.key?(:network_tags)
14678
15173
  @notebook_runtime_type = args[:notebook_runtime_type] if args.key?(:notebook_runtime_type)
15174
+ @reservation_affinity = args[:reservation_affinity] if args.key?(:reservation_affinity)
14679
15175
  @service_account = args[:service_account] if args.key?(:service_account)
15176
+ @shielded_vm_config = args[:shielded_vm_config] if args.key?(:shielded_vm_config)
14680
15177
  @update_time = args[:update_time] if args.key?(:update_time)
14681
15178
  end
14682
15179
  end
@@ -14713,6 +15210,21 @@ module Google
14713
15210
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FileData]
14714
15211
  attr_accessor :file_data
14715
15212
 
15213
+ # A predicted [FunctionCall] returned from the model that contains a string
15214
+ # representing the [FunctionDeclaration.name] and a structured JSON object
15215
+ # containing the parameters and their values.
15216
+ # Corresponds to the JSON property `functionCall`
15217
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FunctionCall]
15218
+ attr_accessor :function_call
15219
+
15220
+ # The result output from a [FunctionCall] that contains a string representing
15221
+ # the [FunctionDeclaration.name] and a structured JSON object containing any
15222
+ # output from the function is used as context to the model. This should contain
15223
+ # the result of a [FunctionCall] made based on model prediction.
15224
+ # Corresponds to the JSON property `functionResponse`
15225
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FunctionResponse]
15226
+ attr_accessor :function_response
15227
+
14716
15228
  # Raw media bytes. Text should not be sent as raw bytes, use the 'text' field.
14717
15229
  # Corresponds to the JSON property `inlineData`
14718
15230
  # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Blob]
@@ -14735,6 +15247,8 @@ module Google
14735
15247
  # Update properties of this object
14736
15248
  def update!(**args)
14737
15249
  @file_data = args[:file_data] if args.key?(:file_data)
15250
+ @function_call = args[:function_call] if args.key?(:function_call)
15251
+ @function_response = args[:function_response] if args.key?(:function_response)
14738
15252
  @inline_data = args[:inline_data] if args.key?(:inline_data)
14739
15253
  @text = args[:text] if args.key?(:text)
14740
15254
  @video_metadata = args[:video_metadata] if args.key?(:video_metadata)
@@ -16878,6 +17392,64 @@ module Google
16878
17392
  end
16879
17393
  end
16880
17394
 
17395
+ # Safety rating corresponding to the generated content.
17396
+ class GoogleCloudAiplatformV1SafetyRating
17397
+ include Google::Apis::Core::Hashable
17398
+
17399
+ # Output only. Indicates whether the content was filtered out because of this
17400
+ # rating.
17401
+ # Corresponds to the JSON property `blocked`
17402
+ # @return [Boolean]
17403
+ attr_accessor :blocked
17404
+ alias_method :blocked?, :blocked
17405
+
17406
+ # Output only. Harm category.
17407
+ # Corresponds to the JSON property `category`
17408
+ # @return [String]
17409
+ attr_accessor :category
17410
+
17411
+ # Output only. Harm probability levels in the content.
17412
+ # Corresponds to the JSON property `probability`
17413
+ # @return [String]
17414
+ attr_accessor :probability
17415
+
17416
+ def initialize(**args)
17417
+ update!(**args)
17418
+ end
17419
+
17420
+ # Update properties of this object
17421
+ def update!(**args)
17422
+ @blocked = args[:blocked] if args.key?(:blocked)
17423
+ @category = args[:category] if args.key?(:category)
17424
+ @probability = args[:probability] if args.key?(:probability)
17425
+ end
17426
+ end
17427
+
17428
+ # Safety settings.
17429
+ class GoogleCloudAiplatformV1SafetySetting
17430
+ include Google::Apis::Core::Hashable
17431
+
17432
+ # Required. Harm category.
17433
+ # Corresponds to the JSON property `category`
17434
+ # @return [String]
17435
+ attr_accessor :category
17436
+
17437
+ # Required. The harm block threshold.
17438
+ # Corresponds to the JSON property `threshold`
17439
+ # @return [String]
17440
+ attr_accessor :threshold
17441
+
17442
+ def initialize(**args)
17443
+ update!(**args)
17444
+ end
17445
+
17446
+ # Update properties of this object
17447
+ def update!(**args)
17448
+ @category = args[:category] if args.key?(:category)
17449
+ @threshold = args[:threshold] if args.key?(:threshold)
17450
+ end
17451
+ end
17452
+
16881
17453
  # Active learning data sampling config. For every active learning labeling
16882
17454
  # iteration, it will select a batch of data based on the sampling strategy.
16883
17455
  class GoogleCloudAiplatformV1SampleConfig
@@ -17257,6 +17829,12 @@ module Google
17257
17829
  attr_accessor :disable_retries
17258
17830
  alias_method :disable_retries?, :disable_retries
17259
17831
 
17832
+ # Optional. This is the maximum time a user will wait in the QRM queue for
17833
+ # resources. Default is 1 day
17834
+ # Corresponds to the JSON property `maxWaitDuration`
17835
+ # @return [String]
17836
+ attr_accessor :max_wait_duration
17837
+
17260
17838
  # Restarts the entire CustomJob if a worker gets restarted. This feature can be
17261
17839
  # used by distributed training jobs that are not resilient to workers leaving
17262
17840
  # and joining a job.
@@ -17277,11 +17855,88 @@ module Google
17277
17855
  # Update properties of this object
17278
17856
  def update!(**args)
17279
17857
  @disable_retries = args[:disable_retries] if args.key?(:disable_retries)
17858
+ @max_wait_duration = args[:max_wait_duration] if args.key?(:max_wait_duration)
17280
17859
  @restart_job_on_worker_restart = args[:restart_job_on_worker_restart] if args.key?(:restart_job_on_worker_restart)
17281
17860
  @timeout = args[:timeout] if args.key?(:timeout)
17282
17861
  end
17283
17862
  end
17284
17863
 
17864
+ # Schema is used to define the format of input/output data. Represents a select
17865
+ # subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#
17866
+ # schema). More fields may be added in the future as needed.
17867
+ class GoogleCloudAiplatformV1Schema
17868
+ include Google::Apis::Core::Hashable
17869
+
17870
+ # Optional. The description of the data.
17871
+ # Corresponds to the JSON property `description`
17872
+ # @return [String]
17873
+ attr_accessor :description
17874
+
17875
+ # Optional. Possible values of the element of Type.STRING with enum format. For
17876
+ # example we can define an Enum Direction as : `type:STRING, format:enum, enum:["
17877
+ # EAST", NORTH", "SOUTH", "WEST"]`
17878
+ # Corresponds to the JSON property `enum`
17879
+ # @return [Array<String>]
17880
+ attr_accessor :enum
17881
+
17882
+ # Optional. Example of the object. Will only populated when the object is the
17883
+ # root.
17884
+ # Corresponds to the JSON property `example`
17885
+ # @return [Object]
17886
+ attr_accessor :example
17887
+
17888
+ # Optional. The format of the data. Supported formats: for NUMBER type: float,
17889
+ # double for INTEGER type: int32, int64
17890
+ # Corresponds to the JSON property `format`
17891
+ # @return [String]
17892
+ attr_accessor :format
17893
+
17894
+ # Schema is used to define the format of input/output data. Represents a select
17895
+ # subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#
17896
+ # schema). More fields may be added in the future as needed.
17897
+ # Corresponds to the JSON property `items`
17898
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schema]
17899
+ attr_accessor :items
17900
+
17901
+ # Optional. Indicates if the value may be null.
17902
+ # Corresponds to the JSON property `nullable`
17903
+ # @return [Boolean]
17904
+ attr_accessor :nullable
17905
+ alias_method :nullable?, :nullable
17906
+
17907
+ # Optional. Properties of Type.OBJECT.
17908
+ # Corresponds to the JSON property `properties`
17909
+ # @return [Hash<String,Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schema>]
17910
+ attr_accessor :properties
17911
+
17912
+ # Optional. Required properties of Type.OBJECT.
17913
+ # Corresponds to the JSON property `required`
17914
+ # @return [Array<String>]
17915
+ attr_accessor :required
17916
+
17917
+ # Optional. The type of the data.
17918
+ # Corresponds to the JSON property `type`
17919
+ # @return [String]
17920
+ attr_accessor :type
17921
+
17922
+ def initialize(**args)
17923
+ update!(**args)
17924
+ end
17925
+
17926
+ # Update properties of this object
17927
+ def update!(**args)
17928
+ @description = args[:description] if args.key?(:description)
17929
+ @enum = args[:enum] if args.key?(:enum)
17930
+ @example = args[:example] if args.key?(:example)
17931
+ @format = args[:format] if args.key?(:format)
17932
+ @items = args[:items] if args.key?(:items)
17933
+ @nullable = args[:nullable] if args.key?(:nullable)
17934
+ @properties = args[:properties] if args.key?(:properties)
17935
+ @required = args[:required] if args.key?(:required)
17936
+ @type = args[:type] if args.key?(:type)
17937
+ end
17938
+ end
17939
+
17285
17940
  # An entry of mapping between color and AnnotationSpec. The mapping is used in
17286
17941
  # segmentation mask.
17287
17942
  class GoogleCloudAiplatformV1SchemaAnnotationSpecColor
@@ -23541,6 +24196,32 @@ module Google
23541
24196
  end
23542
24197
  end
23543
24198
 
24199
+ # A set of Shielded Instance options. See [Images using supported Shielded VM
24200
+ # features](https://cloud.google.com/compute/docs/instances/modifying-shielded-
24201
+ # vm).
24202
+ class GoogleCloudAiplatformV1ShieldedVmConfig
24203
+ include Google::Apis::Core::Hashable
24204
+
24205
+ # Defines whether the instance has [Secure Boot](https://cloud.google.com/
24206
+ # compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps
24207
+ # ensure that the system only runs authentic software by verifying the digital
24208
+ # signature of all boot components, and halting the boot process if signature
24209
+ # verification fails.
24210
+ # Corresponds to the JSON property `enableSecureBoot`
24211
+ # @return [Boolean]
24212
+ attr_accessor :enable_secure_boot
24213
+ alias_method :enable_secure_boot?, :enable_secure_boot
24214
+
24215
+ def initialize(**args)
24216
+ update!(**args)
24217
+ end
24218
+
24219
+ # Update properties of this object
24220
+ def update!(**args)
24221
+ @enable_secure_boot = args[:enable_secure_boot] if args.key?(:enable_secure_boot)
24222
+ end
24223
+ end
24224
+
23544
24225
  # Config for SmoothGrad approximation of gradients. When enabled, the gradients
23545
24226
  # are approximated by averaging the gradients from noisy samples in the vicinity
23546
24227
  # of the inputs. Adding noise can help improve the computed gradients. Refer to
@@ -25421,6 +26102,32 @@ module Google
25421
26102
  end
25422
26103
  end
25423
26104
 
26105
+ # Tool details that the model may use to generate response. A `Tool` is a piece
26106
+ # of code that enables the system to interact with external systems to perform
26107
+ # an action, or set of actions, outside of knowledge and scope of the model.
26108
+ class GoogleCloudAiplatformV1Tool
26109
+ include Google::Apis::Core::Hashable
26110
+
26111
+ # Optional. One or more function declarations to be passed to the model along
26112
+ # with the current user query. Model may decide to call a subset of these
26113
+ # functions by populating FunctionCall in the response. User should provide a
26114
+ # FunctionResponse for each function call in the next turn. Based on the
26115
+ # function responses, Model will generate the final response back to the user.
26116
+ # Maximum 64 function declarations can be provided.
26117
+ # Corresponds to the JSON property `functionDeclarations`
26118
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FunctionDeclaration>]
26119
+ attr_accessor :function_declarations
26120
+
26121
+ def initialize(**args)
26122
+ update!(**args)
26123
+ end
26124
+
26125
+ # Update properties of this object
26126
+ def update!(**args)
26127
+ @function_declarations = args[:function_declarations] if args.key?(:function_declarations)
26128
+ end
26129
+ end
26130
+
25424
26131
  # CMLE training config. For every active learning labeling iteration, system
25425
26132
  # will train a machine learning model on CMLE. The trained model will be used by
25426
26133
  # data sampling algorithm to select DataItems.
@@ -26759,21 +27466,43 @@ module Google
26759
27466
  # project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:`emailid``: An
26760
27467
  # email address that represents a Google group. For example, `admins@example.com`
26761
27468
  # . * `domain:`domain``: The G Suite domain (primary) that represents all the
26762
- # users of that domain. For example, `google.com` or `example.com`. * `deleted:
26763
- # user:`emailid`?uid=`uniqueid``: An email address (plus unique identifier)
26764
- # representing a user that has been recently deleted. For example, `alice@
26765
- # example.com?uid=123456789012345678901`. If the user is recovered, this value
26766
- # reverts to `user:`emailid`` and the recovered user retains the role in the
26767
- # binding. * `deleted:serviceAccount:`emailid`?uid=`uniqueid``: An email address
26768
- # (plus unique identifier) representing a service account that has been recently
26769
- # deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=
27469
+ # users of that domain. For example, `google.com` or `example.com`. * `principal:
27470
+ # //iam.googleapis.com/locations/global/workforcePools/`pool_id`/subject/`
27471
+ # subject_attribute_value``: A single identity in a workforce identity pool. * `
27472
+ # principalSet://iam.googleapis.com/locations/global/workforcePools/`pool_id`/
27473
+ # group/`group_id``: All workforce identities in a group. * `principalSet://iam.
27474
+ # googleapis.com/locations/global/workforcePools/`pool_id`/attribute.`
27475
+ # attribute_name`/`attribute_value``: All workforce identities with a specific
27476
+ # attribute value. * `principalSet://iam.googleapis.com/locations/global/
27477
+ # workforcePools/`pool_id`/*`: All identities in a workforce identity pool. * `
27478
+ # principal://iam.googleapis.com/projects/`project_number`/locations/global/
27479
+ # workloadIdentityPools/`pool_id`/subject/`subject_attribute_value``: A single
27480
+ # identity in a workload identity pool. * `principalSet://iam.googleapis.com/
27481
+ # projects/`project_number`/locations/global/workloadIdentityPools/`pool_id`/
27482
+ # group/`group_id``: A workload identity pool group. * `principalSet://iam.
27483
+ # googleapis.com/projects/`project_number`/locations/global/
27484
+ # workloadIdentityPools/`pool_id`/attribute.`attribute_name`/`attribute_value``:
27485
+ # All identities in a workload identity pool with a certain attribute. * `
27486
+ # principalSet://iam.googleapis.com/projects/`project_number`/locations/global/
27487
+ # workloadIdentityPools/`pool_id`/*`: All identities in a workload identity pool.
27488
+ # * `deleted:user:`emailid`?uid=`uniqueid``: An email address (plus unique
27489
+ # identifier) representing a user that has been recently deleted. For example, `
27490
+ # alice@example.com?uid=123456789012345678901`. If the user is recovered, this
27491
+ # value reverts to `user:`emailid`` and the recovered user retains the role in
27492
+ # the binding. * `deleted:serviceAccount:`emailid`?uid=`uniqueid``: An email
27493
+ # address (plus unique identifier) representing a service account that has been
27494
+ # recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=
26770
27495
  # 123456789012345678901`. If the service account is undeleted, this value
26771
27496
  # reverts to `serviceAccount:`emailid`` and the undeleted service account
26772
27497
  # retains the role in the binding. * `deleted:group:`emailid`?uid=`uniqueid``:
26773
27498
  # An email address (plus unique identifier) representing a Google group that has
26774
27499
  # been recently deleted. For example, `admins@example.com?uid=
26775
27500
  # 123456789012345678901`. If the group is recovered, this value reverts to `
26776
- # group:`emailid`` and the recovered group retains the role in the binding.
27501
+ # group:`emailid`` and the recovered group retains the role in the binding. * `
27502
+ # deleted:principal://iam.googleapis.com/locations/global/workforcePools/`
27503
+ # pool_id`/subject/`subject_attribute_value``: Deleted single identity in a
27504
+ # workforce identity pool. For example, `deleted:principal://iam.googleapis.com/
27505
+ # locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
26777
27506
  # Corresponds to the JSON property `members`
26778
27507
  # @return [Array<String>]
26779
27508
  attr_accessor :members