Class PredictionServiceClientImpl (3.0.0)

Version 3.0.0

• 3.3.0 (latest)
• 3.2.0
• 3.1.0
• 3.0.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0

public sealed class PredictionServiceClientImpl : PredictionServiceClient

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, ExamplePayload, IDictionary<String, String>, CallSettings)

PredictionServiceClient.PredictAsync(String, ExamplePayload, IDictionary<String, String>, CallSettings)

PredictionServiceClient.PredictAsync(String, ExamplePayload, IDictionary<String, String>, CancellationToken)

PredictionServiceClient.Predict(ModelName, ExamplePayload, IDictionary<String, String>, CallSettings)

PredictionServiceClient.PredictAsync(ModelName, ExamplePayload, IDictionary<String, String>, CallSettings)

PredictionServiceClient.PredictAsync(ModelName, ExamplePayload, IDictionary<String, String>, CancellationToken)

PredictionServiceClient.BatchPredictAsync(BatchPredictRequest, CancellationToken)

PredictionServiceClient.PollOnceBatchPredict(String, CallSettings)

PredictionServiceClient.PollOnceBatchPredictAsync(String, CallSettings)

PredictionServiceClient.BatchPredict(String, BatchPredictInputConfig, BatchPredictOutputConfig, IDictionary<String, String>, CallSettings)

PredictionServiceClient.BatchPredictAsync(String, BatchPredictInputConfig, BatchPredictOutputConfig, IDictionary<String, String>, CallSettings)

PredictionServiceClient.BatchPredictAsync(String, BatchPredictInputConfig, BatchPredictOutputConfig, IDictionary<String, String>, CancellationToken)

PredictionServiceClient.BatchPredict(ModelName, BatchPredictInputConfig, BatchPredictOutputConfig, IDictionary<String, String>, CallSettings)

PredictionServiceClient.BatchPredictAsync(ModelName, BatchPredictInputConfig, BatchPredictOutputConfig, IDictionary<String, String>, CallSettings)

PredictionServiceClient.BatchPredictAsync(ModelName, BatchPredictInputConfig, BatchPredictOutputConfig, IDictionary<String, String>, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.AutoML.V1

Assembly

Google.Cloud.AutoML.V1.dll

Remarks

AutoML Prediction API.

On any input that is documented to expect a string parameter in snake_case or dash-case, either of those cases is accepted.

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

BatchPredictOperationsClient

public override OperationsClient BatchPredictOperationsClient { get; }

The long-running operations client for BatchPredict.

Property Value
Type	Description
OperationsClient

Overrides

PredictionServiceClient.BatchPredictOperationsClient

GrpcClient

public override PredictionService.PredictionServiceClient GrpcClient { get; }

The underlying gRPC PredictionService client

Property Value
Type	Description
PredictionService.PredictionServiceClient

Overrides

PredictionServiceClient.GrpcClient

Methods

BatchPredict(BatchPredictRequest, CallSettings)

public override Operation<BatchPredictResult, OperationMetadata> BatchPredict(BatchPredictRequest request, CallSettings callSettings = null)

Perform a batch prediction. Unlike the online [Predict][google.cloud.automl.v1.PredictionService.Predict], batch prediction result won't be immediately available in the response. Instead, a long running operation object is returned. User can poll the operation result via [GetOperation][google.longrunning.Operations.GetOperation] method. Once the operation is done, [BatchPredictResult][google.cloud.automl.v1.BatchPredictResult] is returned in the [response][google.longrunning.Operation.response] field. Available for following ML scenarios:

• AutoML Vision Classification
• AutoML Vision Object Detection
• AutoML Video Intelligence Classification
• AutoML Video Intelligence Object Tracking * AutoML Natural Language Classification
• AutoML Natural Language Entity Extraction
• AutoML Natural Language Sentiment Analysis
• AutoML Tables

Parameters
Name	Description
request	BatchPredictRequest 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
Operation<BatchPredictResult, OperationMetadata>	The RPC response.

Overrides

PredictionServiceClient.BatchPredict(BatchPredictRequest, CallSettings)

BatchPredictAsync(BatchPredictRequest, CallSettings)

public override async Task<Operation<BatchPredictResult, OperationMetadata>> BatchPredictAsync(BatchPredictRequest request, CallSettings callSettings = null)

Perform a batch prediction. Unlike the online [Predict][google.cloud.automl.v1.PredictionService.Predict], batch prediction result won't be immediately available in the response. Instead, a long running operation object is returned. User can poll the operation result via [GetOperation][google.longrunning.Operations.GetOperation] method. Once the operation is done, [BatchPredictResult][google.cloud.automl.v1.BatchPredictResult] is returned in the [response][google.longrunning.Operation.response] field. Available for following ML scenarios:

• AutoML Vision Classification
• AutoML Vision Object Detection
• AutoML Video Intelligence Classification
• AutoML Video Intelligence Object Tracking * AutoML Natural Language Classification
• AutoML Natural Language Entity Extraction
• AutoML Natural Language Sentiment Analysis
• AutoML Tables

Parameters
Name	Description
request	BatchPredictRequest 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<Operation<BatchPredictResult, OperationMetadata>>	A Task containing the RPC response.

Overrides

PredictionServiceClient.BatchPredictAsync(BatchPredictRequest, CallSettings)

Predict(PredictRequest, CallSettings)

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

Perform an online prediction. The prediction result is directly returned in the response. Available for following ML scenarios, and their expected request payloads:

AutoML Vision Classification

• An image in .JPEG, .GIF or .PNG format, image_bytes up to 30MB.

AutoML Vision Object Detection

• An image in .JPEG, .GIF or .PNG format, image_bytes up to 30MB.

AutoML Natural Language Classification

• A TextSnippet up to 60,000 characters, UTF-8 encoded or a document in .PDF, .TIF or .TIFF format with size upto 2MB.

AutoML Natural Language Entity Extraction

• A TextSnippet up to 10,000 characters, UTF-8 NFC encoded or a document in .PDF, .TIF or .TIFF format with size upto 20MB.

AutoML Natural Language Sentiment Analysis

• A TextSnippet up to 60,000 characters, UTF-8 encoded or a document in .PDF, .TIF or .TIFF format with size upto 2MB.

AutoML Translation

• A TextSnippet up to 25,000 characters, UTF-8 encoded.

AutoML Tables

• A row with column values matching the columns of the model, up to 5MB. Not available for FORECASTING prediction_type.

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. The prediction result is directly returned in the response. Available for following ML scenarios, and their expected request payloads:

AutoML Vision Classification

• An image in .JPEG, .GIF or .PNG format, image_bytes up to 30MB.

AutoML Vision Object Detection

• An image in .JPEG, .GIF or .PNG format, image_bytes up to 30MB.

AutoML Natural Language Classification

• A TextSnippet up to 60,000 characters, UTF-8 encoded or a document in .PDF, .TIF or .TIFF format with size upto 2MB.

AutoML Natural Language Entity Extraction

• A TextSnippet up to 10,000 characters, UTF-8 NFC encoded or a document in .PDF, .TIF or .TIFF format with size upto 20MB.

AutoML Natural Language Sentiment Analysis

• A TextSnippet up to 60,000 characters, UTF-8 encoded or a document in .PDF, .TIF or .TIFF format with size upto 2MB.

AutoML Translation

• A TextSnippet up to 25,000 characters, UTF-8 encoded.

AutoML Tables

• A row with column values matching the columns of the model, up to 5MB. Not available for FORECASTING prediction_type.

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)