- 3.13.0 (latest)
- 3.12.0
- 3.11.0
- 3.10.0
- 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 class PredictionService.PredictionServiceClient : ClientBase<PredictionService.PredictionServiceClient>Reference documentation and code samples for the Cloud AI Platform v1 API class PredictionService.PredictionServiceClient.
Client for PredictionService
Inheritance
object > ClientBase > ClientBasePredictionServicePredictionServiceClient > PredictionService.PredictionServiceClientNamespace
Google.Cloud.AIPlatform.V1Assembly
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 | CallInvokerThe callInvoker to use to make remote calls. |
PredictionServiceClient(ChannelBase)
public PredictionServiceClient(ChannelBase channel)Creates a new client for PredictionService
| Parameter | |
|---|---|
| Name | Description |
channel | ChannelBaseThe channel to use to make remote calls. |
PredictionServiceClient(ClientBaseConfiguration)
protected PredictionServiceClient(ClientBase.ClientBaseConfiguration configuration)Protected constructor to allow creation of configured clients.
| Parameter | |
|---|---|
| Name | Description |
configuration | ClientBaseClientBaseConfigurationThe client configuration. |
Methods
CreateIAMPolicyClient()
public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.
| Returns | |
|---|---|
| Type | Description |
IAMPolicyIAMPolicyClient | A new IAMPolicy.IAMPolicyClient for the same target as this client. |
CreateLocationsClient()
public virtual Locations.LocationsClient CreateLocationsClient()Creates a new instance of Locations.LocationsClient using the same call invoker as this client.
| Returns | |
|---|---|
| Type | Description |
LocationsLocationsClient | A new Locations.LocationsClient for the same target as this client. |
DirectPredict(DirectPredictRequest, CallOptions)
public virtual DirectPredictResponse DirectPredict(DirectPredictRequest request, CallOptions options)Perform an unary online prediction request for Vertex first-party products and frameworks.
| Parameters | |
|---|---|
| Name | Description |
request | DirectPredictRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
DirectPredictResponse | The response received from the server. |
DirectPredict(DirectPredictRequest, Metadata, DateTime?, CancellationToken)
public virtual DirectPredictResponse DirectPredict(DirectPredictRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Perform an unary online prediction request for Vertex first-party products and frameworks.
| Parameters | |
|---|---|
| Name | Description |
request | DirectPredictRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
DirectPredictResponse | The response received from the server. |
DirectPredictAsync(DirectPredictRequest, CallOptions)
public virtual AsyncUnaryCall<DirectPredictResponse> DirectPredictAsync(DirectPredictRequest request, CallOptions options)Perform an unary online prediction request for Vertex first-party products and frameworks.
| Parameters | |
|---|---|
| Name | Description |
request | DirectPredictRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallDirectPredictResponse | The call object. |
DirectPredictAsync(DirectPredictRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<DirectPredictResponse> DirectPredictAsync(DirectPredictRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Perform an unary online prediction request for Vertex first-party products and frameworks.
| Parameters | |
|---|---|
| Name | Description |
request | DirectPredictRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallDirectPredictResponse | The call object. |
DirectRawPredict(DirectRawPredictRequest, CallOptions)
public virtual DirectRawPredictResponse DirectRawPredict(DirectRawPredictRequest request, CallOptions options)Perform an online prediction request through gRPC.
| Parameters | |
|---|---|
| Name | Description |
request | DirectRawPredictRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
DirectRawPredictResponse | The response received from the server. |
DirectRawPredict(DirectRawPredictRequest, Metadata, DateTime?, CancellationToken)
public virtual DirectRawPredictResponse DirectRawPredict(DirectRawPredictRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Perform an online prediction request through gRPC.
| Parameters | |
|---|---|
| Name | Description |
request | DirectRawPredictRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
DirectRawPredictResponse | The response received from the server. |
DirectRawPredictAsync(DirectRawPredictRequest, CallOptions)
public virtual AsyncUnaryCall<DirectRawPredictResponse> DirectRawPredictAsync(DirectRawPredictRequest request, CallOptions options)Perform an online prediction request through gRPC.
| Parameters | |
|---|---|
| Name | Description |
request | DirectRawPredictRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallDirectRawPredictResponse | The call object. |
DirectRawPredictAsync(DirectRawPredictRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<DirectRawPredictResponse> DirectRawPredictAsync(DirectRawPredictRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Perform an online prediction request through gRPC.
| Parameters | |
|---|---|
| Name | Description |
request | DirectRawPredictRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallDirectRawPredictResponse | The call object. |
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.
| Parameters | |
|---|---|
| Name | Description |
request | ExplainRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ExplainResponse | The response received from the server. |
Explain(ExplainRequest, Metadata, DateTime?, CancellationToken)
public virtual ExplainResponse Explain(ExplainRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn 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.
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 to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallExplainResponse | The call object. |
ExplainAsync(ExplainRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ExplainResponse> ExplainAsync(ExplainRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallExplainResponse | The call object. |
NewInstance(ClientBaseConfiguration)
protected override PredictionService.PredictionServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)Creates a new instance of client from given ClientBaseConfiguration.
| Parameter | |
|---|---|
| Name | Description |
configuration | ClientBaseClientBaseConfiguration |
| Returns | |
|---|---|
| Type | Description |
PredictionServicePredictionServiceClient | |
Predict(PredictRequest, CallOptions)
public virtual PredictResponse Predict(PredictRequest request, CallOptions options)Perform an online prediction.
| Parameters | |
|---|---|
| Name | Description |
request | PredictRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
PredictResponse | The response received from the server. |
Predict(PredictRequest, Metadata, DateTime?, CancellationToken)
public virtual PredictResponse Predict(PredictRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Perform an online prediction.
| Parameters | |
|---|---|
| Name | Description |
request | PredictRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn 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 | PredictRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallPredictResponse | The call object. |
PredictAsync(PredictRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<PredictResponse> PredictAsync(PredictRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Perform an online prediction.
| Parameters | |
|---|---|
| Name | Description |
request | PredictRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallPredictResponse | 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 | RawPredictRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
HttpBody | The response received from the server. |
RawPredict(RawPredictRequest, Metadata, DateTime?, CancellationToken)
public virtual HttpBody RawPredict(RawPredictRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn 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 | RawPredictRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallHttpBody | The call object. |
RawPredictAsync(RawPredictRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<HttpBody> RawPredictAsync(RawPredictRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)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 to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallHttpBody | The call object. |
ServerStreamingPredict(StreamingPredictRequest, CallOptions)
public virtual AsyncServerStreamingCall<StreamingPredictResponse> ServerStreamingPredict(StreamingPredictRequest request, CallOptions options)Perform a server-side streaming online prediction request for Vertex LLM streaming.
| Parameters | |
|---|---|
| Name | Description |
request | StreamingPredictRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncServerStreamingCallStreamingPredictResponse | The call object. |
ServerStreamingPredict(StreamingPredictRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncServerStreamingCall<StreamingPredictResponse> ServerStreamingPredict(StreamingPredictRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Perform a server-side streaming online prediction request for Vertex LLM streaming.
| Parameters | |
|---|---|
| Name | Description |
request | StreamingPredictRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncServerStreamingCallStreamingPredictResponse | The call object. |
StreamGenerateContent(GenerateContentRequest, CallOptions)
public virtual AsyncServerStreamingCall<GenerateContentResponse> StreamGenerateContent(GenerateContentRequest request, CallOptions options)Generate content with multimodal inputs with streaming support.
| Parameters | |
|---|---|
| Name | Description |
request | GenerateContentRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncServerStreamingCallGenerateContentResponse | The call object. |
StreamGenerateContent(GenerateContentRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncServerStreamingCall<GenerateContentResponse> StreamGenerateContent(GenerateContentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Generate content with multimodal inputs with streaming support.
| Parameters | |
|---|---|
| Name | Description |
request | GenerateContentRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncServerStreamingCallGenerateContentResponse | The call object. |
StreamingPredict(CallOptions)
public virtual AsyncDuplexStreamingCall<StreamingPredictRequest, StreamingPredictResponse> StreamingPredict(CallOptions options)Perform a streaming online prediction request for Vertex first-party products and frameworks.
| Parameter | |
|---|---|
| Name | Description |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncDuplexStreamingCallStreamingPredictRequestStreamingPredictResponse | The call object. |
StreamingPredict(Metadata, DateTime?, CancellationToken)
public virtual AsyncDuplexStreamingCall<StreamingPredictRequest, StreamingPredictResponse> StreamingPredict(Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Perform a streaming online prediction request for Vertex first-party products and frameworks.
| Parameters | |
|---|---|
| Name | Description |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncDuplexStreamingCallStreamingPredictRequestStreamingPredictResponse | The call object. |
StreamingRawPredict(CallOptions)
public virtual AsyncDuplexStreamingCall<StreamingRawPredictRequest, StreamingRawPredictResponse> StreamingRawPredict(CallOptions options)Perform a streaming online prediction request through gRPC.
| Parameter | |
|---|---|
| Name | Description |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncDuplexStreamingCallStreamingRawPredictRequestStreamingRawPredictResponse | The call object. |
StreamingRawPredict(Metadata, DateTime?, CancellationToken)
public virtual AsyncDuplexStreamingCall<StreamingRawPredictRequest, StreamingRawPredictResponse> StreamingRawPredict(Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Perform a streaming online prediction request through gRPC.
| Parameters | |
|---|---|
| Name | Description |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncDuplexStreamingCallStreamingRawPredictRequestStreamingRawPredictResponse | The call object. |