PredictionServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.automl_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>)AutoML Prediction API.
On any input that is documented to expect a string parameter in snake_case or dash-case, either of those cases is accepted.
Inheritance
builtins.object > PredictionServiceClientProperties
transport
Returns the transport used by the client instance.
| 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.automl_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>)Instantiates the prediction service client.
| 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 |
| 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 |
| Type | Description |
| google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)Releases underlying transport's resources.
batch_predict
batch_predict(request: Optional[Union[google.cloud.automl_v1.types.prediction_service.BatchPredictRequest, dict]] = None, *, name: Optional[str] = None, input_config: Optional[google.cloud.automl_v1.types.io.BatchPredictInputConfig] = None, output_config: Optional[google.cloud.automl_v1.types.io.BatchPredictOutputConfig] = None, params: Optional[Sequence[google.cloud.automl_v1.types.prediction_service.BatchPredictRequest.ParamsEntry]] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Perform a batch prediction. Unlike the online
xref_Predict,
batch prediction result won't be immediately available in the
response. Instead, a long running operation object is returned.
User can poll the operation result via
GetOperation][google.longrunning.Operations.GetOperation]
method. Once the operation is done,
xref_BatchPredictResult
is returned in the
response][google.longrunning.Operation.response] field.
Available for following ML scenarios:
- AutoML Vision Classification
- AutoML Vision Object Detection
- AutoML Video Intelligence Classification
- AutoML Video Intelligence Object Tracking * AutoML Natural Language Classification
- AutoML Natural Language Entity Extraction
- AutoML Natural Language Sentiment Analysis
- AutoML Tables
from google.cloud import automl_v1
def sample_batch_predict():
# Create a client
client = automl_v1.PredictionServiceClient()
# Initialize request argument(s)
input_config = automl_v1.BatchPredictInputConfig()
input_config.gcs_source.input_uris = ['input_uris_value_1', 'input_uris_value_2']
output_config = automl_v1.BatchPredictOutputConfig()
output_config.gcs_destination.output_uri_prefix = "output_uri_prefix_value"
request = automl_v1.BatchPredictRequest(
name="name_value",
input_config=input_config,
output_config=output_config,
)
# Make the request
operation = client.batch_predict(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.automl_v1.types.BatchPredictRequest, dict]
The request object. Request message for PredictionService.BatchPredict. |
| name |
str
Required. Name of the model requested to serve the batch prediction. This corresponds to the |
| input_config |
google.cloud.automl_v1.types.BatchPredictInputConfig
Required. The input configuration for batch prediction. This corresponds to the |
| output_config |
google.cloud.automl_v1.types.BatchPredictOutputConfig
Required. The Configuration specifying where output predictions should be written. This corresponds to the |
| params |
Sequence[google.cloud.automl_v1.types.BatchPredictRequest.ParamsEntry]
Additional domain-specific parameters for the predictions, any string must be up to 25000 characters long. AutoML Natural Language Classification |
| 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. |
| Type | Description |
| google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be BatchPredictResult Result of the Batch Predict. This message is returned in `response][google.longrunning.Operation.response]` of the operation returned by the PredictionService.BatchPredict. |
common_billing_account_path
common_billing_account_path(billing_account: str)Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)Returns a fully-qualified project string.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
| filename |
str
The path to the service account private key json file. |
| Type | Description |
| PredictionServiceClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
| Name | Description |
| info |
dict
The service account private key info. |
| Type | Description |
| PredictionServiceClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
| filename |
str
The path to the service account private key json file. |
| Type | Description |
| PredictionServiceClient | The constructed client. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
| Name | Description |
| client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
| Type | Description |
| google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
| Type | Description |
| Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
model_path
model_path(project: str, location: str, model: str)Returns a fully-qualified model string.
parse_common_billing_account_path
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_model_path
parse_model_path(path: str)Parses a model path into its component segments.
predict
predict(request: Optional[Union[google.cloud.automl_v1.types.prediction_service.PredictRequest, dict]] = None, *, name: Optional[str] = None, payload: Optional[google.cloud.automl_v1.types.data_items.ExamplePayload] = None, params: Optional[Sequence[google.cloud.automl_v1.types.prediction_service.PredictRequest.ParamsEntry]] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Perform an online prediction. The prediction result is directly returned in the response. Available for following ML scenarios, and their expected request payloads:
AutoML Vision Classification
- An image in .JPEG, .GIF or .PNG format, image_bytes up to 30MB.
AutoML Vision Object Detection
- An image in .JPEG, .GIF or .PNG format, image_bytes up to 30MB.
AutoML Natural Language Classification
- A TextSnippet up to 60,000 characters, UTF-8 encoded or a document in .PDF, .TIF or .TIFF format with size upto 2MB.
AutoML Natural Language Entity Extraction
- A TextSnippet up to 10,000 characters, UTF-8 NFC encoded or a document in .PDF, .TIF or .TIFF format with size upto 20MB.
AutoML Natural Language Sentiment Analysis
- A TextSnippet up to 60,000 characters, UTF-8 encoded or a document in .PDF, .TIF or .TIFF format with size upto 2MB.
AutoML Translation
- A TextSnippet up to 25,000 characters, UTF-8 encoded.
AutoML Tables
- A row with column values matching the columns of the model,
up to 5MB. Not available for FORECASTING
prediction_type.
from google.cloud import automl_v1
def sample_predict():
# Create a client
client = automl_v1.PredictionServiceClient()
# Initialize request argument(s)
payload = automl_v1.ExamplePayload()
payload.image.image_bytes = b'image_bytes_blob'
request = automl_v1.PredictRequest(
name="name_value",
payload=payload,
)
# Make the request
response = client.predict(request=request)
# Handle the response
print(response)
| Name | Description |
| request |
Union[google.cloud.automl_v1.types.PredictRequest, dict]
The request object. Request message for PredictionService.Predict. |
| name |
str
Required. Name of the model requested to serve the prediction. This corresponds to the |
| payload |
google.cloud.automl_v1.types.ExamplePayload
Required. Payload to perform a prediction on. The payload must match the problem type that the model was trained to solve. This corresponds to the |
| params |
Sequence[google.cloud.automl_v1.types.PredictRequest.ParamsEntry]
Additional domain-specific parameters, any string must be up to 25000 characters long. AutoML Vision Classification |
| 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. |
| Type | Description |
| google.cloud.automl_v1.types.PredictResponse | Response message for PredictionService.Predict. |