Cloud AI Platform v1 API - Class EvaluationServiceClient (3.11.0) 

public abstract class EvaluationServiceClient

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

EvaluationService client wrapper, for convenient use.

Inheritance

object > EvaluationServiceClient

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Remarks

Vertex AI Online Evaluation Service.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the EvaluationService 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 EvaluationService scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default EvaluationService scopes are:

GrpcClient

public virtual EvaluationService.EvaluationServiceClient GrpcClient { get; }

The underlying gRPC EvaluationService client

Property Value
Type Description
EvaluationServiceEvaluationServiceClient

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 EvaluationServiceClient Create()

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

Returns
Type Description
EvaluationServiceClient

The created EvaluationServiceClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name Description
cancellationToken CancellationToken

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

The task representing the created EvaluationServiceClient.

EvaluateInstances(EvaluateInstancesRequest, CallSettings)

public virtual EvaluateInstancesResponse EvaluateInstances(EvaluateInstancesRequest request, CallSettings callSettings = null)

Evaluates instances based on a given metric.

Parameters
Name Description
request EvaluateInstancesRequest

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
EvaluateInstancesResponse

The RPC response.
Example 
// Create client
EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.Create();
// Initialize request argument(s)
EvaluateInstancesRequest request = new EvaluateInstancesRequest
{
    LocationAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    ExactMatchInput = new ExactMatchInput(),
};
// Make the request
EvaluateInstancesResponse response = evaluationServiceClient.EvaluateInstances(request);

EvaluateInstancesAsync(EvaluateInstancesRequest, CallSettings)

public virtual Task<EvaluateInstancesResponse> EvaluateInstancesAsync(EvaluateInstancesRequest request, CallSettings callSettings = null)

Evaluates instances based on a given metric.

Parameters
Name Description
request EvaluateInstancesRequest

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
TaskEvaluateInstancesResponse

A Task containing the RPC response.
Example 
// Create client
EvaluationServiceClient evaluationServiceClient = await EvaluationServiceClient.CreateAsync();
// Initialize request argument(s)
EvaluateInstancesRequest request = new EvaluateInstancesRequest
{
    LocationAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    ExactMatchInput = new ExactMatchInput(),
};
// Make the request
EvaluateInstancesResponse response = await evaluationServiceClient.EvaluateInstancesAsync(request);

EvaluateInstancesAsync(EvaluateInstancesRequest, CancellationToken)

public virtual Task<EvaluateInstancesResponse> EvaluateInstancesAsync(EvaluateInstancesRequest request, CancellationToken cancellationToken)

Evaluates instances based on a given metric.

Parameters
Name Description
request EvaluateInstancesRequest

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

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

A Task containing the RPC response.
Example 
// Create client
EvaluationServiceClient evaluationServiceClient = await EvaluationServiceClient.CreateAsync();
// Initialize request argument(s)
EvaluateInstancesRequest request = new EvaluateInstancesRequest
{
    LocationAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    ExactMatchInput = new ExactMatchInput(),
};
// Make the request
EvaluateInstancesResponse response = await evaluationServiceClient.EvaluateInstancesAsync(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.