def get_context(
self,
request: Union[context.GetContextRequest, dict] = None,
*,
name: str = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> context.Context:
r"""Retrieves the specified context.
.. code-block:: python
from google.cloud import dialogflow_v2
def sample_get_context():
# Create a client
client = dialogflow_v2.ContextsClient()
# Initialize request argument(s)
request = dialogflow_v2.GetContextRequest(
name="name_value",
)
# Make the request
response = client.get_context(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.dialogflow_v2.types.GetContextRequest, dict]):
The request object. The request message for
[Contexts.GetContext][google.cloud.dialogflow.v2.Contexts.GetContext].
name (str):
Required. The name of the context. Format:
``projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>``
or
``projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>``.
If ``Environment ID`` is not specified, we assume
default 'draft' environment. If ``User ID`` is not
specified, we assume default '-' user.
This corresponds to the ``name`` 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:
google.cloud.dialogflow_v2.types.Context:
Dialogflow contexts are similar to natural language context. If a person says
to you "they are orange", you need context in order
to understand what "they" is referring to. Similarly,
for Dialogflow to handle an end-user expression like
that, it needs to be provided with context in order
to correctly match an intent.
Using contexts, you can control the flow of a
conversation. You can configure contexts for an
intent by setting input and output contexts, which
are identified by string names. When an intent is
matched, any configured output contexts for that
intent become active. While any contexts are active,
Dialogflow is more likely to match intents that are
configured with input contexts that correspond to the
currently active contexts.
For more information about context, see the [Contexts
guide](\ https://cloud.google.com/dialogflow/docs/contexts-overview).
"""
# Create or coerce a protobuf request object.
# Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([name])
if request is not None and has_flattened_params:
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
# Minor optimization to avoid making a copy if the user passes
# in a context.GetContextRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, context.GetContextRequest):
request = context.GetContextRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if name is not None:
request.name = name
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.get_context]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("name", request.name), )), )
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
async def get_context(
self,
request: context.GetContextRequest = None,
*,
name: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> context.Context:
r"""Retrieves the specified context.
Args:
request (:class:`~.context.GetContextRequest`):
The request object. The request message for
[Contexts.GetContext][google.cloud.dialogflow.v2.Contexts.GetContext].
name (:class:`str`):
Required. The name of the context. Format:
``projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>``
or
``projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>``.
If ``Environment ID`` is not specified, we assume
default 'draft' environment. If ``User ID`` is not
specified, we assume default '-' user.
This corresponds to the ``name`` 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:
~.context.Context:
Dialogflow contexts are similar to natural language
context. If a person says to you "they are orange", you
need context in order to understand what "they" is
referring to. Similarly, for Dialogflow to handle an
end-user expression like that, it needs to be provided
with context in order to correctly match an intent.
Using contexts, you can control the flow of a
conversation. You can configure contexts for an intent
by setting input and output contexts, which are
identified by string names. When an intent is matched,
any configured output contexts for that intent become
active. While any contexts are active, Dialogflow is
more likely to match intents that are configured with
input contexts that correspond to the currently active
contexts.
For more information about context, see the `Contexts
guide <https://cloud.google.com/dialogflow/docs/contexts-overview>`__.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([name])
if request is not None and has_flattened_params:
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
request = context.GetContextRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if name is not None:
request.name = name
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.get_context,
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(
(("name", request.name), )), )
# Send the request.
response = await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
