Class PredictionService.PredictionServiceClient (1.1.0)

public class PredictionServiceClient : ClientBase<PredictionService.PredictionServiceClient>

Client for PredictionService

Inheritance

Object > ClientBase > ClientBase<PredictionService.PredictionServiceClient> > PredictionService.PredictionServiceClient

Inherited Members

ClientBase<PredictionService.PredictionServiceClient>.WithHost(String)

ClientBase.CallInvoker

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

PredictionServiceClient()

protected PredictionServiceClient()

Protected parameterless constructor to allow creation of test doubles.

PredictionServiceClient(CallInvoker)

public PredictionServiceClient(CallInvoker callInvoker)

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

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

PredictionServiceClient(ChannelBase)

public PredictionServiceClient(ChannelBase channel)

Creates a new client for PredictionService

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

PredictionServiceClient(ClientBase.ClientBaseConfiguration)

protected PredictionServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`ClientBase.ClientBaseConfiguration` The client configuration.

Methods

Explain(ExplainRequest, CallOptions)

public virtual ExplainResponse Explain(ExplainRequest request, CallOptions options)

Perform an online explanation.

If [deployed_model_id][google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id] is specified, the corresponding DeployModel must have [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] populated. If [deployed_model_id][google.cloud.aiplatform.v1.ExplainRequest.deployed_model_id] is not specified, all DeployedModels must have [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] populated. Only deployed AutoML tabular Models have explanation_spec.

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

Returns
Type	Description
`ExplainResponse`	The response received from the server.

Explain(ExplainRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ExplainResponse Explain(ExplainRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Perform an online explanation.

Parameters
Name	Description
`request`	`ExplainRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`ExplainResponse`	The response received from the server.

ExplainAsync(ExplainRequest, CallOptions)

public virtual AsyncUnaryCall<ExplainResponse> ExplainAsync(ExplainRequest request, CallOptions options)

Perform an online explanation.

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

Returns
Type	Description
`AsyncUnaryCall<ExplainResponse>`	The call object.

ExplainAsync(ExplainRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ExplainResponse> ExplainAsync(ExplainRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Perform an online explanation.

Parameters
Name	Description
`request`	`ExplainRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`AsyncUnaryCall<ExplainResponse>`	The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override PredictionService.PredictionServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`ClientBase.ClientBaseConfiguration`

Returns
Type	Description
`PredictionService.PredictionServiceClient`

Overrides

Grpc.Core.ClientBase<Google.Cloud.AIPlatform.V1.PredictionService.PredictionServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

Predict(PredictRequest, CallOptions)

public virtual PredictResponse Predict(PredictRequest request, CallOptions options)

Perform an online prediction.

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

Returns
Type	Description
`PredictResponse`	The response received from the server.

Predict(PredictRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual PredictResponse Predict(PredictRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Perform an online prediction.

Parameters
Name	Description
`request`	`PredictRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`PredictResponse`	The response received from the server.

PredictAsync(PredictRequest, CallOptions)

public virtual AsyncUnaryCall<PredictResponse> PredictAsync(PredictRequest request, CallOptions options)

Perform an online prediction.

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

Returns
Type	Description
`AsyncUnaryCall<PredictResponse>`	The call object.

PredictAsync(PredictRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<PredictResponse> PredictAsync(PredictRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Perform an online prediction.

Parameters
Name	Description
`request`	`PredictRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`AsyncUnaryCall<PredictResponse>`	The call object.

RawPredict(RawPredictRequest, CallOptions)

public virtual HttpBody RawPredict(RawPredictRequest request, CallOptions options)

Perform an online prediction with an arbitrary HTTP payload.

The response includes the following HTTP headers:

X-Vertex-AI-Endpoint-Id: ID of the [Endpoint][google.cloud.aiplatform.v1.Endpoint] that served this prediction.
X-Vertex-AI-Deployed-Model-Id: ID of the Endpoint's [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] that served this prediction.

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

Returns
Type	Description
`HttpBody`	The response received from the server.

RawPredict(RawPredictRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual HttpBody RawPredict(RawPredictRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Perform an online prediction with an arbitrary HTTP payload.

The response includes the following HTTP headers:

X-Vertex-AI-Endpoint-Id: ID of the [Endpoint][google.cloud.aiplatform.v1.Endpoint] that served this prediction.
X-Vertex-AI-Deployed-Model-Id: ID of the Endpoint's [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] that served this prediction.

Parameters
Name	Description
`request`	`RawPredictRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`HttpBody`	The response received from the server.

RawPredictAsync(RawPredictRequest, CallOptions)

public virtual AsyncUnaryCall<HttpBody> RawPredictAsync(RawPredictRequest request, CallOptions options)

Perform an online prediction with an arbitrary HTTP payload.

The response includes the following HTTP headers:

X-Vertex-AI-Endpoint-Id: ID of the [Endpoint][google.cloud.aiplatform.v1.Endpoint] that served this prediction.
X-Vertex-AI-Deployed-Model-Id: ID of the Endpoint's [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] that served this prediction.

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

Returns
Type	Description
`AsyncUnaryCall<HttpBody>`	The call object.

RawPredictAsync(RawPredictRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<HttpBody> RawPredictAsync(RawPredictRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Perform an online prediction with an arbitrary HTTP payload.

The response includes the following HTTP headers:

X-Vertex-AI-Endpoint-Id: ID of the [Endpoint][google.cloud.aiplatform.v1.Endpoint] that served this prediction.
X-Vertex-AI-Deployed-Model-Id: ID of the Endpoint's [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] that served this prediction.

Parameters
Name	Description
`request`	`RawPredictRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`AsyncUnaryCall<HttpBody>`	The call object.