Class PredictionServiceClient (0.7.1)
Stay organized with collections
Save and categorize content based on your preferences.
PredictionServiceClient(
transport=None,
channel=None,
credentials=None,
client_config=None,
client_info=None,
client_options=None,
)AutoML Prediction API.
On any input that is documented to expect a string parameter in snake_case or kebab-case, either of those cases is accepted.
Methods
PredictionServiceClient
PredictionServiceClient(
transport=None,
channel=None,
credentials=None,
client_config=None,
client_info=None,
client_options=None,
)Constructor.
channel
grpc.Channel
DEPRECATED. A Channel instance through which to make calls. This argument is mutually exclusive with credentials; providing both will raise an exception.
credentials
google.auth.credentials.Credentials
The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to transport; doing so will raise an exception.
client_config
dict
DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is 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.
client_options
Union[dict, google.api_core.client_options.ClientOptions]
Client options used to set user options on the client. API Endpoint should be set through client_options.
from_service_account_file
from_service_account_file(filename, *args, **kwargs)Creates an instance of this client using the provided credentials file.
filename
str
The path to the service account private key json file.
PredictionServiceClient
The constructed client.
from_service_account_json
from_service_account_json(filename, *args, **kwargs)Creates an instance of this client using the provided credentials file.
filename
str
The path to the service account private key json file.
PredictionServiceClient
The constructed client.
model_path
model_path(project, location, model)Return a fully-qualified model string.
predict
predict(name, payload, params=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Perform an online prediction. The prediction result will be directly returned in the response. Available for following ML problems, and their expected request payloads:
- Translation - TextSnippet, content up to 25,000 characters, UTF-8 encoded.
.. rubric:: Example
from google.cloud import automl_v1
client = automl_v1.PredictionServiceClient()
name = client.model_path('[PROJECT]', '[LOCATION]', '[MODEL]')
TODO: Initialize
payload:payload = {}
response = client.predict(name, payload)
name
str
Name of the model requested to serve the prediction.
payload
Union[dict, ExamplePayload]
Required. Payload to perform a prediction on. The payload must match the problem type that the model was trained to solve. If a dict is provided, it must be of the same form as the protobuf message ExamplePayload
params
dict[str -> str]
Additional domain-specific parameters, any string must be up to 25000 characters long.
retry
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadata
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method.
google.api_core.exceptions.GoogleAPICallError
If the request failed for any reason.
google.api_core.exceptions.RetryError
If the request failed due to a retryable error and retry attempts failed.
ValueError
If the parameters are invalid.