Vertex AI v1 API - Class MatchServiceClient (3.50.0) 

public abstract class MatchServiceClient

Reference documentation and code samples for the Vertex AI v1 API class MatchServiceClient.

MatchService client wrapper, for convenient use.

Inheritance

object > MatchServiceClient

Derived Types

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Remarks

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

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the MatchService service, which is a host of "aiplatform.googleapis.com" and a port of 443.

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default MatchService scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default MatchService scopes are:

GrpcClient

public virtual MatchService.MatchServiceClient GrpcClient { get; }

The underlying gRPC MatchService client

Property Value
Type Description
MatchServiceMatchServiceClient

IAMPolicyClient

public virtual IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

Methods

Create()

public static MatchServiceClient Create()

Synchronously creates a MatchServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use MatchServiceClientBuilder.

Returns
Type Description
MatchServiceClient

The created MatchServiceClient.

CreateAsync(CancellationToken)

public static Task<MatchServiceClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a MatchServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use MatchServiceClientBuilder.

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.
Returns
Type Description
TaskMatchServiceClient

The task representing the created MatchServiceClient.

FindNeighbors(FindNeighborsRequest, CallSettings)

public virtual FindNeighborsResponse FindNeighbors(FindNeighborsRequest request, CallSettings callSettings = null)

Finds the nearest neighbors of each vector within the request.

Parameters
Name Description
request FindNeighborsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
FindNeighborsResponse

The RPC response.
Example 
// Create client
MatchServiceClient matchServiceClient = MatchServiceClient.Create();
// Initialize request argument(s)
FindNeighborsRequest request = new FindNeighborsRequest
{
    IndexEndpointAsIndexEndpointName = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]"),
    DeployedIndexId = "",
    Queries =
    {
        new FindNeighborsRequest.Types.Query(),
    },
    ReturnFullDatapoint = false,
};
// Make the request
FindNeighborsResponse response = matchServiceClient.FindNeighbors(request);

FindNeighborsAsync(FindNeighborsRequest, CallSettings)

public virtual Task<FindNeighborsResponse> FindNeighborsAsync(FindNeighborsRequest request, CallSettings callSettings = null)

Finds the nearest neighbors of each vector within the request.

Parameters
Name Description
request FindNeighborsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskFindNeighborsResponse

A Task containing the RPC response.
Example 
// Create client
MatchServiceClient matchServiceClient = await MatchServiceClient.CreateAsync();
// Initialize request argument(s)
FindNeighborsRequest request = new FindNeighborsRequest
{
    IndexEndpointAsIndexEndpointName = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]"),
    DeployedIndexId = "",
    Queries =
    {
        new FindNeighborsRequest.Types.Query(),
    },
    ReturnFullDatapoint = false,
};
// Make the request
FindNeighborsResponse response = await matchServiceClient.FindNeighborsAsync(request);

FindNeighborsAsync(FindNeighborsRequest, CancellationToken)

public virtual Task<FindNeighborsResponse> FindNeighborsAsync(FindNeighborsRequest request, CancellationToken cancellationToken)

Finds the nearest neighbors of each vector within the request.

Parameters
Name Description
request FindNeighborsRequest

The request object containing all of the parameters for the API call.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskFindNeighborsResponse

A Task containing the RPC response.
Example 
// Create client
MatchServiceClient matchServiceClient = await MatchServiceClient.CreateAsync();
// Initialize request argument(s)
FindNeighborsRequest request = new FindNeighborsRequest
{
    IndexEndpointAsIndexEndpointName = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]"),
    DeployedIndexId = "",
    Queries =
    {
        new FindNeighborsRequest.Types.Query(),
    },
    ReturnFullDatapoint = false,
};
// Make the request
FindNeighborsResponse response = await matchServiceClient.FindNeighborsAsync(request);

ReadIndexDatapoints(ReadIndexDatapointsRequest, CallSettings)

public virtual ReadIndexDatapointsResponse ReadIndexDatapoints(ReadIndexDatapointsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ReadIndexDatapointsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ReadIndexDatapointsResponse

The RPC response.
Example 
// Create client
MatchServiceClient matchServiceClient = MatchServiceClient.Create();
// Initialize request argument(s)
ReadIndexDatapointsRequest request = new ReadIndexDatapointsRequest
{
    IndexEndpointAsIndexEndpointName = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]"),
    DeployedIndexId = "",
    Ids = { "", },
};
// Make the request
ReadIndexDatapointsResponse response = matchServiceClient.ReadIndexDatapoints(request);

ReadIndexDatapointsAsync(ReadIndexDatapointsRequest, CallSettings)

public virtual Task<ReadIndexDatapointsResponse> ReadIndexDatapointsAsync(ReadIndexDatapointsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ReadIndexDatapointsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskReadIndexDatapointsResponse

A Task containing the RPC response.
Example 
// Create client
MatchServiceClient matchServiceClient = await MatchServiceClient.CreateAsync();
// Initialize request argument(s)
ReadIndexDatapointsRequest request = new ReadIndexDatapointsRequest
{
    IndexEndpointAsIndexEndpointName = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]"),
    DeployedIndexId = "",
    Ids = { "", },
};
// Make the request
ReadIndexDatapointsResponse response = await matchServiceClient.ReadIndexDatapointsAsync(request);

ReadIndexDatapointsAsync(ReadIndexDatapointsRequest, CancellationToken)

public virtual Task<ReadIndexDatapointsResponse> ReadIndexDatapointsAsync(ReadIndexDatapointsRequest request, CancellationToken cancellationToken)

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

Parameters
Name Description
request ReadIndexDatapointsRequest

The request object containing all of the parameters for the API call.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskReadIndexDatapointsResponse

A Task containing the RPC response.
Example 
// Create client
MatchServiceClient matchServiceClient = await MatchServiceClient.CreateAsync();
// Initialize request argument(s)
ReadIndexDatapointsRequest request = new ReadIndexDatapointsRequest
{
    IndexEndpointAsIndexEndpointName = IndexEndpointName.FromProjectLocationIndexEndpoint("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]"),
    DeployedIndexId = "",
    Ids = { "", },
};
// Make the request
ReadIndexDatapointsResponse response = await matchServiceClient.ReadIndexDatapointsAsync(request);

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
Task

A task representing the asynchronous shutdown operation.
Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.