Cloud AI Platform v1 API - Class PredictionServiceClientImpl (2.4.0)

Version 2.4.0

• 3.10.0 (latest)
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class PredictionServiceClientImpl : PredictionServiceClient

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

PredictionService client wrapper implementation, for convenient use.

Inheritance

Object > PredictionServiceClient > PredictionServiceClientImpl

Inherited Members

PredictionServiceClient.DefaultEndpoint

PredictionServiceClient.DefaultScopes

PredictionServiceClient.ServiceMetadata

PredictionServiceClient.CreateAsync(CancellationToken)

PredictionServiceClient.Create()

PredictionServiceClient.ShutdownDefaultChannelsAsync()

PredictionServiceClient.PredictAsync(PredictRequest, CancellationToken)

PredictionServiceClient.Predict(String, IEnumerable<Value>, Value, CallSettings)

PredictionServiceClient.PredictAsync(String, IEnumerable<Value>, Value, CallSettings)

PredictionServiceClient.PredictAsync(String, IEnumerable<Value>, Value, CancellationToken)

PredictionServiceClient.Predict(EndpointName, IEnumerable<Value>, Value, CallSettings)

PredictionServiceClient.PredictAsync(EndpointName, IEnumerable<Value>, Value, CallSettings)

PredictionServiceClient.PredictAsync(EndpointName, IEnumerable<Value>, Value, CancellationToken)

PredictionServiceClient.RawPredictAsync(RawPredictRequest, CancellationToken)

PredictionServiceClient.RawPredict(String, HttpBody, CallSettings)

PredictionServiceClient.RawPredictAsync(String, HttpBody, CallSettings)

PredictionServiceClient.RawPredictAsync(String, HttpBody, CancellationToken)

PredictionServiceClient.RawPredict(EndpointName, HttpBody, CallSettings)

PredictionServiceClient.RawPredictAsync(EndpointName, HttpBody, CallSettings)

PredictionServiceClient.RawPredictAsync(EndpointName, HttpBody, CancellationToken)

PredictionServiceClient.ExplainAsync(ExplainRequest, CancellationToken)

PredictionServiceClient.Explain(String, IEnumerable<Value>, Value, String, CallSettings)

PredictionServiceClient.ExplainAsync(String, IEnumerable<Value>, Value, String, CallSettings)

PredictionServiceClient.ExplainAsync(String, IEnumerable<Value>, Value, String, CancellationToken)

PredictionServiceClient.Explain(EndpointName, IEnumerable<Value>, Value, String, CallSettings)

PredictionServiceClient.ExplainAsync(EndpointName, IEnumerable<Value>, Value, String, CallSettings)

PredictionServiceClient.ExplainAsync(EndpointName, IEnumerable<Value>, Value, String, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Remarks

A service for online predictions and explanations.

Constructors

PredictionServiceClientImpl(PredictionService.PredictionServiceClient, PredictionServiceSettings, ILogger)

public PredictionServiceClientImpl(PredictionService.PredictionServiceClient grpcClient, PredictionServiceSettings settings, ILogger logger)

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

Parameters
Name	Description
grpcClient	PredictionService.PredictionServiceClient The underlying gRPC client.
settings	PredictionServiceSettings The base PredictionServiceSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

GrpcClient

public override PredictionService.PredictionServiceClient GrpcClient { get; }

The underlying gRPC PredictionService client

Property Value
Type	Description
PredictionService.PredictionServiceClient

Overrides

PredictionServiceClient.GrpcClient

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type	Description
IAMPolicyClient

Overrides

PredictionServiceClient.IAMPolicyClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

Overrides

PredictionServiceClient.LocationsClient

Methods

Explain(ExplainRequest, CallSettings)

public override ExplainResponse Explain(ExplainRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ExplainResponse	The RPC response.

Overrides

PredictionServiceClient.Explain(ExplainRequest, CallSettings)

ExplainAsync(ExplainRequest, CallSettings)

public override Task<ExplainResponse> ExplainAsync(ExplainRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<ExplainResponse>	A Task containing the RPC response.

Overrides

PredictionServiceClient.ExplainAsync(ExplainRequest, CallSettings)

Predict(PredictRequest, CallSettings)

public override PredictResponse Predict(PredictRequest request, CallSettings callSettings = null)

Perform an online prediction.

Parameters
Name	Description
request	PredictRequest 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
PredictResponse	The RPC response.

Overrides

PredictionServiceClient.Predict(PredictRequest, CallSettings)

PredictAsync(PredictRequest, CallSettings)

public override Task<PredictResponse> PredictAsync(PredictRequest request, CallSettings callSettings = null)

Perform an online prediction.

Parameters
Name	Description
request	PredictRequest 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
Task<PredictResponse>	A Task containing the RPC response.

Overrides

PredictionServiceClient.PredictAsync(PredictRequest, CallSettings)

RawPredict(RawPredictRequest, CallSettings)

public override HttpBody RawPredict(RawPredictRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
HttpBody	The RPC response.

Overrides

PredictionServiceClient.RawPredict(RawPredictRequest, CallSettings)

RawPredictAsync(RawPredictRequest, CallSettings)

public override Task<HttpBody> RawPredictAsync(RawPredictRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<HttpBody>	A Task containing the RPC response.

Overrides

PredictionServiceClient.RawPredictAsync(RawPredictRequest, CallSettings)