Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::MatchService::Client (v0.61.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::MatchService::Client.

Client for the MatchService service.

MatchService is a Google managed service for efficient vector similarity search at scale.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the MatchService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all MatchService clients
::Google::Cloud::AIPlatform::V1::MatchService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

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 Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#find_neighbors

def find_neighbors(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::FindNeighborsResponse
def find_neighbors(index_endpoint: nil, deployed_index_id: nil, queries: nil, return_full_datapoint: nil) -> ::Google::Cloud::AIPlatform::V1::FindNeighborsResponse

Finds the nearest neighbors of each vector within the request.

Overloads 
def find_neighbors(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::FindNeighborsResponse
Pass arguments to find_neighbors via a request object, either of type FindNeighborsRequest or an equivalent Hash.
Parameters
  • 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.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def find_neighbors(index_endpoint: nil, deployed_index_id: nil, queries: nil, return_full_datapoint: nil) -> ::Google::Cloud::AIPlatform::V1::FindNeighborsResponse
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).
Parameters
  • index_endpoint (::String) — Required. The name of the index endpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
  • 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.
  • queries (::Array<::Google::Cloud::AIPlatform::V1::FindNeighborsRequest::Query, ::Hash>) — The list of queries.
  • 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.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::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

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client

Get the associated client for mix-in of the IAMPolicy.

Returns
  • (Google::Iam::V1::IAMPolicy::Client)

#initialize

def initialize() { |config| ... } -> Client

Create a new MatchService client object.

Yields
  • (config) — Configure the MatchService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
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

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Client)

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#read_index_datapoints

def read_index_datapoints(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::ReadIndexDatapointsResponse
def read_index_datapoints(index_endpoint: nil, deployed_index_id: nil, ids: nil) -> ::Google::Cloud::AIPlatform::V1::ReadIndexDatapointsResponse

Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch.

Overloads 
def read_index_datapoints(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::ReadIndexDatapointsResponse
Pass arguments to read_index_datapoints via a request object, either of type ReadIndexDatapointsRequest or an equivalent Hash.
Parameters
  • 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.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def read_index_datapoints(index_endpoint: nil, deployed_index_id: nil, ids: nil) -> ::Google::Cloud::AIPlatform::V1::ReadIndexDatapointsResponse
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).
Parameters
  • index_endpoint (::String) — Required. The name of the index endpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
  • deployed_index_id (::String) — The ID of the DeployedIndex that will serve the request.
  • ids (::Array<::String>) — IDs of the datapoints to be searched for.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::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

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)