Cloud AI Platform v1 API - Class MatchServiceClientImpl (2.24.0)

public sealed class MatchServiceClientImpl : MatchServiceClient

Reference documentation and code samples for the Cloud AI Platform v1 API class MatchServiceClientImpl.

MatchService client wrapper implementation, for convenient use.

Inheritance

object > MatchServiceClient > MatchServiceClientImpl

Inherited Members

MatchServiceClient.DefaultEndpoint

MatchServiceClient.DefaultScopes

MatchServiceClient.ServiceMetadata

MatchServiceClient.CreateAsync(CancellationToken)

MatchServiceClient.Create()

MatchServiceClient.ShutdownDefaultChannelsAsync()

MatchServiceClient.FindNeighborsAsync(FindNeighborsRequest, CancellationToken)

MatchServiceClient.ReadIndexDatapointsAsync(ReadIndexDatapointsRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

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.

Constructors

MatchServiceClientImpl(MatchServiceClient, MatchServiceSettings, ILogger)

public MatchServiceClientImpl(MatchService.MatchServiceClient grpcClient, MatchServiceSettings settings, ILogger logger)

Constructs a client wrapper for the MatchService service, with the specified gRPC client and settings.

Parameters
Name	Description
`grpcClient`	`MatchServiceMatchServiceClient` The underlying gRPC client.
`settings`	`MatchServiceSettings` The base MatchServiceSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

GrpcClient

public override MatchService.MatchServiceClient GrpcClient { get; }

The underlying gRPC MatchService client

Property Value
Type	Description
`MatchServiceMatchServiceClient`

Overrides

MatchServiceClient.GrpcClient

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type	Description
`IAMPolicyClient`

Overrides

MatchServiceClient.IAMPolicyClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
`LocationsClient`

Overrides

MatchServiceClient.LocationsClient

Methods

FindNeighbors(FindNeighborsRequest, CallSettings)

public override 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.

Overrides

MatchServiceClient.FindNeighbors(FindNeighborsRequest, CallSettings)

FindNeighborsAsync(FindNeighborsRequest, CallSettings)

public override 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.

Overrides

MatchServiceClient.FindNeighborsAsync(FindNeighborsRequest, CallSettings)

ReadIndexDatapoints(ReadIndexDatapointsRequest, CallSettings)

public override 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.

Overrides

MatchServiceClient.ReadIndexDatapoints(ReadIndexDatapointsRequest, CallSettings)

ReadIndexDatapointsAsync(ReadIndexDatapointsRequest, CallSettings)

public override 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.

Overrides

MatchServiceClient.ReadIndexDatapointsAsync(ReadIndexDatapointsRequest, CallSettings)