Vertex AI v1beta1 API - Class EvaluationServiceClient (1.0.0-beta16)

public abstract class EvaluationServiceClient

Reference documentation and code samples for the Vertex AI v1beta1 API class EvaluationServiceClient.

EvaluationService client wrapper, for convenient use.

Inheritance

object > EvaluationServiceClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

EvaluationServiceClientImpl

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.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:

https://www.googleapis.com/auth/cloud-platform

EvaluateDatasetOperationsClient

public virtual OperationsClient EvaluateDatasetOperationsClient { get; }

The long-running operations client for EvaluateDataset.

Property Value
Type	Description
`OperationsClient`

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.

EvaluateDataset(EvaluateDatasetRequest, CallSettings)

public virtual Operation<EvaluateDatasetResponse, EvaluateDatasetOperationMetadata> EvaluateDataset(EvaluateDatasetRequest request, CallSettings callSettings = null)

Evaluates a dataset based on a set of given metrics.

Parameters
Name	Description
`request`	`EvaluateDatasetRequest` 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
`OperationEvaluateDatasetResponseEvaluateDatasetOperationMetadata`	The RPC response.

Example

// Create client
EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.Create();
// Initialize request argument(s)
EvaluateDatasetRequest request = new EvaluateDatasetRequest
{
    LocationAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Dataset = new EvaluationDataset(),
    Metrics = { new Metric(), },
    OutputConfig = new OutputConfig(),
    AutoraterConfig = new AutoraterConfig(),
};
// Make the request
Operation<EvaluateDatasetResponse, EvaluateDatasetOperationMetadata> response = evaluationServiceClient.EvaluateDataset(request);

// Poll until the returned long-running operation is complete
Operation<EvaluateDatasetResponse, EvaluateDatasetOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
EvaluateDatasetResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<EvaluateDatasetResponse, EvaluateDatasetOperationMetadata> retrievedResponse = evaluationServiceClient.PollOnceEvaluateDataset(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    EvaluateDatasetResponse retrievedResult = retrievedResponse.Result;
}

EvaluateDatasetAsync(EvaluateDatasetRequest, CallSettings)

public virtual Task<Operation<EvaluateDatasetResponse, EvaluateDatasetOperationMetadata>> EvaluateDatasetAsync(EvaluateDatasetRequest request, CallSettings callSettings = null)

Evaluates a dataset based on a set of given metrics.

Parameters
Name	Description
`request`	`EvaluateDatasetRequest` 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
`TaskOperationEvaluateDatasetResponseEvaluateDatasetOperationMetadata`	A Task containing the RPC response.

Example

// Create client
EvaluationServiceClient evaluationServiceClient = await EvaluationServiceClient.CreateAsync();
// Initialize request argument(s)
EvaluateDatasetRequest request = new EvaluateDatasetRequest
{
    LocationAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Dataset = new EvaluationDataset(),
    Metrics = { new Metric(), },
    OutputConfig = new OutputConfig(),
    AutoraterConfig = new AutoraterConfig(),
};
// Make the request
Operation<EvaluateDatasetResponse, EvaluateDatasetOperationMetadata> response = await evaluationServiceClient.EvaluateDatasetAsync(request);

// Poll until the returned long-running operation is complete
Operation<EvaluateDatasetResponse, EvaluateDatasetOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
EvaluateDatasetResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<EvaluateDatasetResponse, EvaluateDatasetOperationMetadata> retrievedResponse = await evaluationServiceClient.PollOnceEvaluateDatasetAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    EvaluateDatasetResponse retrievedResult = retrievedResponse.Result;
}

EvaluateDatasetAsync(EvaluateDatasetRequest, CancellationToken)

public virtual Task<Operation<EvaluateDatasetResponse, EvaluateDatasetOperationMetadata>> EvaluateDatasetAsync(EvaluateDatasetRequest request, CancellationToken cancellationToken)

Evaluates a dataset based on a set of given metrics.

Parameters
Name	Description
`request`	`EvaluateDatasetRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`TaskOperationEvaluateDatasetResponseEvaluateDatasetOperationMetadata`	A Task containing the RPC response.

Example

// Create client
EvaluationServiceClient evaluationServiceClient = await EvaluationServiceClient.CreateAsync();
// Initialize request argument(s)
EvaluateDatasetRequest request = new EvaluateDatasetRequest
{
    LocationAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Dataset = new EvaluationDataset(),
    Metrics = { new Metric(), },
    OutputConfig = new OutputConfig(),
    AutoraterConfig = new AutoraterConfig(),
};
// Make the request
Operation<EvaluateDatasetResponse, EvaluateDatasetOperationMetadata> response = await evaluationServiceClient.EvaluateDatasetAsync(request);

// Poll until the returned long-running operation is complete
Operation<EvaluateDatasetResponse, EvaluateDatasetOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
EvaluateDatasetResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<EvaluateDatasetResponse, EvaluateDatasetOperationMetadata> retrievedResponse = await evaluationServiceClient.PollOnceEvaluateDatasetAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    EvaluateDatasetResponse retrievedResult = retrievedResponse.Result;
}

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(),
    AutoraterConfig = new AutoraterConfig(),
};
// 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(),
    AutoraterConfig = new AutoraterConfig(),
};
// 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(),
    AutoraterConfig = new AutoraterConfig(),
};
// Make the request
EvaluateInstancesResponse response = await evaluationServiceClient.EvaluateInstancesAsync(request);

PollOnceEvaluateDataset(string, CallSettings)

public virtual Operation<EvaluateDatasetResponse, EvaluateDatasetOperationMetadata> PollOnceEvaluateDataset(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of EvaluateDataset.

Parameters
Name	Description
`operationName`	`string` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationEvaluateDatasetResponseEvaluateDatasetOperationMetadata`	The result of polling the operation.

PollOnceEvaluateDatasetAsync(string, CallSettings)

public virtual Task<Operation<EvaluateDatasetResponse, EvaluateDatasetOperationMetadata>> PollOnceEvaluateDatasetAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of EvaluateDataset.

Parameters
Name	Description
`operationName`	`string` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationEvaluateDatasetResponseEvaluateDatasetOperationMetadata`	A task representing the result of polling the operation.

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.