Class PredictionServiceClient (1.0.1)

  PredictionServiceClient 
 ( 
 * 
 , 
 credentials 
 : 
 Optional 
 [ 
 google 
 . 
 auth 
 . 
 credentials 
 . 
 Credentials 
 ] 
 = 
 None 
 , 
 transport 
 : 
 Optional 
 [ 
 Union 
 [ 
 str 
 , 
 google 
 . 
 cloud 
 . 
 aiplatform_v1 
 . 
 services 
 . 
 prediction_service 
 . 
 transports 
 . 
 base 
 . 
 PredictionServiceTransport 
 ]] 
 = 
 None 
 , 
 client_options 
 : 
 Optional 
 [ 
 google 
 . 
 api_core 
 . 
 client_options 
 . 
 ClientOptions 
 ] 
 = 
 None 
 , 
 client_info 
 : 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 client_info 
 . 
 ClientInfo 
 = 
< google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 client_info 
 . 
 ClientInfo 
 object 
> )

A service for online predictions and explanations.

Inheritance

builtins.object > PredictionServiceClient

Properties

transport

Return the transport used by the client instance.

Returns
Type Description
PredictionServiceTransport The transport used by the client instance.

Methods

PredictionServiceClient

  PredictionServiceClient 
 ( 
 * 
 , 
 credentials 
 : 
 Optional 
 [ 
 google 
 . 
 auth 
 . 
 credentials 
 . 
 Credentials 
 ] 
 = 
 None 
 , 
 transport 
 : 
 Optional 
 [ 
 Union 
 [ 
 str 
 , 
 google 
 . 
 cloud 
 . 
 aiplatform_v1 
 . 
 services 
 . 
 prediction_service 
 . 
 transports 
 . 
 base 
 . 
 PredictionServiceTransport 
 ]] 
 = 
 None 
 , 
 client_options 
 : 
 Optional 
 [ 
 google 
 . 
 api_core 
 . 
 client_options 
 . 
 ClientOptions 
 ] 
 = 
 None 
 , 
 client_info 
 : 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 client_info 
 . 
 ClientInfo 
 = 
< google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 client_info 
 . 
 ClientInfo 
 object 
> )

Instantiate the prediction service client.

Parameters
Name Description
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport Union[str, PredictionServiceTransport]

The transport to use. If set to None, a transport is chosen automatically.
client_options google.api_core.client_options.ClientOptions

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None , then default info will be used. Generally, you only need to set this if you're developing your own client library.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If mutual TLS transport creation failed for any reason. 
  common_billing_account_path 
 ( 
 billing_account 
 : 
 str 
 )

Return a fully-qualified billing_account string.

common_folder_path

  common_folder_path 
 ( 
 folder 
 : 
 str 
 )

Return a fully-qualified folder string.

common_location_path

  common_location_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 )

Return a fully-qualified location string.

common_organization_path

  common_organization_path 
 ( 
 organization 
 : 
 str 
 )

Return a fully-qualified organization string.

common_project_path

  common_project_path 
 ( 
 project 
 : 
 str 
 )

Return a fully-qualified project string.

endpoint_path

  endpoint_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 endpoint 
 : 
 str 
 )

Return a fully-qualified endpoint string.

  from_service_account_file 
 ( 
 filename 
 : 
 str 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 )

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
PredictionServiceClient The constructed client. 
  from_service_account_info 
 ( 
 info 
 : 
 dict 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 )

Creates an instance of this client using the provided credentials info.

Parameter
Name Description
info dict

The service account private key info.
Returns
Type Description
PredictionServiceClient The constructed client. 
  from_service_account_json 
 ( 
 filename 
 : 
 str 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 )

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
PredictionServiceClient The constructed client. 
  parse_common_billing_account_path 
 ( 
 path 
 : 
 str 
 )

Parse a billing_account path into its component segments.

parse_common_folder_path

  parse_common_folder_path 
 ( 
 path 
 : 
 str 
 )

Parse a folder path into its component segments.

parse_common_location_path

  parse_common_location_path 
 ( 
 path 
 : 
 str 
 )

Parse a location path into its component segments.

parse_common_organization_path

  parse_common_organization_path 
 ( 
 path 
 : 
 str 
 )

Parse a organization path into its component segments.

parse_common_project_path

  parse_common_project_path 
 ( 
 path 
 : 
 str 
 )

Parse a project path into its component segments.

parse_endpoint_path

  parse_endpoint_path 
 ( 
 path 
 : 
 str 
 )

Parse a endpoint path into its component segments.

predict

  predict 
 ( 
 request 
 : 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 aiplatform_v1 
 . 
 types 
 . 
 prediction_service 
 . 
 PredictRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 endpoint 
 : 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 instances 
 : 
 Optional 
 [ 
 Sequence 
 [ 
 google 
 . 
 protobuf 
 . 
 struct_pb2 
 . 
 Value 
 ]] 
 = 
 None 
 , 
 parameters 
 : 
 Optional 
 [ 
 google 
 . 
 protobuf 
 . 
 struct_pb2 
 . 
 Value 
 ] 
 = 
 None 
 , 
 retry 
 : 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 Retry 
 = 
< object 
 object 
> , 
 timeout 
 : 
 Optional 
 [ 
 float 
 ] 
 = 
 None 
 , 
 metadata 
 : 
 Sequence 
 [ 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 ())

Perform an online prediction.

Parameters
Name Description
request google.cloud.aiplatform_v1.types.PredictRequest

The request object. Request message for PredictionService.Predict .
endpoint str

Required. The name of the Endpoint requested to serve the prediction. Format: projects/{project}/locations/{location}/endpoints/{endpoint} This corresponds to the endpoint field on the request instance; if request is provided, this should not be set.
instances Sequence[google.protobuf.struct_pb2.Value]

Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' [Model's][google.cloud.aiplatform.v1.DeployedModel.model] [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata] instance_schema_uri . This corresponds to the instances field on the request instance; if request is provided, this should not be set.
parameters google.protobuf.struct_pb2.Value

The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' [Model's ][google.cloud.aiplatform.v1.DeployedModel.model] [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata] parameters_schema_uri . This corresponds to the parameters field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.aiplatform_v1.types.PredictResponse Response message for PredictionService.Predict .