google-cloud-ai_platform-v1 0.23.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7983d3d1a9814c8defe22ac7f9df51d6e6ae240e46b3fcf0792795bfb3ae5c0d
-  data.tar.gz: ec23fa3ec0276c4b18b4aaed04b28e763d3ba58045453b73c83f179ddfc48762
+  metadata.gz: e4fb9d2c0c08f62d6c6e350e8067e9a771da919c7c3465092afd576e7d94f159
+  data.tar.gz: 4e997cf49e37e81613dcaf4ad0aa887c07ff65524c2400b8121ab059ac6a17ac
 SHA512:
-  metadata.gz: '079b939e1294250ce689f007d81a4cbf1a56716918312eb914674f96ce77d49d10c23039ed2c171d423dfa16a801aee7d86056aa32efab4923ce6325f6314355'
-  data.tar.gz: 226bae05c0d5b06a5812b9f2a54a9cefabd5003ca256964e5ee1e819b5f950abd64b1ac91345868c7ec4f16b7634b08e44321427976126f870f91a4b966ab49f
+  metadata.gz: c6cdd0917326e4ce3681327bfdd7fc81f0b274bc810a00a05863115f8d4bc192d901b55119c34d262758d1328eb59e6a73285731efdfd405b5c7af84ba53068b
+  data.tar.gz: 636944fb0edbe7846bf0354bafb5f7af97d87b856c4d68c5a0f6668b3e1a15e1d79bbe8878337b3ad85c5822f0e502f9954938ea29092603e3850b27996d9c63

data/lib/google/cloud/ai_platform/v1/match_service/client.rb

@@ -0,0 +1,531 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "google/cloud/errors"
+require "google/cloud/aiplatform/v1/match_service_pb"
+require "google/cloud/location"
+require "google/iam/v1"
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        module MatchService
+          ##
+          # Client for the MatchService service.
+          #
+          # MatchService is a Google managed service for efficient vector similarity
+          # search at scale.
+          #
+          class Client
+            include Paths
+
+            # @private
+            attr_reader :match_service_stub
+
+            ##
+            # Configure the MatchService Client class.
+            #
+            # See {::Google::Cloud::AIPlatform::V1::MatchService::Client::Configuration}
+            # for a description of the configuration fields.
+            #
+            # @example
+            #
+            #   # Modify the configuration for all MatchService clients
+            #   ::Google::Cloud::AIPlatform::V1::MatchService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
+            #
+            # @yield [config] Configure the Client client.
+            # @yieldparam config [Client::Configuration]
+            #
+            # @return [Client::Configuration]
+            #
+            def self.configure
+              @configure ||= begin
+                namespace = ["Google", "Cloud", "AIPlatform", "V1"]
+                parent_config = while namespace.any?
+                                  parent_name = namespace.join "::"
+                                  parent_const = const_get parent_name
+                                  break parent_const.configure if parent_const.respond_to? :configure
+                                  namespace.pop
+                                end
+                default_config = Client::Configuration.new parent_config
+
+                default_config
+              end
+              yield @configure if block_given?
+              @configure
+            end
+
+            ##
+            # Configure the MatchService Client instance.
+            #
+            # The configuration is set to the derived mode, meaning that values can be changed,
+            # but structural changes (adding new fields, etc.) are not allowed. Structural changes
+            # should be made on {Client.configure}.
+            #
+            # See {::Google::Cloud::AIPlatform::V1::MatchService::Client::Configuration}
+            # for a description of the configuration fields.
+            #
+            # @yield [config] Configure the Client client.
+            # @yieldparam config [Client::Configuration]
+            #
+            # @return [Client::Configuration]
+            #
+            def configure
+              yield @config if block_given?
+              @config
+            end
+
+            ##
+            # Create a new MatchService client object.
+            #
+            # @example
+            #
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::AIPlatform::V1::MatchService::Client.new
+            #
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::AIPlatform::V1::MatchService::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
+            #
+            # @yield [config] Configure the MatchService client.
+            # @yieldparam config [Client::Configuration]
+            #
+            def initialize
+              # These require statements are intentionally placed here to initialize
+              # the gRPC module only when it's required.
+              # See https://github.com/googleapis/toolkit/issues/446
+              require "gapic/grpc"
+              require "google/cloud/aiplatform/v1/match_service_services_pb"
+
+              # Create the configuration object
+              @config = Configuration.new Client.configure
+
+              # Yield the configuration if needed
+              yield @config if block_given?
+
+              # Create credentials
+              credentials = @config.credentials
+              # Use self-signed JWT if the endpoint is unchanged from default,
+              # but only if the default endpoint does not have a region prefix.
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
+                                       !@config.endpoint.split(".").first.include?("-")
+              credentials ||= Credentials.default scope: @config.scope,
+                                                  enable_self_signed_jwt: enable_self_signed_jwt
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
+                credentials = Credentials.new credentials, scope: @config.scope
+              end
+              @quota_project_id = @config.quota_project
+              @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
+
+              @location_client = Google::Cloud::Location::Locations::Client.new do |config|
+                config.credentials = credentials
+                config.quota_project = @quota_project_id
+                config.endpoint = @config.endpoint
+              end
+
+              @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
+                config.credentials = credentials
+                config.quota_project = @quota_project_id
+                config.endpoint = @config.endpoint
+              end
+
+              @match_service_stub = ::Gapic::ServiceStub.new(
+                ::Google::Cloud::AIPlatform::V1::MatchService::Stub,
+                credentials:  credentials,
+                endpoint:     @config.endpoint,
+                channel_args: @config.channel_args,
+                interceptors: @config.interceptors
+              )
+            end
+
+            ##
+            # Get the associated client for mix-in of the Locations.
+            #
+            # @return [Google::Cloud::Location::Locations::Client]
+            #
+            attr_reader :location_client
+
+            ##
+            # Get the associated client for mix-in of the IAMPolicy.
+            #
+            # @return [Google::Iam::V1::IAMPolicy::Client]
+            #
+            attr_reader :iam_policy_client
+
+            # Service calls
+
+            ##
+            # Finds the nearest neighbors of each vector within the request.
+            #
+            # @overload find_neighbors(request, options = nil)
+            #   Pass arguments to `find_neighbors` via a request object, either of type
+            #   {::Google::Cloud::AIPlatform::V1::FindNeighborsRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::AIPlatform::V1::FindNeighborsRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload find_neighbors(index_endpoint: nil, deployed_index_id: nil, queries: nil, return_full_datapoint: nil)
+            #   Pass arguments to `find_neighbors` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param index_endpoint [::String]
+            #     Required. The name of the index endpoint.
+            #     Format:
+            #     `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
+            #   @param deployed_index_id [::String]
+            #     The ID of the DeployedIndex that will serve the request. This request is
+            #     sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That
+            #     IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index
+            #     has a DeployedIndex.id field.
+            #     The value of the field below must equal one of the DeployedIndex.id
+            #     fields of the IndexEndpoint that is being called for this request.
+            #   @param queries [::Array<::Google::Cloud::AIPlatform::V1::FindNeighborsRequest::Query, ::Hash>]
+            #     The list of queries.
+            #   @param return_full_datapoint [::Boolean]
+            #     If set to true, the full datapoints (including all vector values and
+            #     restricts) of the nearest neighbors are returned.
+            #     Note that returning full datapoint will significantly increase the
+            #     latency and cost of the query.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::AIPlatform::V1::FindNeighborsResponse]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::AIPlatform::V1::FindNeighborsResponse]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/ai_platform/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::AIPlatform::V1::MatchService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::AIPlatform::V1::FindNeighborsRequest.new
+            #
+            #   # Call the find_neighbors method.
+            #   result = client.find_neighbors request
+            #
+            #   # The returned object is of type Google::Cloud::AIPlatform::V1::FindNeighborsResponse.
+            #   p result
+            #
+            def find_neighbors request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::FindNeighborsRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.find_neighbors.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.index_endpoint
+                header_params["index_endpoint"] = request.index_endpoint
+              end
+
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.find_neighbors.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.find_neighbors.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @match_service_stub.call_rpc :find_neighbors, request, options: options do |response, operation|
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
+            ##
+            # Reads the datapoints/vectors of the given IDs.
+            # A maximum of 1000 datapoints can be retrieved in a batch.
+            #
+            # @overload read_index_datapoints(request, options = nil)
+            #   Pass arguments to `read_index_datapoints` via a request object, either of type
+            #   {::Google::Cloud::AIPlatform::V1::ReadIndexDatapointsRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::AIPlatform::V1::ReadIndexDatapointsRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload read_index_datapoints(index_endpoint: nil, deployed_index_id: nil, ids: nil)
+            #   Pass arguments to `read_index_datapoints` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param index_endpoint [::String]
+            #     Required. The name of the index endpoint.
+            #     Format:
+            #     `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
+            #   @param deployed_index_id [::String]
+            #     The ID of the DeployedIndex that will serve the request.
+            #   @param ids [::Array<::String>]
+            #     IDs of the datapoints to be searched for.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::AIPlatform::V1::ReadIndexDatapointsResponse]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::AIPlatform::V1::ReadIndexDatapointsResponse]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/ai_platform/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::AIPlatform::V1::MatchService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::AIPlatform::V1::ReadIndexDatapointsRequest.new
+            #
+            #   # Call the read_index_datapoints method.
+            #   result = client.read_index_datapoints request
+            #
+            #   # The returned object is of type Google::Cloud::AIPlatform::V1::ReadIndexDatapointsResponse.
+            #   p result
+            #
+            def read_index_datapoints request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ReadIndexDatapointsRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.read_index_datapoints.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.index_endpoint
+                header_params["index_endpoint"] = request.index_endpoint
+              end
+
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.read_index_datapoints.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.read_index_datapoints.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @match_service_stub.call_rpc :read_index_datapoints, request, options: options do |response, operation|
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
+            ##
+            # Configuration class for the MatchService API.
+            #
+            # This class represents the configuration for MatchService,
+            # providing control over timeouts, retry behavior, logging, transport
+            # parameters, and other low-level controls. Certain parameters can also be
+            # applied individually to specific RPCs. See
+            # {::Google::Cloud::AIPlatform::V1::MatchService::Client::Configuration::Rpcs}
+            # for a list of RPCs that can be configured independently.
+            #
+            # Configuration can be applied globally to all clients, or to a single client
+            # on construction.
+            #
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # find_neighbors to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::AIPlatform::V1::MatchService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.find_neighbors.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::AIPlatform::V1::MatchService::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.find_neighbors.timeout = 20.0
+            #   end
+            #
+            # @!attribute [rw] endpoint
+            #   The hostname or hostname:port of the service endpoint.
+            #   Defaults to `"aiplatform.googleapis.com"`.
+            #   @return [::String]
+            # @!attribute [rw] credentials
+            #   Credentials to send with calls. You may provide any of the following types:
+            #    *  (`String`) The path to a service account key file in JSON format
+            #    *  (`Hash`) A service account key as a Hash
+            #    *  (`Google::Auth::Credentials`) A googleauth credentials object
+            #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
+            #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
+            #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
+            #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
+            #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
+            #    *  (`nil`) indicating no credentials
+            #   @return [::Object]
+            # @!attribute [rw] scope
+            #   The OAuth scopes
+            #   @return [::Array<::String>]
+            # @!attribute [rw] lib_name
+            #   The library name as recorded in instrumentation and logging
+            #   @return [::String]
+            # @!attribute [rw] lib_version
+            #   The library version as recorded in instrumentation and logging
+            #   @return [::String]
+            # @!attribute [rw] channel_args
+            #   Extra parameters passed to the gRPC channel. Note: this is ignored if a
+            #   `GRPC::Core::Channel` object is provided as the credential.
+            #   @return [::Hash]
+            # @!attribute [rw] interceptors
+            #   An array of interceptors that are run before calls are executed.
+            #   @return [::Array<::GRPC::ClientInterceptor>]
+            # @!attribute [rw] timeout
+            #   The call timeout in seconds.
+            #   @return [::Numeric]
+            # @!attribute [rw] metadata
+            #   Additional gRPC headers to be sent with the call.
+            #   @return [::Hash{::Symbol=>::String}]
+            # @!attribute [rw] retry_policy
+            #   The retry policy. The value is a hash with the following keys:
+            #    *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+            #    *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+            #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+            #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+            #       trigger a retry.
+            #   @return [::Hash]
+            # @!attribute [rw] quota_project
+            #   A separate project against which to charge quota.
+            #   @return [::String]
+            #
+            class Configuration
+              extend ::Gapic::Config
+
+              config_attr :endpoint,      "aiplatform.googleapis.com", ::String
+              config_attr :credentials,   nil do |value|
+                allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
+                allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
+                allowed.any? { |klass| klass === value }
+              end
+              config_attr :scope,         nil, ::String, ::Array, nil
+              config_attr :lib_name,      nil, ::String, nil
+              config_attr :lib_version,   nil, ::String, nil
+              config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
+              config_attr :interceptors,  nil, ::Array, nil
+              config_attr :timeout,       nil, ::Numeric, nil
+              config_attr :metadata,      nil, ::Hash, nil
+              config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
+              config_attr :quota_project, nil, ::String, nil
+
+              # @private
+              def initialize parent_config = nil
+                @parent_config = parent_config unless parent_config.nil?
+
+                yield self if block_given?
+              end
+
+              ##
+              # Configurations for individual RPCs
+              # @return [Rpcs]
+              #
+              def rpcs
+                @rpcs ||= begin
+                  parent_rpcs = nil
+                  parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
+                  Rpcs.new parent_rpcs
+                end
+              end
+
+              ##
+              # Configuration RPC class for the MatchService API.
+              #
+              # Includes fields providing the configuration for each RPC in this service.
+              # Each configuration object is of type `Gapic::Config::Method` and includes
+              # the following configuration fields:
+              #
+              #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
+              #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
+              #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
+              #     include the following keys:
+              #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+              #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+              #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+              #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+              #         trigger a retry.
+              #
+              class Rpcs
+                ##
+                # RPC-specific configuration for `find_neighbors`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :find_neighbors
+                ##
+                # RPC-specific configuration for `read_index_datapoints`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :read_index_datapoints
+
+                # @private
+                def initialize parent_rpcs = nil
+                  find_neighbors_config = parent_rpcs.find_neighbors if parent_rpcs.respond_to? :find_neighbors
+                  @find_neighbors = ::Gapic::Config::Method.new find_neighbors_config
+                  read_index_datapoints_config = parent_rpcs.read_index_datapoints if parent_rpcs.respond_to? :read_index_datapoints
+                  @read_index_datapoints = ::Gapic::Config::Method.new read_index_datapoints_config
+
+                  yield self if block_given?
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/ai_platform/v1/match_service/credentials.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "googleauth"
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        module MatchService
+          # Credentials for the MatchService API.
+          class Credentials < ::Google::Auth::Credentials
+            self.scope = [
+              "https://www.googleapis.com/auth/cloud-platform"
+            ]
+            self.env_vars = [
+              "GOOGLE_CLOUD_CREDENTIALS",
+              "GOOGLE_CLOUD_KEYFILE",
+              "GCLOUD_KEYFILE",
+              "GOOGLE_CLOUD_CREDENTIALS_JSON",
+              "GOOGLE_CLOUD_KEYFILE_JSON",
+              "GCLOUD_KEYFILE_JSON"
+            ]
+            self.paths = [
+              "~/.config/google_cloud/application_default_credentials.json"
+            ]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/ai_platform/v1/match_service/paths.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        module MatchService
+          # Path helper methods for the MatchService API.
+          module Paths
+            ##
+            # Create a fully-qualified IndexEndpoint resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
+            #
+            # @param project [String]
+            # @param location [String]
+            # @param index_endpoint [String]
+            #
+            # @return [::String]
+            def index_endpoint_path project:, location:, index_endpoint:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}/indexEndpoints/#{index_endpoint}"
+            end
+
+            extend self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/ai_platform/v1/match_service.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/ai_platform/v1/version"
+
+require "google/cloud/ai_platform/v1/match_service/credentials"
+require "google/cloud/ai_platform/v1/match_service/paths"
+require "google/cloud/ai_platform/v1/match_service/client"
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        ##
+        # MatchService is a Google managed service for efficient vector similarity
+        # search at scale.
+        #
+        # @example Load this service and instantiate a gRPC client
+        #
+        #     require "google/cloud/ai_platform/v1/match_service"
+        #     client = ::Google::Cloud::AIPlatform::V1::MatchService::Client.new
+        #
+        module MatchService
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "match_service", "helpers.rb"
+require "google/cloud/ai_platform/v1/match_service/helpers" if ::File.file? helper_path

data/lib/google/cloud/ai_platform/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module AIPlatform
       module V1
-        VERSION = "0.23.0"
+        VERSION = "0.24.0"
       end
     end
   end

data/lib/google/cloud/ai_platform/v1.rb

@@ -23,6 +23,7 @@ require "google/cloud/ai_platform/v1/featurestore_service"
 require "google/cloud/ai_platform/v1/index_endpoint_service"
 require "google/cloud/ai_platform/v1/index_service"
 require "google/cloud/ai_platform/v1/job_service"
+require "google/cloud/ai_platform/v1/match_service"
 require "google/cloud/ai_platform/v1/metadata_service"
 require "google/cloud/ai_platform/v1/migration_service"
 require "google/cloud/ai_platform/v1/model_service"

data/lib/google/cloud/aiplatform/v1/explanation_pb.rb

@@ -5,6 +5,7 @@ require 'google/protobuf'
 
 require 'google/api/field_behavior_pb'
 require 'google/cloud/aiplatform/v1/explanation_metadata_pb'
+require 'google/cloud/aiplatform/v1/io_pb'
 require 'google/protobuf/struct_pb'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
@@ -40,6 +41,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
         optional :sampled_shapley_attribution, :message, 1, "google.cloud.aiplatform.v1.SampledShapleyAttribution"
         optional :integrated_gradients_attribution, :message, 2, "google.cloud.aiplatform.v1.IntegratedGradientsAttribution"
         optional :xrai_attribution, :message, 3, "google.cloud.aiplatform.v1.XraiAttribution"
+        optional :examples, :message, 7, "google.cloud.aiplatform.v1.Examples"
       end
     end
     add_message "google.cloud.aiplatform.v1.SampledShapleyAttribution" do
@@ -72,6 +74,38 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "google.cloud.aiplatform.v1.BlurBaselineConfig" do
       optional :max_blur_sigma, :float, 1
     end
+    add_message "google.cloud.aiplatform.v1.Examples" do
+      optional :neighbor_count, :int32, 3
+      oneof :source do
+        optional :example_gcs_source, :message, 5, "google.cloud.aiplatform.v1.Examples.ExampleGcsSource"
+      end
+      oneof :config do
+        optional :nearest_neighbor_search_config, :message, 2, "google.protobuf.Value"
+        optional :presets, :message, 4, "google.cloud.aiplatform.v1.Presets"
+      end
+    end
+    add_message "google.cloud.aiplatform.v1.Examples.ExampleGcsSource" do
+      optional :data_format, :enum, 1, "google.cloud.aiplatform.v1.Examples.ExampleGcsSource.DataFormat"
+      optional :gcs_source, :message, 2, "google.cloud.aiplatform.v1.GcsSource"
+    end
+    add_enum "google.cloud.aiplatform.v1.Examples.ExampleGcsSource.DataFormat" do
+      value :DATA_FORMAT_UNSPECIFIED, 0
+      value :JSONL, 1
+    end
+    add_message "google.cloud.aiplatform.v1.Presets" do
+      proto3_optional :query, :enum, 1, "google.cloud.aiplatform.v1.Presets.Query"
+      optional :modality, :enum, 2, "google.cloud.aiplatform.v1.Presets.Modality"
+    end
+    add_enum "google.cloud.aiplatform.v1.Presets.Query" do
+      value :PRECISE, 0
+      value :FAST, 1
+    end
+    add_enum "google.cloud.aiplatform.v1.Presets.Modality" do
+      value :MODALITY_UNSPECIFIED, 0
+      value :IMAGE, 1
+      value :TEXT, 2
+      value :TABULAR, 3
+    end
     add_message "google.cloud.aiplatform.v1.ExplanationSpecOverride" do
       optional :parameters, :message, 1, "google.cloud.aiplatform.v1.ExplanationParameters"
       optional :metadata, :message, 2, "google.cloud.aiplatform.v1.ExplanationMetadataOverride"
@@ -120,6 +154,12 @@ module Google
         FeatureNoiseSigma = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.FeatureNoiseSigma").msgclass
         FeatureNoiseSigma::NoiseSigmaForFeature = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.FeatureNoiseSigma.NoiseSigmaForFeature").msgclass
         BlurBaselineConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.BlurBaselineConfig").msgclass
+        Examples = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.Examples").msgclass
+        Examples::ExampleGcsSource = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.Examples.ExampleGcsSource").msgclass
+        Examples::ExampleGcsSource::DataFormat = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.Examples.ExampleGcsSource.DataFormat").enummodule
+        Presets = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.Presets").msgclass
+        Presets::Query = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.Presets.Query").enummodule
+        Presets::Modality = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.Presets.Modality").enummodule
         ExplanationSpecOverride = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ExplanationSpecOverride").msgclass
         ExplanationMetadataOverride = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ExplanationMetadataOverride").msgclass
         ExplanationMetadataOverride::InputMetadataOverride = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ExplanationMetadataOverride.InputMetadataOverride").msgclass

data/lib/google/cloud/aiplatform/v1/match_service_pb.rb

@@ -0,0 +1,63 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/aiplatform/v1/match_service.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/client_pb'
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/cloud/aiplatform/v1/index_pb'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/aiplatform/v1/match_service.proto", :syntax => :proto3) do
+    add_message "google.cloud.aiplatform.v1.FindNeighborsRequest" do
+      optional :index_endpoint, :string, 1
+      optional :deployed_index_id, :string, 2
+      repeated :queries, :message, 3, "google.cloud.aiplatform.v1.FindNeighborsRequest.Query"
+      optional :return_full_datapoint, :bool, 4
+    end
+    add_message "google.cloud.aiplatform.v1.FindNeighborsRequest.Query" do
+      optional :datapoint, :message, 1, "google.cloud.aiplatform.v1.IndexDatapoint"
+      optional :neighbor_count, :int32, 2
+      optional :per_crowding_attribute_neighbor_count, :int32, 3
+      optional :approximate_neighbor_count, :int32, 4
+      optional :fraction_leaf_nodes_to_search_override, :double, 5
+    end
+    add_message "google.cloud.aiplatform.v1.FindNeighborsResponse" do
+      repeated :nearest_neighbors, :message, 1, "google.cloud.aiplatform.v1.FindNeighborsResponse.NearestNeighbors"
+    end
+    add_message "google.cloud.aiplatform.v1.FindNeighborsResponse.Neighbor" do
+      optional :datapoint, :message, 1, "google.cloud.aiplatform.v1.IndexDatapoint"
+      optional :distance, :double, 2
+    end
+    add_message "google.cloud.aiplatform.v1.FindNeighborsResponse.NearestNeighbors" do
+      optional :id, :string, 1
+      repeated :neighbors, :message, 2, "google.cloud.aiplatform.v1.FindNeighborsResponse.Neighbor"
+    end
+    add_message "google.cloud.aiplatform.v1.ReadIndexDatapointsRequest" do
+      optional :index_endpoint, :string, 1
+      optional :deployed_index_id, :string, 2
+      repeated :ids, :string, 3
+    end
+    add_message "google.cloud.aiplatform.v1.ReadIndexDatapointsResponse" do
+      repeated :datapoints, :message, 1, "google.cloud.aiplatform.v1.IndexDatapoint"
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        FindNeighborsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.FindNeighborsRequest").msgclass
+        FindNeighborsRequest::Query = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.FindNeighborsRequest.Query").msgclass
+        FindNeighborsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.FindNeighborsResponse").msgclass
+        FindNeighborsResponse::Neighbor = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.FindNeighborsResponse.Neighbor").msgclass
+        FindNeighborsResponse::NearestNeighbors = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.FindNeighborsResponse.NearestNeighbors").msgclass
+        ReadIndexDatapointsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ReadIndexDatapointsRequest").msgclass
+        ReadIndexDatapointsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.aiplatform.v1.ReadIndexDatapointsResponse").msgclass
+      end
+    end
+  end
+end

data/lib/google/cloud/aiplatform/v1/match_service_services_pb.rb

@@ -0,0 +1,49 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/aiplatform/v1/match_service.proto for package 'Google.Cloud.AIPlatform.V1'
+# Original file comments:
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'grpc'
+require 'google/cloud/aiplatform/v1/match_service_pb'
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        module MatchService
+          # MatchService is a Google managed service for efficient vector similarity
+          # search at scale.
+          class Service
+
+            include ::GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.cloud.aiplatform.v1.MatchService'
+
+            # Finds the nearest neighbors of each vector within the request.
+            rpc :FindNeighbors, ::Google::Cloud::AIPlatform::V1::FindNeighborsRequest, ::Google::Cloud::AIPlatform::V1::FindNeighborsResponse
+            # Reads the datapoints/vectors of the given IDs.
+            # A maximum of 1000 datapoints can be retrieved in a batch.
+            rpc :ReadIndexDatapoints, ::Google::Cloud::AIPlatform::V1::ReadIndexDatapointsRequest, ::Google::Cloud::AIPlatform::V1::ReadIndexDatapointsResponse
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/aiplatform/v1/explanation.rb

@@ -245,6 +245,10 @@ module Google
         #     house or an animal. If the images are taken in artificial environments,
         #     like a lab or manufacturing line, or from diagnostic equipment, like
         #     x-rays or quality-control cameras, use Integrated Gradients instead.
+        # @!attribute [rw] examples
+        #   @return [::Google::Cloud::AIPlatform::V1::Examples]
+        #     Example-based explanations that returns the nearest neighbors from the
+        #     provided dataset.
         # @!attribute [rw] top_k
         #   @return [::Integer]
         #     If populated, returns attributions for top K indices of outputs
@@ -437,6 +441,91 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Example-based explainability that returns the nearest neighbors from the
+        # provided dataset.
+        # @!attribute [rw] example_gcs_source
+        #   @return [::Google::Cloud::AIPlatform::V1::Examples::ExampleGcsSource]
+        #     The Cloud Storage input instances.
+        # @!attribute [rw] nearest_neighbor_search_config
+        #   @return [::Google::Protobuf::Value]
+        #     The full configuration for the generated index, the semantics are the
+        #     same as {::Google::Cloud::AIPlatform::V1::Index#metadata metadata} and should
+        #     match
+        #     [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
+        # @!attribute [rw] presets
+        #   @return [::Google::Cloud::AIPlatform::V1::Presets]
+        #     Simplified preset configuration, which automatically sets configuration
+        #     values based on the desired query speed-precision trade-off and modality.
+        # @!attribute [rw] neighbor_count
+        #   @return [::Integer]
+        #     The number of neighbors to return when querying for examples.
+        class Examples
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The Cloud Storage input instances.
+          # @!attribute [rw] data_format
+          #   @return [::Google::Cloud::AIPlatform::V1::Examples::ExampleGcsSource::DataFormat]
+          #     The format in which instances are given, if not specified, assume it's
+          #     JSONL format. Currently only JSONL format is supported.
+          # @!attribute [rw] gcs_source
+          #   @return [::Google::Cloud::AIPlatform::V1::GcsSource]
+          #     The Cloud Storage location for the input instances.
+          class ExampleGcsSource
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The format of the input example instances.
+            module DataFormat
+              # Format unspecified, used when unset.
+              DATA_FORMAT_UNSPECIFIED = 0
+
+              # Examples are stored in JSONL files.
+              JSONL = 1
+            end
+          end
+        end
+
+        # Preset configuration for example-based explanations
+        # @!attribute [rw] query
+        #   @return [::Google::Cloud::AIPlatform::V1::Presets::Query]
+        #     Preset option controlling parameters for speed-precision trade-off when
+        #     querying for examples. If omitted, defaults to `PRECISE`.
+        # @!attribute [rw] modality
+        #   @return [::Google::Cloud::AIPlatform::V1::Presets::Modality]
+        #     The modality of the uploaded model, which automatically configures the
+        #     distance measurement and feature normalization for the underlying example
+        #     index and queries. If your model does not precisely fit one of these types,
+        #     it is okay to choose the closest type.
+        class Presets
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Preset option controlling parameters for query speed-precision trade-off
+          module Query
+            # More precise neighbors as a trade-off against slower response.
+            PRECISE = 0
+
+            # Faster response as a trade-off against less precise neighbors.
+            FAST = 1
+          end
+
+          # Preset option controlling parameters for different modalities
+          module Modality
+            # Should not be set. Added as a recommended best practice for enums
+            MODALITY_UNSPECIFIED = 0
+
+            # IMAGE modality
+            IMAGE = 1
+
+            # TEXT modality
+            TEXT = 2
+
+            # TABULAR modality
+            TABULAR = 3
+          end
+        end
+
         # The {::Google::Cloud::AIPlatform::V1::ExplanationSpec ExplanationSpec} entries
         # that can be overridden at [online
         # explanation][google.cloud.aiplatform.v1.PredictionService.Explain] time.

data/proto_docs/google/cloud/aiplatform/v1/match_service.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        # The request message for
+        # {::Google::Cloud::AIPlatform::V1::MatchService::Client#find_neighbors MatchService.FindNeighbors}.
+        # @!attribute [rw] index_endpoint
+        #   @return [::String]
+        #     Required. The name of the index endpoint.
+        #     Format:
+        #     `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
+        # @!attribute [rw] deployed_index_id
+        #   @return [::String]
+        #     The ID of the DeployedIndex that will serve the request. This request is
+        #     sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That
+        #     IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index
+        #     has a DeployedIndex.id field.
+        #     The value of the field below must equal one of the DeployedIndex.id
+        #     fields of the IndexEndpoint that is being called for this request.
+        # @!attribute [rw] queries
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::FindNeighborsRequest::Query>]
+        #     The list of queries.
+        # @!attribute [rw] return_full_datapoint
+        #   @return [::Boolean]
+        #     If set to true, the full datapoints (including all vector values and
+        #     restricts) of the nearest neighbors are returned.
+        #     Note that returning full datapoint will significantly increase the
+        #     latency and cost of the query.
+        class FindNeighborsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # A query to find a number of the nearest neighbors (most similar vectors)
+          # of a vector.
+          # @!attribute [rw] datapoint
+          #   @return [::Google::Cloud::AIPlatform::V1::IndexDatapoint]
+          #     Required. The datapoint/vector whose nearest neighbors should be searched
+          #     for.
+          # @!attribute [rw] neighbor_count
+          #   @return [::Integer]
+          #     The number of nearest neighbors to be retrieved from database for each
+          #     query. If not set, will use the default from the service configuration
+          #     (https://cloud.google.com/vertex-ai/docs/matching-engine/configuring-indexes#nearest-neighbor-search-config).
+          # @!attribute [rw] per_crowding_attribute_neighbor_count
+          #   @return [::Integer]
+          #     Crowding is a constraint on a neighbor list produced by nearest neighbor
+          #     search requiring that no more than some value k' of the k neighbors
+          #     returned have the same value of crowding_attribute.
+          #     It's used for improving result diversity.
+          #     This field is the maximum number of matches with the same crowding tag.
+          # @!attribute [rw] approximate_neighbor_count
+          #   @return [::Integer]
+          #     The number of neighbors to find via approximate search before
+          #     exact reordering is performed. If not set, the default value from scam
+          #     config is used; if set, this value must be > 0.
+          # @!attribute [rw] fraction_leaf_nodes_to_search_override
+          #   @return [::Float]
+          #     The fraction of the number of leaves to search, set at query time allows
+          #     user to tune search performance. This value increase result in both
+          #     search accuracy and latency increase. The value should be between 0.0
+          #     and 1.0. If not set or set to 0.0, query uses the default value specified
+          #     in
+          #     NearestNeighborSearchConfig.TreeAHConfig.fraction_leaf_nodes_to_search.
+          class Query
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # The response message for
+        # {::Google::Cloud::AIPlatform::V1::MatchService::Client#find_neighbors MatchService.FindNeighbors}.
+        # @!attribute [rw] nearest_neighbors
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::FindNeighborsResponse::NearestNeighbors>]
+        #     The nearest neighbors of the query datapoints.
+        class FindNeighborsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # A neighbor of the query vector.
+          # @!attribute [rw] datapoint
+          #   @return [::Google::Cloud::AIPlatform::V1::IndexDatapoint]
+          #     The datapoint of the neighbor.
+          #     Note that full datapoints are returned only when "return_full_datapoint"
+          #     is set to true. Otherwise, only the "datapoint_id" and "crowding_tag"
+          #     fields are populated.
+          # @!attribute [rw] distance
+          #   @return [::Float]
+          #     The distance between the neighbor and the query vector.
+          class Neighbor
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Nearest neighbors for one query.
+          # @!attribute [rw] id
+          #   @return [::String]
+          #     The ID of the query datapoint.
+          # @!attribute [rw] neighbors
+          #   @return [::Array<::Google::Cloud::AIPlatform::V1::FindNeighborsResponse::Neighbor>]
+          #     All its neighbors.
+          class NearestNeighbors
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # The request message for
+        # {::Google::Cloud::AIPlatform::V1::MatchService::Client#read_index_datapoints MatchService.ReadIndexDatapoints}.
+        # @!attribute [rw] index_endpoint
+        #   @return [::String]
+        #     Required. The name of the index endpoint.
+        #     Format:
+        #     `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
+        # @!attribute [rw] deployed_index_id
+        #   @return [::String]
+        #     The ID of the DeployedIndex that will serve the request.
+        # @!attribute [rw] ids
+        #   @return [::Array<::String>]
+        #     IDs of the datapoints to be searched for.
+        class ReadIndexDatapointsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response message for
+        # {::Google::Cloud::AIPlatform::V1::MatchService::Client#read_index_datapoints MatchService.ReadIndexDatapoints}.
+        # @!attribute [rw] datapoints
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::IndexDatapoint>]
+        #     The result list of datapoints.
+        class ReadIndexDatapointsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-ai_platform-v1
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.24.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-04 00:00:00.000000000 Z
+date: 2023-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -246,6 +246,10 @@ files:
 - lib/google/cloud/ai_platform/v1/job_service/credentials.rb
 - lib/google/cloud/ai_platform/v1/job_service/operations.rb
 - lib/google/cloud/ai_platform/v1/job_service/paths.rb
+- lib/google/cloud/ai_platform/v1/match_service.rb
+- lib/google/cloud/ai_platform/v1/match_service/client.rb
+- lib/google/cloud/ai_platform/v1/match_service/credentials.rb
+- lib/google/cloud/ai_platform/v1/match_service/paths.rb
 - lib/google/cloud/ai_platform/v1/metadata_service.rb
 - lib/google/cloud/ai_platform/v1/metadata_service/client.rb
 - lib/google/cloud/ai_platform/v1/metadata_service/credentials.rb
@@ -335,6 +339,8 @@ files:
 - lib/google/cloud/aiplatform/v1/lineage_subgraph_pb.rb
 - lib/google/cloud/aiplatform/v1/machine_resources_pb.rb
 - lib/google/cloud/aiplatform/v1/manual_batch_tuning_parameters_pb.rb
+- lib/google/cloud/aiplatform/v1/match_service_pb.rb
+- lib/google/cloud/aiplatform/v1/match_service_services_pb.rb
 - lib/google/cloud/aiplatform/v1/metadata_schema_pb.rb
 - lib/google/cloud/aiplatform/v1/metadata_service_pb.rb
 - lib/google/cloud/aiplatform/v1/metadata_service_services_pb.rb
@@ -426,6 +432,7 @@ files:
 - proto_docs/google/cloud/aiplatform/v1/lineage_subgraph.rb
 - proto_docs/google/cloud/aiplatform/v1/machine_resources.rb
 - proto_docs/google/cloud/aiplatform/v1/manual_batch_tuning_parameters.rb
+- proto_docs/google/cloud/aiplatform/v1/match_service.rb
 - proto_docs/google/cloud/aiplatform/v1/metadata_schema.rb
 - proto_docs/google/cloud/aiplatform/v1/metadata_service.rb
 - proto_docs/google/cloud/aiplatform/v1/metadata_store.rb