docs: Add dialogflow cx detect intent with disabled webhook snippet (#422)

nicain · web-flow · commit 406e84dabb88 · 2022-07-06T11:33:14.000-07:00
* docs: Add dialogflow cx detect intent with disabled webhook snippet

* Update detect_intent_disabled_webhook_test.py
diff --git a/samples/snippets/detect_intent_disabled_webhook.py b/samples/snippets/detect_intent_disabled_webhook.py
@@ -0,0 +1,95 @@
+#!/usr/bin/env python
+
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""DialogFlow Detect Intent Python sample, with a disabled webhook."""
+
+
+# [START dialogflow_cx_detect_intent_with_disabled_webhook]
+import uuid
+
+from google.cloud.dialogflowcx_v3.services.sessions import SessionsClient
+from google.cloud.dialogflowcx_v3.types import session
+
+
+def run_sample():
+    # TODO(developer): Update these values when running the function
+    project_id = "YOUR-PROJECT-ID"
+    location = "YOUR-LOCATION-ID"
+    agent_id = "YOUR-AGENT-ID"
+    text = "Perfect!"
+    language_code = "en-us"
+
+    detect_intent_disabled_webhook(
+        project_id,
+        location,
+        agent_id,
+        text,
+        language_code,
+    )
+
+
+def detect_intent_disabled_webhook(
+    project_id,
+    location,
+    agent_id,
+    text,
+    language_code,
+):
+    """Returns the result of detect intent with sentiment analysis"""
+
+    client_options = None
+    if location != "global":
+        api_endpoint = f"{location}-dialogflow.googleapis.com:443"
+        print(f"API Endpoint: {api_endpoint}\n")
+        client_options = {"api_endpoint": api_endpoint}
+    session_client = SessionsClient(client_options=client_options)
+    session_id = str(uuid.uuid4())
+    session_path = session_client.session_path(
+        project=project_id,
+        location=location,
+        agent=agent_id,
+        session=session_id,
+    )
+
+    # Prepare request
+    text_input = session.TextInput(text=text)
+    query_input = session.QueryInput(
+      text=text_input,
+      language_code=language_code
+    )
+    query_params = session.QueryParameters(
+      disable_webhook=True,
+    )
+    request = session.DetectIntentRequest(
+        session=session_path,
+        query_input=query_input,
+        query_params=query_params,
+    )
+
+    response = session_client.detect_intent(request=request)
+    print(f'Detect Intent Request: {request.query_params.disable_webhook}')
+    response_text = []
+    for message in response.query_result.response_messages:
+        if message.text:
+            curr_response_text = message.text.text
+            print(f'Agent Response: {curr_response_text}')
+            response_text.append(curr_response_text)
+    return response_text
+# [END dialogflow_cx_detect_intent_with_disabled_webhook]
+
+
+if __name__ == "__main__":
+    run_sample()
diff --git a/samples/snippets/detect_intent_disabled_webhook_test.py b/samples/snippets/detect_intent_disabled_webhook_test.py
@@ -0,0 +1,42 @@
+# Copyright 2022, Google LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Tests for detect_intent_with_sentiment_analysis.py"""
+
+from __future__ import absolute_import
+
+import os
+
+from detect_intent_disabled_webhook import detect_intent_disabled_webhook
+
+
+PROJECT_ID = os.getenv("GOOGLE_CLOUD_PROJECT")
+AGENT_ID = os.getenv("AGENT_ID")
+
+
+def test_detect_intent_positive():
+    response_text_list = detect_intent_disabled_webhook(
+        PROJECT_ID,
+        'global',
+        AGENT_ID,
+        'Perfect!',
+        'en-us',
+    )
+    for response_text in response_text_list:
+        assert response_text[0] in [
+          'You are welcome!',
+          'It\'s my pleasure.',
+          'Anytime.',
+          'Of course.',
+          'It\'s my pleasure to serve you.',
+        ]
