google-apis-aiplatform_v1 0.69.0 → 0.70.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 92f05e4a3b3e986b1c526023b0456851c41c71e43c24b9a54534f778951ec6f1
4
- data.tar.gz: 7b7d52b5fb58102cd3dd8e49af636e28c94049ad690f37a3d4fc273ca45d6a28
3
+ metadata.gz: 541dbb5c1dca5b704d6d39e4f62de7bd5a337475921d4a478cbba5926b992fa8
4
+ data.tar.gz: 05ab7d1d9f4f01648a2b2fe7201020b0c82f3443f453b7b2d3805422464cbe26
5
5
  SHA512:
6
- metadata.gz: c3c3602c270886c1528a99892d3d47973f61bb36053ceba7491c1c272061e9610ce0e5848cd980c4e605e44f7fef1bd77ae51677ba3c5792f7bf462b8e05b500
7
- data.tar.gz: 3fd5e4ce5a33b8764617196ea3b260160aff44012d274746a0a56df95b27dc23823e73855c91b58daa8b3d07e6f2540d0ecdb9f475b8bc129a857520b510b4ac
6
+ metadata.gz: 45ad62eecda1739d7f8db0756c85cb626f00e5d56dfcbb83b43c6b306a5de24f2d368d3496ec5f2c6a8d515321568835c0696ea720e611e4fd7f253d6f08ab8e
7
+ data.tar.gz: 7f74e881703e4bd024a6e66ac1b8378e50e6431c187e3c80c721ebe378a5b9a16990bb95f0480b31a661fe6dbb682c233bc3ef22387cd5497755b2b4850b347f
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-aiplatform_v1
2
2
 
3
+ ### v0.70.0 (2025-10-26)
4
+
5
+ * Regenerated from discovery document revision 20251010
6
+
3
7
  ### v0.69.0 (2025-10-19)
4
8
 
5
9
  * Regenerated from discovery document revision 20251003
@@ -7448,6 +7448,107 @@ module Google
7448
7448
  end
7449
7449
  end
7450
7450
 
7451
+ # Request message for PredictionService.EmbedContent.
7452
+ class GoogleCloudAiplatformV1EmbedContentRequest
7453
+ include Google::Apis::Core::Hashable
7454
+
7455
+ # Optional. Whether to silently truncate the input content if it's longer than
7456
+ # the maximum sequence length.
7457
+ # Corresponds to the JSON property `autoTruncate`
7458
+ # @return [Boolean]
7459
+ attr_accessor :auto_truncate
7460
+ alias_method :auto_truncate?, :auto_truncate
7461
+
7462
+ # The base structured datatype containing multi-part content of a message. A `
7463
+ # Content` includes a `role` field designating the producer of the `Content` and
7464
+ # a `parts` field containing multi-part data that contains the content of the
7465
+ # message turn.
7466
+ # Corresponds to the JSON property `content`
7467
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content]
7468
+ attr_accessor :content
7469
+
7470
+ # Optional. Optional reduced dimension for the output embedding. If set,
7471
+ # excessive values in the output embedding are truncated from the end.
7472
+ # Corresponds to the JSON property `outputDimensionality`
7473
+ # @return [Fixnum]
7474
+ attr_accessor :output_dimensionality
7475
+
7476
+ # Optional. The task type of the embedding.
7477
+ # Corresponds to the JSON property `taskType`
7478
+ # @return [String]
7479
+ attr_accessor :task_type
7480
+
7481
+ # Optional. An optional title for the text.
7482
+ # Corresponds to the JSON property `title`
7483
+ # @return [String]
7484
+ attr_accessor :title
7485
+
7486
+ def initialize(**args)
7487
+ update!(**args)
7488
+ end
7489
+
7490
+ # Update properties of this object
7491
+ def update!(**args)
7492
+ @auto_truncate = args[:auto_truncate] if args.key?(:auto_truncate)
7493
+ @content = args[:content] if args.key?(:content)
7494
+ @output_dimensionality = args[:output_dimensionality] if args.key?(:output_dimensionality)
7495
+ @task_type = args[:task_type] if args.key?(:task_type)
7496
+ @title = args[:title] if args.key?(:title)
7497
+ end
7498
+ end
7499
+
7500
+ # Response message for PredictionService.EmbedContent.
7501
+ class GoogleCloudAiplatformV1EmbedContentResponse
7502
+ include Google::Apis::Core::Hashable
7503
+
7504
+ # A list of floats representing an embedding.
7505
+ # Corresponds to the JSON property `embedding`
7506
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EmbedContentResponseEmbedding]
7507
+ attr_accessor :embedding
7508
+
7509
+ # Whether the input content was truncated before generating the embedding.
7510
+ # Corresponds to the JSON property `truncated`
7511
+ # @return [Boolean]
7512
+ attr_accessor :truncated
7513
+ alias_method :truncated?, :truncated
7514
+
7515
+ # Usage metadata about the content generation request and response. This message
7516
+ # provides a detailed breakdown of token usage and other relevant metrics.
7517
+ # Corresponds to the JSON property `usageMetadata`
7518
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UsageMetadata]
7519
+ attr_accessor :usage_metadata
7520
+
7521
+ def initialize(**args)
7522
+ update!(**args)
7523
+ end
7524
+
7525
+ # Update properties of this object
7526
+ def update!(**args)
7527
+ @embedding = args[:embedding] if args.key?(:embedding)
7528
+ @truncated = args[:truncated] if args.key?(:truncated)
7529
+ @usage_metadata = args[:usage_metadata] if args.key?(:usage_metadata)
7530
+ end
7531
+ end
7532
+
7533
+ # A list of floats representing an embedding.
7534
+ class GoogleCloudAiplatformV1EmbedContentResponseEmbedding
7535
+ include Google::Apis::Core::Hashable
7536
+
7537
+ # Embedding vector values.
7538
+ # Corresponds to the JSON property `values`
7539
+ # @return [Array<Float>]
7540
+ attr_accessor :values
7541
+
7542
+ def initialize(**args)
7543
+ update!(**args)
7544
+ end
7545
+
7546
+ # Update properties of this object
7547
+ def update!(**args)
7548
+ @values = args[:values] if args.key?(:values)
7549
+ end
7550
+ end
7551
+
7451
7552
  # Represents a customer-managed encryption key spec that can be applied to a top-
7452
7553
  # level resource.
7453
7554
  class GoogleCloudAiplatformV1EncryptionSpec
@@ -24753,6 +24854,12 @@ module Google
24753
24854
  # @return [Array<Object>]
24754
24855
  attr_accessor :instances
24755
24856
 
24857
+ # Optional. The user labels for Imagen billing usage only. Only Imagen supports
24858
+ # labels. For other use cases, it will be ignored.
24859
+ # Corresponds to the JSON property `labels`
24860
+ # @return [Hash<String,String>]
24861
+ attr_accessor :labels
24862
+
24756
24863
  # The parameters that govern the prediction. The schema of the parameters may be
24757
24864
  # specified via Endpoint's DeployedModels' Model's PredictSchemata's
24758
24865
  # parameters_schema_uri.
@@ -24767,6 +24874,7 @@ module Google
24767
24874
  # Update properties of this object
24768
24875
  def update!(**args)
24769
24876
  @instances = args[:instances] if args.key?(:instances)
24877
+ @labels = args[:labels] if args.key?(:labels)
24770
24878
  @parameters = args[:parameters] if args.key?(:parameters)
24771
24879
  end
24772
24880
  end
@@ -42827,6 +42935,97 @@ module Google
42827
42935
  end
42828
42936
  end
42829
42937
 
42938
+ # Usage metadata about the content generation request and response. This message
42939
+ # provides a detailed breakdown of token usage and other relevant metrics.
42940
+ class GoogleCloudAiplatformV1UsageMetadata
42941
+ include Google::Apis::Core::Hashable
42942
+
42943
+ # Output only. A detailed breakdown of the token count for each modality in the
42944
+ # cached content.
42945
+ # Corresponds to the JSON property `cacheTokensDetails`
42946
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModalityTokenCount>]
42947
+ attr_accessor :cache_tokens_details
42948
+
42949
+ # Output only. The number of tokens in the cached content that was used for this
42950
+ # request.
42951
+ # Corresponds to the JSON property `cachedContentTokenCount`
42952
+ # @return [Fixnum]
42953
+ attr_accessor :cached_content_token_count
42954
+
42955
+ # The total number of tokens in the generated candidates.
42956
+ # Corresponds to the JSON property `candidatesTokenCount`
42957
+ # @return [Fixnum]
42958
+ attr_accessor :candidates_token_count
42959
+
42960
+ # Output only. A detailed breakdown of the token count for each modality in the
42961
+ # generated candidates.
42962
+ # Corresponds to the JSON property `candidatesTokensDetails`
42963
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModalityTokenCount>]
42964
+ attr_accessor :candidates_tokens_details
42965
+
42966
+ # The total number of tokens in the prompt. This includes any text, images, or
42967
+ # other media provided in the request. When `cached_content` is set, this also
42968
+ # includes the number of tokens in the cached content.
42969
+ # Corresponds to the JSON property `promptTokenCount`
42970
+ # @return [Fixnum]
42971
+ attr_accessor :prompt_token_count
42972
+
42973
+ # Output only. A detailed breakdown of the token count for each modality in the
42974
+ # prompt.
42975
+ # Corresponds to the JSON property `promptTokensDetails`
42976
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModalityTokenCount>]
42977
+ attr_accessor :prompt_tokens_details
42978
+
42979
+ # Output only. The number of tokens that were part of the model's generated "
42980
+ # thoughts" output, if applicable.
42981
+ # Corresponds to the JSON property `thoughtsTokenCount`
42982
+ # @return [Fixnum]
42983
+ attr_accessor :thoughts_token_count
42984
+
42985
+ # Output only. The number of tokens in the results from tool executions, which
42986
+ # are provided back to the model as input, if applicable.
42987
+ # Corresponds to the JSON property `toolUsePromptTokenCount`
42988
+ # @return [Fixnum]
42989
+ attr_accessor :tool_use_prompt_token_count
42990
+
42991
+ # Output only. A detailed breakdown by modality of the token counts from the
42992
+ # results of tool executions, which are provided back to the model as input.
42993
+ # Corresponds to the JSON property `toolUsePromptTokensDetails`
42994
+ # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModalityTokenCount>]
42995
+ attr_accessor :tool_use_prompt_tokens_details
42996
+
42997
+ # The total number of tokens for the entire request. This is the sum of `
42998
+ # prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`,
42999
+ # and `thoughts_token_count`.
43000
+ # Corresponds to the JSON property `totalTokenCount`
43001
+ # @return [Fixnum]
43002
+ attr_accessor :total_token_count
43003
+
43004
+ # Output only. The traffic type for this request.
43005
+ # Corresponds to the JSON property `trafficType`
43006
+ # @return [String]
43007
+ attr_accessor :traffic_type
43008
+
43009
+ def initialize(**args)
43010
+ update!(**args)
43011
+ end
43012
+
43013
+ # Update properties of this object
43014
+ def update!(**args)
43015
+ @cache_tokens_details = args[:cache_tokens_details] if args.key?(:cache_tokens_details)
43016
+ @cached_content_token_count = args[:cached_content_token_count] if args.key?(:cached_content_token_count)
43017
+ @candidates_token_count = args[:candidates_token_count] if args.key?(:candidates_token_count)
43018
+ @candidates_tokens_details = args[:candidates_tokens_details] if args.key?(:candidates_tokens_details)
43019
+ @prompt_token_count = args[:prompt_token_count] if args.key?(:prompt_token_count)
43020
+ @prompt_tokens_details = args[:prompt_tokens_details] if args.key?(:prompt_tokens_details)
43021
+ @thoughts_token_count = args[:thoughts_token_count] if args.key?(:thoughts_token_count)
43022
+ @tool_use_prompt_token_count = args[:tool_use_prompt_token_count] if args.key?(:tool_use_prompt_token_count)
43023
+ @tool_use_prompt_tokens_details = args[:tool_use_prompt_tokens_details] if args.key?(:tool_use_prompt_tokens_details)
43024
+ @total_token_count = args[:total_token_count] if args.key?(:total_token_count)
43025
+ @traffic_type = args[:traffic_type] if args.key?(:traffic_type)
43026
+ end
43027
+ end
43028
+
42830
43029
  # References an API call. It contains more information about long running
42831
43030
  # operation and Jobs that are triggered by the API call.
42832
43031
  class GoogleCloudAiplatformV1UserActionReference
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module AiplatformV1
18
18
  # Version of the google-apis-aiplatform_v1 gem
19
- GEM_VERSION = "0.69.0"
19
+ GEM_VERSION = "0.70.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.18.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20251003"
25
+ REVISION = "20251010"
26
26
  end
27
27
  end
28
28
  end
@@ -1300,6 +1300,24 @@ module Google
1300
1300
  include Google::Apis::Core::JsonObjectSupport
1301
1301
  end
1302
1302
 
1303
+ class GoogleCloudAiplatformV1EmbedContentRequest
1304
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1305
+
1306
+ include Google::Apis::Core::JsonObjectSupport
1307
+ end
1308
+
1309
+ class GoogleCloudAiplatformV1EmbedContentResponse
1310
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1311
+
1312
+ include Google::Apis::Core::JsonObjectSupport
1313
+ end
1314
+
1315
+ class GoogleCloudAiplatformV1EmbedContentResponseEmbedding
1316
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1317
+
1318
+ include Google::Apis::Core::JsonObjectSupport
1319
+ end
1320
+
1303
1321
  class GoogleCloudAiplatformV1EncryptionSpec
1304
1322
  class Representation < Google::Apis::Core::JsonRepresentation; end
1305
1323
 
@@ -7210,6 +7228,12 @@ module Google
7210
7228
  include Google::Apis::Core::JsonObjectSupport
7211
7229
  end
7212
7230
 
7231
+ class GoogleCloudAiplatformV1UsageMetadata
7232
+ class Representation < Google::Apis::Core::JsonRepresentation; end
7233
+
7234
+ include Google::Apis::Core::JsonObjectSupport
7235
+ end
7236
+
7213
7237
  class GoogleCloudAiplatformV1UserActionReference
7214
7238
  class Representation < Google::Apis::Core::JsonRepresentation; end
7215
7239
 
@@ -9526,6 +9550,36 @@ module Google
9526
9550
  end
9527
9551
  end
9528
9552
 
9553
+ class GoogleCloudAiplatformV1EmbedContentRequest
9554
+ # @private
9555
+ class Representation < Google::Apis::Core::JsonRepresentation
9556
+ property :auto_truncate, as: 'autoTruncate'
9557
+ property :content, as: 'content', class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content, decorator: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content::Representation
9558
+
9559
+ property :output_dimensionality, as: 'outputDimensionality'
9560
+ property :task_type, as: 'taskType'
9561
+ property :title, as: 'title'
9562
+ end
9563
+ end
9564
+
9565
+ class GoogleCloudAiplatformV1EmbedContentResponse
9566
+ # @private
9567
+ class Representation < Google::Apis::Core::JsonRepresentation
9568
+ property :embedding, as: 'embedding', class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EmbedContentResponseEmbedding, decorator: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EmbedContentResponseEmbedding::Representation
9569
+
9570
+ property :truncated, as: 'truncated'
9571
+ property :usage_metadata, as: 'usageMetadata', class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UsageMetadata, decorator: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UsageMetadata::Representation
9572
+
9573
+ end
9574
+ end
9575
+
9576
+ class GoogleCloudAiplatformV1EmbedContentResponseEmbedding
9577
+ # @private
9578
+ class Representation < Google::Apis::Core::JsonRepresentation
9579
+ collection :values, as: 'values'
9580
+ end
9581
+ end
9582
+
9529
9583
  class GoogleCloudAiplatformV1EncryptionSpec
9530
9584
  # @private
9531
9585
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -14390,6 +14444,7 @@ module Google
14390
14444
  # @private
14391
14445
  class Representation < Google::Apis::Core::JsonRepresentation
14392
14446
  collection :instances, as: 'instances'
14447
+ hash :labels, as: 'labels'
14393
14448
  property :parameters, as: 'parameters'
14394
14449
  end
14395
14450
  end
@@ -19628,6 +19683,27 @@ module Google
19628
19683
  end
19629
19684
  end
19630
19685
 
19686
+ class GoogleCloudAiplatformV1UsageMetadata
19687
+ # @private
19688
+ class Representation < Google::Apis::Core::JsonRepresentation
19689
+ collection :cache_tokens_details, as: 'cacheTokensDetails', class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModalityTokenCount, decorator: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModalityTokenCount::Representation
19690
+
19691
+ property :cached_content_token_count, as: 'cachedContentTokenCount'
19692
+ property :candidates_token_count, as: 'candidatesTokenCount'
19693
+ collection :candidates_tokens_details, as: 'candidatesTokensDetails', class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModalityTokenCount, decorator: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModalityTokenCount::Representation
19694
+
19695
+ property :prompt_token_count, as: 'promptTokenCount'
19696
+ collection :prompt_tokens_details, as: 'promptTokensDetails', class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModalityTokenCount, decorator: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModalityTokenCount::Representation
19697
+
19698
+ property :thoughts_token_count, as: 'thoughtsTokenCount'
19699
+ property :tool_use_prompt_token_count, as: 'toolUsePromptTokenCount'
19700
+ collection :tool_use_prompt_tokens_details, as: 'toolUsePromptTokensDetails', class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModalityTokenCount, decorator: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModalityTokenCount::Representation
19701
+
19702
+ property :total_token_count, as: 'totalTokenCount'
19703
+ property :traffic_type, as: 'trafficType'
19704
+ end
19705
+ end
19706
+
19631
19707
  class GoogleCloudAiplatformV1UserActionReference
19632
19708
  # @private
19633
19709
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -18468,6 +18468,40 @@ module Google
18468
18468
  execute_or_queue_command(command, &block)
18469
18469
  end
18470
18470
 
18471
+ # Embed content with multimodal inputs.
18472
+ # @param [String] model
18473
+ # Required. The name of the publisher model requested to serve the prediction.
18474
+ # Format: `projects/`project`/locations/`location`/publishers/*/models/*`
18475
+ # @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EmbedContentRequest] google_cloud_aiplatform_v1_embed_content_request_object
18476
+ # @param [String] fields
18477
+ # Selector specifying which fields to include in a partial response.
18478
+ # @param [String] quota_user
18479
+ # Available to use for quota purposes for server-side applications. Can be any
18480
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
18481
+ # @param [Google::Apis::RequestOptions] options
18482
+ # Request-specific options
18483
+ #
18484
+ # @yield [result, err] Result & error if block supplied
18485
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EmbedContentResponse] parsed result object
18486
+ # @yieldparam err [StandardError] error object if request failed
18487
+ #
18488
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EmbedContentResponse]
18489
+ #
18490
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
18491
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
18492
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
18493
+ def embed_project_location_publisher_model_content(model, google_cloud_aiplatform_v1_embed_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
18494
+ command = make_simple_command(:post, 'v1/{+model}:embedContent', options)
18495
+ command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EmbedContentRequest::Representation
18496
+ command.request_object = google_cloud_aiplatform_v1_embed_content_request_object
18497
+ command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EmbedContentResponse::Representation
18498
+ command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EmbedContentResponse
18499
+ command.params['model'] = model unless model.nil?
18500
+ command.query['fields'] = fields unless fields.nil?
18501
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
18502
+ execute_or_queue_command(command, &block)
18503
+ end
18504
+
18471
18505
  # Fetch an asynchronous online prediction operation.
18472
18506
  # @param [String] endpoint
18473
18507
  # Required. The name of the Endpoint requested to serve the prediction. Format: `
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-aiplatform_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.69.0
4
+ version: 0.70.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
@@ -57,7 +57,7 @@ licenses:
57
57
  metadata:
58
58
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
59
59
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-aiplatform_v1/CHANGELOG.md
60
- documentation_uri: https://googleapis.dev/ruby/google-apis-aiplatform_v1/v0.69.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-aiplatform_v1/v0.70.0
61
61
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-aiplatform_v1
62
62
  rdoc_options: []
63
63
  require_paths: