async def test_predict_field_headers_async():
client = PredictionServiceAsyncClient(
credentials=ga_credentials.AnonymousCredentials(),
)
# Any value that is part of the HTTP/1.1 URI should be sent as
# a field header. Set these to a non-empty value.
request = prediction_service.PredictRequest()
request.placement = "placement/value"
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.predict), "__call__") as call:
call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(
prediction_service.PredictResponse()
)
await client.predict(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls)
_, args, _ = call.mock_calls[0]
assert args[0] == request
# Establish that the field header was sent.
_, _, kw = call.mock_calls[0]
assert ("x-goog-request-params", "placement=placement/value",) in kw["metadata"]
async def test_predict_async(
transport: str = "grpc_asyncio", request_type=prediction_service.PredictRequest
):
client = PredictionServiceAsyncClient(
credentials=ga_credentials.AnonymousCredentials(), transport=transport,
)
# Everything is optional in proto3 as far as the runtime is concerned,
# and we are mocking out the actual API, so just send an empty request.
request = request_type()
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.predict), "__call__") as call:
# Designate an appropriate return value for the call.
call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(
prediction_service.PredictResponse(
attribution_token="attribution_token_value",
missing_ids=["missing_ids_value"],
validate_only=True,
)
)
response = await client.predict(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls)
_, args, _ = call.mock_calls[0]
assert args[0] == prediction_service.PredictRequest()
# Establish that the response is the type that we expect.
assert isinstance(response, prediction_service.PredictResponse)
assert response.attribution_token == "attribution_token_value"
assert response.missing_ids == ["missing_ids_value"]
assert response.validate_only is True
def test_predict_empty_call():
# This test is a coverage failsafe to make sure that totally empty calls,
# i.e. request == None and no flattened fields passed, work.
client = PredictionServiceClient(
credentials=ga_credentials.AnonymousCredentials(), transport="grpc",
)
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.predict), "__call__") as call:
client.predict()
call.assert_called()
_, args, _ = call.mock_calls[0]
assert args[0] == prediction_service.PredictRequest()
def predict(
self,
request: prediction_service.PredictRequest = None,
*,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> prediction_service.PredictResponse:
r"""Makes a recommendation prediction.
Args:
request (google.cloud.retail_v2.types.PredictRequest):
The request object. Request message for Predict method.
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:
google.cloud.retail_v2.types.PredictResponse:
Response message for predict method.
"""
# Create or coerce a protobuf request object.
# Minor optimization to avoid making a copy if the user passes
# in a prediction_service.PredictRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, prediction_service.PredictRequest):
request = prediction_service.PredictRequest(request)
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.predict]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("placement", request.placement), )), )
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
async def predict(
self,
request: prediction_service.PredictRequest = None,
*,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> prediction_service.PredictResponse:
r"""Makes a recommendation prediction.
Args:
request (:class:`google.cloud.retail_v2.types.PredictRequest`):
The request object. Request message for Predict method.
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:
google.cloud.retail_v2.types.PredictResponse:
Response message for predict method.
"""
# Create or coerce a protobuf request object.
request = prediction_service.PredictRequest(request)
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.predict,
default_timeout=None,
client_info=DEFAULT_CLIENT_INFO,
)
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("placement", request.placement), )), )
# Send the request.
response = await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response