- 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 : PredictionServiceClientReference documentation and code samples for the Cloud AI Platform v1 API class PredictionServiceClientImpl.
PredictionService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.AIPlatform.V1Assembly
Google.Cloud.AIPlatform.V1.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 | PredictionServicePredictionServiceClientThe underlying gRPC client. |
settings | PredictionServiceSettingsThe base PredictionServiceSettings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Properties
GrpcClient
public override PredictionService.PredictionServiceClient GrpcClient { get; }The underlying gRPC PredictionService client
| Property Value | |
|---|---|
| Type | Description |
PredictionServicePredictionServiceClient | |
IAMPolicyClient
public override IAMPolicyClient IAMPolicyClient { get; }The IAMPolicyClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
IAMPolicyClient | |
LocationsClient
public override LocationsClient LocationsClient { get; }The LocationsClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
LocationsClient | |
Methods
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 | DirectPredictRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
DirectPredictResponse | The RPC response. |
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 | DirectPredictRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskDirectPredictResponse | A Task containing the RPC response. |
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 | DirectRawPredictRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
DirectRawPredictResponse | The RPC response. |
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 | DirectRawPredictRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskDirectRawPredictResponse | A Task containing the RPC response. |
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.
| Parameters | |
|---|---|
| Name | Description |
request | ExplainRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ExplainResponse | The RPC response. |
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.
| Parameters | |
|---|---|
| Name | Description |
request | ExplainRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskExplainResponse | A Task containing the RPC response. |
GenerateContent(GenerateContentRequest, CallSettings)
public override GenerateContentResponse GenerateContent(GenerateContentRequest request, CallSettings callSettings = null)Generate content with multimodal inputs.
| Parameters | |
|---|---|
| Name | Description |
request | GenerateContentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
GenerateContentResponse | The RPC response. |
GenerateContentAsync(GenerateContentRequest, CallSettings)
public override Task<GenerateContentResponse> GenerateContentAsync(GenerateContentRequest request, CallSettings callSettings = null)Generate content with multimodal inputs.
| Parameters | |
|---|---|
| Name | Description |
request | GenerateContentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskGenerateContentResponse | A Task containing the RPC response. |
Predict(PredictRequest, CallSettings)
public override PredictResponse Predict(PredictRequest request, CallSettings callSettings = null)Perform an online prediction.
| Parameters | |
|---|---|
| Name | Description |
request | PredictRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PredictResponse | The RPC response. |
PredictAsync(PredictRequest, CallSettings)
public override Task<PredictResponse> PredictAsync(PredictRequest request, CallSettings callSettings = null)Perform an online prediction.
| Parameters | |
|---|---|
| Name | Description |
request | PredictRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskPredictResponse | A Task containing the RPC response. |
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 | RawPredictRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
HttpBody | The RPC response. |
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 | RawPredictRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskHttpBody | A Task containing the RPC response. |
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 | StreamingPredictRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PredictionServiceClientServerStreamingPredictStream | The server stream. |
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 | CallSettingsIf not null, applies overrides to this RPC call. |
streamingSettings | BidirectionalStreamingSettingsIf not null, applies streaming overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PredictionServiceClientStreamDirectPredictStream | The client-server stream. |
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 | CallSettingsIf not null, applies overrides to this RPC call. |
streamingSettings | BidirectionalStreamingSettingsIf not null, applies streaming overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PredictionServiceClientStreamDirectRawPredictStream | The client-server stream. |
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 | GenerateContentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PredictionServiceClientStreamGenerateContentStream | The server stream. |
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 | StreamRawPredictRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PredictionServiceClientStreamRawPredictStream | The server stream. |
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 | CallSettingsIf not null, applies overrides to this RPC call. |
streamingSettings | BidirectionalStreamingSettingsIf not null, applies streaming overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PredictionServiceClientStreamingPredictStream | The client-server stream. |
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 | CallSettingsIf not null, applies overrides to this RPC call. |
streamingSettings | BidirectionalStreamingSettingsIf not null, applies streaming overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PredictionServiceClientStreamingRawPredictStream | The client-server stream. |