def get_intent(self,
name,
language_code=None,
intent_view=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None):
"""
Retrieves the specified intent.
Example:
>>> from google.cloud import dialogflow_v2
>>>
>>> client = dialogflow_v2.IntentsClient()
>>>
>>> name = client.intent_path('[PROJECT]', '[INTENT]')
>>>
>>> response = client.get_intent(name)
Args:
name (str): Required. The name of the intent.
Format: ``projects/<Project ID>/agent/intents/<Intent ID>``.
language_code (str): Optional. The language to retrieve training phrases, parameters and rich
messages for. If not specified, the agent's default language is used.
[More than a dozen
languages](https://dialogflow.com/docs/reference/language) are supported.
Note: languages must be enabled in the agent, before they can be used.
intent_view (~google.cloud.dialogflow_v2.types.IntentView): Optional. The resource view to apply to the returned intent.
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will not
be retried.
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.
Returns:
A :class:`~google.cloud.dialogflow_v2.types.Intent` instance.
Raises:
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.
"""
if metadata is None:
metadata = []
metadata = list(metadata)
request = intent_pb2.GetIntentRequest(
name=name,
language_code=language_code,
intent_view=intent_view,
)
return self._get_intent(request,
retry=retry,
timeout=timeout,
metadata=metadata)
def test_get_intent(self):
# Setup Expected Response
name_2 = 'name2-1052831874'
display_name = 'displayName1615086568'
priority = 1165461084
is_fallback = False
ml_disabled = True
action = 'action-1422950858'
reset_contexts = True
root_followup_intent_name = 'rootFollowupIntentName402253784'
parent_followup_intent_name = 'parentFollowupIntentName-1131901680'
expected_response = {
'name': name_2,
'display_name': display_name,
'priority': priority,
'is_fallback': is_fallback,
'ml_disabled': ml_disabled,
'action': action,
'reset_contexts': reset_contexts,
'root_followup_intent_name': root_followup_intent_name,
'parent_followup_intent_name': parent_followup_intent_name
}
expected_response = intent_pb2.Intent(**expected_response)
# Mock the API response
channel = ChannelStub(responses=[expected_response])
patch = mock.patch('google.api_core.grpc_helpers.create_channel')
with patch as create_channel:
create_channel.return_value = channel
client = dialogflow_v2.IntentsClient()
# Setup Request
name = client.intent_path('[PROJECT]', '[INTENT]')
response = client.get_intent(name)
assert expected_response == response
assert len(channel.requests) == 1
expected_request = intent_pb2.GetIntentRequest(name=name)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def test_get_intent(self):
# Setup Expected Response
name_2 = "name2-1052831874"
display_name = "displayName1615086568"
priority = 1165461084
is_fallback = False
ml_disabled = True
action = "action-1422950858"
reset_contexts = True
root_followup_intent_name = "rootFollowupIntentName402253784"
parent_followup_intent_name = "parentFollowupIntentName-1131901680"
expected_response = {
"name": name_2,
"display_name": display_name,
"priority": priority,
"is_fallback": is_fallback,
"ml_disabled": ml_disabled,
"action": action,
"reset_contexts": reset_contexts,
"root_followup_intent_name": root_followup_intent_name,
"parent_followup_intent_name": parent_followup_intent_name,
}
expected_response = intent_pb2.Intent(**expected_response)
# Mock the API response
channel = ChannelStub(responses=[expected_response])
patch = mock.patch("google.api_core.grpc_helpers.create_channel")
with patch as create_channel:
create_channel.return_value = channel
client = dialogflow_v2.IntentsClient()
# Setup Request
name = client.intent_path("[PROJECT]", "[INTENT]")
response = client.get_intent(name)
assert expected_response == response
assert len(channel.requests) == 1
expected_request = intent_pb2.GetIntentRequest(name=name)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def get_intent(
self,
name,
language_code=None,
intent_view=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Retrieves the specified intent.
Example:
>>> import dialogflow_v2
>>>
>>> client = dialogflow_v2.IntentsClient()
>>>
>>> name = client.intent_path('[PROJECT]', '[INTENT]')
>>>
>>> response = client.get_intent(name)
Args:
name (str): Required. The name of the intent. Format:
``projects/<Project ID>/agent/intents/<Intent ID>``.
language_code (str): Optional. The language to retrieve training phrases, parameters and rich
messages for. If not specified, the agent's default language is used.
`Many
languages <https://cloud.google.com/dialogflow/docs/reference/language>`__
are supported. Note: languages must be enabled in the agent before they
can be used.
intent_view (~google.cloud.dialogflow_v2.types.IntentView): Optional. The resource view to apply to the returned intent.
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.
Returns:
A :class:`~google.cloud.dialogflow_v2.types.Intent` instance.
Raises:
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.
"""
# Wrap the transport method to add retry and timeout logic.
if "get_intent" not in self._inner_api_calls:
self._inner_api_calls[
"get_intent"] = google.api_core.gapic_v1.method.wrap_method(
self.transport.get_intent,
default_retry=self._method_configs["GetIntent"].retry,
default_timeout=self._method_configs["GetIntent"].timeout,
client_info=self._client_info,
)
request = intent_pb2.GetIntentRequest(name=name,
language_code=language_code,
intent_view=intent_view)
if metadata is None:
metadata = []
metadata = list(metadata)
try:
routing_header = [("name", name)]
except AttributeError:
pass
else:
routing_metadata = google.api_core.gapic_v1.routing_header.to_grpc_metadata(
routing_header)
metadata.append(routing_metadata)
return self._inner_api_calls["get_intent"](request,
retry=retry,
timeout=timeout,
metadata=metadata)