Cloud AI Platform v1beta1 API - Class PredictionServiceClientImpl (1.0.0-beta07)

public sealed class PredictionServiceClientImpl : PredictionServiceClient

Reference documentation and code samples for the Cloud AI Platform v1beta1 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.StreamRawPredict(string, HttpBody, CallSettings)

PredictionServiceClient.StreamRawPredict(EndpointName, HttpBody, CallSettings)

PredictionServiceClient.DirectPredictAsync(DirectPredictRequest, CancellationToken)

PredictionServiceClient.DirectRawPredictAsync(DirectRawPredictRequest, 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)

PredictionServiceClient.CountTokensAsync(CountTokensRequest, CancellationToken)

PredictionServiceClient.CountTokens(string, IEnumerable<Value>, CallSettings)

PredictionServiceClient.CountTokensAsync(string, IEnumerable<Value>, CallSettings)

PredictionServiceClient.CountTokensAsync(string, IEnumerable<Value>, CancellationToken)

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

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

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

PredictionServiceClient.GenerateContentAsync(GenerateContentRequest, CancellationToken)

PredictionServiceClient.GenerateContent(string, IEnumerable<Content>, CallSettings)

PredictionServiceClient.GenerateContentAsync(string, IEnumerable<Content>, CallSettings)

PredictionServiceClient.GenerateContentAsync(string, IEnumerable<Content>, CancellationToken)

PredictionServiceClient.StreamGenerateContent(string, IEnumerable<Content>, CallSettings)

PredictionServiceClient.ChatCompletions(string, HttpBody, CallSettings)

PredictionServiceClient.ChatCompletions(EndpointName, HttpBody, CallSettings)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Remarks

A service for online predictions and explanations.

Constructors

PredictionServiceClientImpl(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`	`PredictionServicePredictionServiceClient` 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
`PredictionServicePredictionServiceClient`

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

ChatCompletions(ChatCompletionsRequest, CallSettings)

public override PredictionServiceClient.ChatCompletionsStream ChatCompletions(ChatCompletionsRequest request, CallSettings callSettings = null)

Exposes an OpenAI-compatible endpoint for chat completions.

Parameters
Name	Description
`request`	`ChatCompletionsRequest` 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
`PredictionServiceClientChatCompletionsStream`	The server stream.

Overrides

PredictionServiceClient.ChatCompletions(ChatCompletionsRequest, CallSettings)

CountTokens(CountTokensRequest, CallSettings)

public override CountTokensResponse CountTokens(CountTokensRequest request, CallSettings callSettings = null)

Perform a token counting.

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

Overrides

PredictionServiceClient.CountTokens(CountTokensRequest, CallSettings)

CountTokensAsync(CountTokensRequest, CallSettings)

public override Task<CountTokensResponse> CountTokensAsync(CountTokensRequest request, CallSettings callSettings = null)

Perform a token counting.

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

Overrides

PredictionServiceClient.CountTokensAsync(CountTokensRequest, CallSettings)

DirectPredict(DirectPredictRequest, CallSettings)

public override DirectPredictResponse DirectPredict(DirectPredictRequest request, CallSettings callSettings = null)

Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks.

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

Overrides

PredictionServiceClient.DirectPredict(DirectPredictRequest, CallSettings)

DirectPredictAsync(DirectPredictRequest, CallSettings)

public override Task<DirectPredictResponse> DirectPredictAsync(DirectPredictRequest request, CallSettings callSettings = null)

Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks.

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

Overrides

PredictionServiceClient.DirectPredictAsync(DirectPredictRequest, CallSettings)

DirectRawPredict(DirectRawPredictRequest, CallSettings)

public override DirectRawPredictResponse DirectRawPredict(DirectRawPredictRequest request, CallSettings callSettings = null)

Perform an unary online prediction request to a gRPC model server for custom containers.

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

Overrides

PredictionServiceClient.DirectRawPredict(DirectRawPredictRequest, CallSettings)

DirectRawPredictAsync(DirectRawPredictRequest, CallSettings)

public override Task<DirectRawPredictResponse> DirectRawPredictAsync(DirectRawPredictRequest request, CallSettings callSettings = null)

Perform an unary online prediction request to a gRPC model server for custom containers.

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

Overrides

PredictionServiceClient.DirectRawPredictAsync(DirectRawPredictRequest, CallSettings)

Explain(ExplainRequest, CallSettings)

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

Perform an online explanation.

If [deployed_model_id][google.cloud.aiplatform.v1beta1.ExplainRequest.deployed_model_id] is specified, the corresponding DeployModel must have [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] populated. If [deployed_model_id][google.cloud.aiplatform.v1beta1.ExplainRequest.deployed_model_id] is not specified, all DeployedModels must have [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] populated.

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.

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
`TaskExplainResponse`	A Task containing the RPC response.

Overrides

PredictionServiceClient.ExplainAsync(ExplainRequest, CallSettings)

GenerateContent(GenerateContentRequest, CallSettings)

public override GenerateContentResponse GenerateContent(GenerateContentRequest request, CallSettings callSettings = null)

Generate content with multimodal inputs.

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

Overrides

PredictionServiceClient.GenerateContent(GenerateContentRequest, CallSettings)

GenerateContentAsync(GenerateContentRequest, CallSettings)

public override Task<GenerateContentResponse> GenerateContentAsync(GenerateContentRequest request, CallSettings callSettings = null)

Generate content with multimodal inputs.

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

Overrides

PredictionServiceClient.GenerateContentAsync(GenerateContentRequest, 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
`TaskPredictResponse`	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.v1beta1.Endpoint] that served this prediction.
X-Vertex-AI-Deployed-Model-Id: ID of the Endpoint's [DeployedModel][google.cloud.aiplatform.v1beta1.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.v1beta1.Endpoint] that served this prediction.
X-Vertex-AI-Deployed-Model-Id: ID of the Endpoint's [DeployedModel][google.cloud.aiplatform.v1beta1.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
`TaskHttpBody`	A Task containing the RPC response.

Overrides

PredictionServiceClient.RawPredictAsync(RawPredictRequest, CallSettings)

ServerStreamingPredict(StreamingPredictRequest, CallSettings)

public override PredictionServiceClient.ServerStreamingPredictStream ServerStreamingPredict(StreamingPredictRequest request, CallSettings callSettings = null)

Perform a server-side streaming online prediction request for Vertex LLM streaming.

Parameters
Name	Description
`request`	`StreamingPredictRequest` 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
`PredictionServiceClientServerStreamingPredictStream`	The server stream.

Overrides

PredictionServiceClient.ServerStreamingPredict(StreamingPredictRequest, CallSettings)

StreamDirectPredict(CallSettings, BidirectionalStreamingSettings)

public override PredictionServiceClient.StreamDirectPredictStream StreamDirectPredict(CallSettings callSettings = null, BidirectionalStreamingSettings streamingSettings = null)

Perform a streaming online prediction request to a gRPC model server for Vertex first-party products and frameworks.

Parameters
Name	Description
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.
`streamingSettings`	`BidirectionalStreamingSettings` If not null, applies streaming overrides to this RPC call.

Returns
Type	Description
`PredictionServiceClientStreamDirectPredictStream`	The client-server stream.

Overrides

PredictionServiceClient.StreamDirectPredict(CallSettings, BidirectionalStreamingSettings)

StreamDirectRawPredict(CallSettings, BidirectionalStreamingSettings)

public override PredictionServiceClient.StreamDirectRawPredictStream StreamDirectRawPredict(CallSettings callSettings = null, BidirectionalStreamingSettings streamingSettings = null)

Perform a streaming online prediction request to a gRPC model server for custom containers.

Parameters
Name	Description
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.
`streamingSettings`	`BidirectionalStreamingSettings` If not null, applies streaming overrides to this RPC call.

Returns
Type	Description
`PredictionServiceClientStreamDirectRawPredictStream`	The client-server stream.

Overrides

PredictionServiceClient.StreamDirectRawPredict(CallSettings, BidirectionalStreamingSettings)

StreamGenerateContent(GenerateContentRequest, CallSettings)

public override PredictionServiceClient.StreamGenerateContentStream StreamGenerateContent(GenerateContentRequest request, CallSettings callSettings = null)

Generate content with multimodal inputs with streaming support.

Parameters
Name	Description
`request`	`GenerateContentRequest` 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
`PredictionServiceClientStreamGenerateContentStream`	The server stream.

Overrides

PredictionServiceClient.StreamGenerateContent(GenerateContentRequest, CallSettings)

StreamRawPredict(StreamRawPredictRequest, CallSettings)

public override PredictionServiceClient.StreamRawPredictStream StreamRawPredict(StreamRawPredictRequest request, CallSettings callSettings = null)

Perform a streaming online prediction with an arbitrary HTTP payload.

Parameters
Name	Description
`request`	`StreamRawPredictRequest` 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
`PredictionServiceClientStreamRawPredictStream`	The server stream.

Overrides

PredictionServiceClient.StreamRawPredict(StreamRawPredictRequest, CallSettings)

StreamingPredict(CallSettings, BidirectionalStreamingSettings)

public override PredictionServiceClient.StreamingPredictStream StreamingPredict(CallSettings callSettings = null, BidirectionalStreamingSettings streamingSettings = null)

Perform a streaming online prediction request for Vertex first-party products and frameworks.

Parameters
Name	Description
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.
`streamingSettings`	`BidirectionalStreamingSettings` If not null, applies streaming overrides to this RPC call.

Returns
Type	Description
`PredictionServiceClientStreamingPredictStream`	The client-server stream.

Overrides

PredictionServiceClient.StreamingPredict(CallSettings, BidirectionalStreamingSettings)

StreamingRawPredict(CallSettings, BidirectionalStreamingSettings)

public override PredictionServiceClient.StreamingRawPredictStream StreamingRawPredict(CallSettings callSettings = null, BidirectionalStreamingSettings streamingSettings = null)

Perform a streaming online prediction request through gRPC.

Parameters
Name	Description
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.
`streamingSettings`	`BidirectionalStreamingSettings` If not null, applies streaming overrides to this RPC call.

Returns
Type	Description
`PredictionServiceClientStreamingRawPredictStream`	The client-server stream.

Overrides

PredictionServiceClient.StreamingRawPredict(CallSettings, BidirectionalStreamingSettings)