async def fulfill_intent(
self,
request: session.FulfillIntentRequest = None,
*,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> session.FulfillIntentResponse:
r"""Fulfills a matched intent returned by
[MatchIntent][google.cloud.dialogflow.cx.v3beta1.Sessions.MatchIntent].
Must be called after
[MatchIntent][google.cloud.dialogflow.cx.v3beta1.Sessions.MatchIntent],
with input from
[MatchIntentResponse][google.cloud.dialogflow.cx.v3beta1.MatchIntentResponse].
Otherwise, the behavior is undefined.
Args:
request (:class:`~.session.FulfillIntentRequest`):
The request object. Request of [FulfillIntent][]
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:
~.session.FulfillIntentResponse:
Response of [FulfillIntent][]
"""
# Create or coerce a protobuf request object.
request = session.FulfillIntentRequest(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.fulfill_intent,
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(
((
"match_intent_request.session",
request.match_intent_request.session,
), )), )
# Send the request.
response = await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
async def test_fulfill_intent_field_headers_async():
client = SessionsAsyncClient(
credentials=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 = session.FulfillIntentRequest()
request.match_intent_request.session = "match_intent_request.session/value"
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._client._transport.fulfill_intent),
"__call__") as call:
call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(
session.FulfillIntentResponse())
await client.fulfill_intent(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",
"match_intent_request.session=match_intent_request.session/value",
) in kw["metadata"]
async def test_fulfill_intent_async(transport: str = "grpc_asyncio"):
client = SessionsAsyncClient(
credentials=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 = session.FulfillIntentRequest()
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._client._transport.fulfill_intent),
"__call__") as call:
# Designate an appropriate return value for the call.
call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(
session.FulfillIntentResponse(
response_id="response_id_value",
output_audio=b"output_audio_blob",
))
response = await client.fulfill_intent(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 response is the type that we expect.
assert isinstance(response, session.FulfillIntentResponse)
assert response.response_id == "response_id_value"
assert response.output_audio == b"output_audio_blob"
def fulfill_intent(
self,
request: session.FulfillIntentRequest = None,
*,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> session.FulfillIntentResponse:
r"""Fulfills a matched intent returned by
[MatchIntent][google.cloud.dialogflow.cx.v3beta1.Sessions.MatchIntent].
Must be called after
[MatchIntent][google.cloud.dialogflow.cx.v3beta1.Sessions.MatchIntent],
with input from
[MatchIntentResponse][google.cloud.dialogflow.cx.v3beta1.MatchIntentResponse].
Otherwise, the behavior is undefined.
Args:
request (google.cloud.dialogflowcx_v3beta1.types.FulfillIntentRequest):
The request object. Request of [FulfillIntent][]
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.dialogflowcx_v3beta1.types.FulfillIntentResponse:
Response of [FulfillIntent][]
"""
# Create or coerce a protobuf request object.
# Minor optimization to avoid making a copy if the user passes
# in a session.FulfillIntentRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, session.FulfillIntentRequest):
request = session.FulfillIntentRequest(request)
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.fulfill_intent]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (
gapic_v1.routing_header.to_grpc_metadata(
(
(
"match_intent_request.session",
request.match_intent_request.session,
),
)
),
)
# Send the request.
response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
