Vertex AI v1beta1 API - Class EvaluationService.EvaluationServiceClient (1.0.0-beta78)

1.0.0-beta78 (latest) 1.0.0-beta77

public class EvaluationService.EvaluationServiceClient : ClientBase<EvaluationService.EvaluationServiceClient>

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

Client for EvaluationService

Inheritance

object > ClientBase > ClientBaseEvaluationServiceEvaluationServiceClient > EvaluationService.EvaluationServiceClient

Inherited Members

ClientBase<EvaluationService.EvaluationServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

EvaluationServiceClient()

protected EvaluationServiceClient()

Protected parameterless constructor to allow creation of test doubles.

EvaluationServiceClient(CallInvoker)

public EvaluationServiceClient(CallInvoker callInvoker)

Creates a new client for EvaluationService that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

EvaluationServiceClient(ChannelBase)

public EvaluationServiceClient(ChannelBase channel)

Creates a new client for EvaluationService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

EvaluationServiceClient(ClientBaseConfiguration)

protected EvaluationServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type	Description
IAMPolicyIAMPolicyClient	A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
LocationsLocationsClient	A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

EvaluateDataset(EvaluateDatasetRequest, CallOptions)

public virtual Operation EvaluateDataset(EvaluateDatasetRequest request, CallOptions options)

Evaluates a dataset based on a set of given metrics.

Parameters
Name	Description
request	EvaluateDatasetRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

EvaluateDataset(EvaluateDatasetRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation EvaluateDataset(EvaluateDatasetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Evaluates a dataset based on a set of given metrics.

Parameters
Name	Description
request	EvaluateDatasetRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

EvaluateDatasetAsync(EvaluateDatasetRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> EvaluateDatasetAsync(EvaluateDatasetRequest request, CallOptions options)

Evaluates a dataset based on a set of given metrics.

Parameters
Name	Description
request	EvaluateDatasetRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

EvaluateDatasetAsync(EvaluateDatasetRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> EvaluateDatasetAsync(EvaluateDatasetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Evaluates a dataset based on a set of given metrics.

Parameters
Name	Description
request	EvaluateDatasetRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

EvaluateInstances(EvaluateInstancesRequest, CallOptions)

public virtual EvaluateInstancesResponse EvaluateInstances(EvaluateInstancesRequest request, CallOptions options)

Evaluates instances based on a given metric.

Parameters
Name	Description
request	EvaluateInstancesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
EvaluateInstancesResponse	The response received from the server.

EvaluateInstances(EvaluateInstancesRequest, Metadata, DateTime?, CancellationToken)

public virtual EvaluateInstancesResponse EvaluateInstances(EvaluateInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Evaluates instances based on a given metric.

Parameters
Name	Description
request	EvaluateInstancesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
EvaluateInstancesResponse	The response received from the server.

EvaluateInstancesAsync(EvaluateInstancesRequest, CallOptions)

public virtual AsyncUnaryCall<EvaluateInstancesResponse> EvaluateInstancesAsync(EvaluateInstancesRequest request, CallOptions options)

Evaluates instances based on a given metric.

Parameters
Name	Description
request	EvaluateInstancesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEvaluateInstancesResponse	The call object.

EvaluateInstancesAsync(EvaluateInstancesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<EvaluateInstancesResponse> EvaluateInstancesAsync(EvaluateInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Evaluates instances based on a given metric.

Parameters
Name	Description
request	EvaluateInstancesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEvaluateInstancesResponse	The call object.

GenerateInstanceRubrics(GenerateInstanceRubricsRequest, CallOptions)

public virtual GenerateInstanceRubricsResponse GenerateInstanceRubrics(GenerateInstanceRubricsRequest request, CallOptions options)

Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations.

Parameters
Name	Description
request	GenerateInstanceRubricsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
GenerateInstanceRubricsResponse	The response received from the server.

GenerateInstanceRubrics(GenerateInstanceRubricsRequest, Metadata, DateTime?, CancellationToken)

public virtual GenerateInstanceRubricsResponse GenerateInstanceRubrics(GenerateInstanceRubricsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations.

Parameters
Name	Description
request	GenerateInstanceRubricsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
GenerateInstanceRubricsResponse	The response received from the server.

GenerateInstanceRubricsAsync(GenerateInstanceRubricsRequest, CallOptions)

public virtual AsyncUnaryCall<GenerateInstanceRubricsResponse> GenerateInstanceRubricsAsync(GenerateInstanceRubricsRequest request, CallOptions options)

Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations.

Parameters
Name	Description
request	GenerateInstanceRubricsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallGenerateInstanceRubricsResponse	The call object.

GenerateInstanceRubricsAsync(GenerateInstanceRubricsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<GenerateInstanceRubricsResponse> GenerateInstanceRubricsAsync(GenerateInstanceRubricsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations.

Parameters
Name	Description
request	GenerateInstanceRubricsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallGenerateInstanceRubricsResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override EvaluationService.EvaluationServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
EvaluationServiceEvaluationServiceClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.AIPlatform.V1Beta1.EvaluationService.EvaluationServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)