This repository has been archived by the owner on Jan 6, 2024. It is now read-only.
docs(samples): add initial sample codes #13
Merged
Merged
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
61cf7f0
docs(samples): add initial sample codes
7c93f8e
Update samples/snippets/detect_intent_stream.py
wuyuexin 789541a
Update samples/snippets/detect_intent_stream.py
wuyuexin cd48cd6
Update samples/snippets/detect_intent_stream.py
wuyuexin 11c5b1f
changes according to review comments
24b99ad
Update samples/snippets/detect_intent_audio.py
wuyuexin 7cce532
Update samples/snippets/detect_intent_audio.py
wuyuexin b0435cb
changes according to review comments
f58495f
chore: add test requirements
busunkim96 f87e9b2
chore: add noxfile_config and authoring guide
busunkim96 File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,202 @@ | ||
.. This file is automatically generated. Do not edit this file directly. | ||
|
||
Dialogflow CX API Python Samples | ||
=============================================================================== | ||
|
||
.. image:: https://gstatic.com/cloudssh/images/open-btn.png | ||
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=/README.rst | ||
|
||
|
||
This directory contains samples for Dialogflow CX API. The `Dialogflow CX API`_ enables you to create conversational experiences across devices and platforms. | ||
|
||
|
||
|
||
|
||
.. _Dialogflow CX API: https://cloud.google.com/dialogflow/cx/docs/ | ||
|
||
|
||
|
||
|
||
|
||
|
||
Setup | ||
------------------------------------------------------------------------------- | ||
|
||
|
||
Authentication | ||
++++++++++++++ | ||
|
||
This sample requires you to have authentication setup. Refer to the | ||
`Authentication Getting Started Guide`_ for instructions on setting up | ||
credentials for applications. | ||
|
||
.. _Authentication Getting Started Guide: | ||
https://cloud.google.com/docs/authentication/getting-started | ||
|
||
Install Dependencies | ||
++++++++++++++++++++ | ||
|
||
#. Clone python-docs-samples and change directory to the sample directory you want to use. | ||
|
||
.. code-block:: bash | ||
|
||
$ git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git | ||
|
||
#. Install `pip`_ and `virtualenv`_ if you do not already have them. You may want to refer to the `Python Development Environment Setup Guide`_ for Google Cloud Platform for instructions. | ||
|
||
.. _Python Development Environment Setup Guide: | ||
https://cloud.google.com/python/setup | ||
|
||
#. Create a virtualenv. Samples are compatible with Python 2.7 and 3.4+. | ||
|
||
.. code-block:: bash | ||
|
||
$ virtualenv env | ||
$ source env/bin/activate | ||
|
||
#. Install the dependencies needed to run the samples. | ||
|
||
.. code-block:: bash | ||
|
||
$ pip install -r requirements.txt | ||
|
||
.. _pip: https://pip.pypa.io/ | ||
.. _virtualenv: https://virtualenv.pypa.io/ | ||
|
||
Samples | ||
------------------------------------------------------------------------------- | ||
|
||
Detect Intent Text | ||
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ | ||
|
||
.. image:: https://gstatic.com/cloudssh/images/open-btn.png | ||
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=/detect_intent_texts.py,/README.rst | ||
|
||
|
||
|
||
|
||
To run this sample: | ||
|
||
.. code-block:: bash | ||
|
||
$ python detect_intent_texts.py | ||
|
||
usage: detect_intent_texts.py [-h] --agent AGENT [--session-id SESSION_ID] | ||
[--language-code LANGUAGE_CODE] | ||
texts [texts ...] | ||
|
||
DialogFlow API Detect Intent Python sample with text inputs. | ||
|
||
Examples: | ||
python detect_intent_texts.py -h | ||
python detect_intent_texts.py --agent AGENT --session-id SESSION_ID "hello" "book a meeting room" "Mountain View" | ||
python detect_intent_texts.py --agent AGENT --session-id SESSION_ID "tomorrow" "10 AM" "2 hours" "10 people" "A" "yes" | ||
|
||
positional arguments: | ||
texts Text inputs. | ||
|
||
optional arguments: | ||
-h, --help show this help message and exit | ||
--agent AGENT Agent resource name. Required. | ||
--session-id SESSION_ID | ||
Identifier of the DetectIntent session. Defaults to a | ||
random UUID. | ||
--language-code LANGUAGE_CODE | ||
Language code of the query. Defaults to "en-US". | ||
|
||
|
||
|
||
Detect Intent Audio | ||
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ | ||
|
||
.. image:: https://gstatic.com/cloudssh/images/open-btn.png | ||
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=/detect_intent_audio.py,/README.rst | ||
|
||
|
||
|
||
|
||
To run this sample: | ||
|
||
.. code-block:: bash | ||
|
||
$ python detect_intent_audio.py | ||
|
||
usage: detect_intent_audio.py [-h] --agent AGENT [--session-id SESSION_ID] | ||
[--language-code LANGUAGE_CODE] | ||
--audio-file-path AUDIO_FILE_PATH | ||
|
||
DialogFlow API Detect Intent Python sample with audio file. | ||
|
||
Examples: | ||
python detect_intent_audio.py -h | ||
python detect_intent_audio.py --agent AGENT --session-id SESSION_ID --audio-file-path resources/hello.wav | ||
|
||
optional arguments: | ||
-h, --help show this help message and exit | ||
--agent AGENT Agent resource name. Required. | ||
--session-id SESSION_ID | ||
Identifier of the DetectIntent session. Defaults to a | ||
random UUID. | ||
--language-code LANGUAGE_CODE | ||
Language code of the query. Defaults to "en-US". | ||
--audio-file-path AUDIO_FILE_PATH | ||
Path to the audio file. | ||
|
||
|
||
|
||
Detect Intent Stream | ||
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ | ||
|
||
.. image:: https://gstatic.com/cloudssh/images/open-btn.png | ||
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=/detect_intent_stream.py,/README.rst | ||
|
||
|
||
|
||
|
||
To run this sample: | ||
|
||
.. code-block:: bash | ||
|
||
$ python detect_intent_stream.py | ||
|
||
usage: detect_intent_stream.py [-h] --agent AGENT [--session-id SESSION_ID] | ||
[--language-code LANGUAGE_CODE] | ||
--audio-file-path AUDIO_FILE_PATH | ||
|
||
DialogFlow API Detect Intent Python sample with audio files processed as an audio stream. | ||
|
||
Examples: | ||
python detect_intent_stream.py -h | ||
python detect_intent_stream.py --agent AGENT --session-id SESSION_ID --audio-file-path resources/hello.wav | ||
|
||
optional arguments: | ||
-h, --help show this help message and exit | ||
--agent AGENT Agent resource name. Required. | ||
--session-id SESSION_ID | ||
Identifier of the DetectIntent session. Defaults to a | ||
random UUID. | ||
--language-code LANGUAGE_CODE | ||
Language code of the query. Defaults to "en-US". | ||
--audio-file-path AUDIO_FILE_PATH | ||
Path to the audio file. | ||
|
||
|
||
|
||
|
||
|
||
The client library | ||
------------------------------------------------------------------------------- | ||
|
||
This sample uses the `Google Cloud Client Library for Python`_. | ||
You can read the documentation for more details on API usage and use GitHub | ||
to `browse the source`_ and `report issues`_. | ||
|
||
.. _Google Cloud Client Library for Python: | ||
https://googlecloudplatform.github.io/google-cloud-python/ | ||
.. _browse the source: | ||
https://github.com/GoogleCloudPlatform/google-cloud-python | ||
.. _report issues: | ||
https://github.com/GoogleCloudPlatform/google-cloud-python/issues | ||
|
||
|
||
.. _Google Cloud SDK: https://cloud.google.com/sdk/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# This file is used to generate README.rst | ||
|
||
product: | ||
name: Dialogflow CX API | ||
short_name: Dialogflow CX API | ||
url: https://cloud.google.com/dialogflow/cx/docs/ | ||
description: > | ||
The `Dialogflow CX API`_ enables you to create conversational experiences across devices and platforms. | ||
|
||
setup: | ||
- auth | ||
- install_deps | ||
|
||
samples: | ||
- name: Detect Intent Text | ||
file: detect_intent_texts.py | ||
show_help: True | ||
- name: Detect Intent Audio | ||
file: detect_intent_audio.py | ||
show_help: True | ||
- name: Detect Intent Stream | ||
file: detect_intent_stream.py | ||
show_help: True | ||
|
||
cloud_client_library: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
#!/usr/bin/env python | ||
|
||
# Copyright 2020 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 API Detect Intent Python sample with audio file. | ||
|
||
Examples: | ||
python detect_intent_audio.py -h | ||
python detect_intent_audio.py --agent AGENT \ | ||
--session-id SESSION_ID --audio-file-path resources/hello.wav | ||
""" | ||
|
||
import argparse | ||
import uuid | ||
|
||
from google.cloud.dialogflowcx_v3beta1.services.sessions import SessionsClient | ||
from google.cloud.dialogflowcx_v3beta1.types import audio_config | ||
from google.cloud.dialogflowcx_v3beta1.types import session | ||
|
||
|
||
# [START dialogflow_detect_intent_audio] | ||
def detect_intent_audio(agent, session_id, audio_file_path, language_code): | ||
"""Returns the result of detect intent with an audio file as input. | ||
|
||
Using the same `session_id` between requests allows continuation | ||
of the conversation.""" | ||
session_client = SessionsClient() | ||
session_path = "{}/sessions/{}".format(agent, session_id) | ||
print("Session path: {}\n".format(session_path)) | ||
|
||
input_audio_config = audio_config.InputAudioConfig( | ||
audio_encoding=audio_config.AudioEncoding.AUDIO_ENCODING_LINEAR_16, | ||
sample_rate_hertz=24000, | ||
) | ||
|
||
with open(audio_file_path, "rb") as audio_file: | ||
input_audio = audio_file.read() | ||
|
||
audio_input = session.AudioInput(config=input_audio_config, audio=input_audio) | ||
query_input = session.QueryInput(audio=audio_input, language_code=language_code) | ||
request = session.DetectIntentRequest(session=session_path, query_input=query_input) | ||
response = session_client.detect_intent(request=request) | ||
|
||
print("=" * 20) | ||
print("Query text: {}".format(response.query_result.transcript)) | ||
print( | ||
"Response text: {}\n".format( | ||
" ".join( | ||
[ | ||
" ".join(response_message.text.text) | ||
for response_message in response.query_result.response_messages | ||
] | ||
) | ||
) | ||
) | ||
|
||
|
||
# [END dialogflow_detect_intent_audio] | ||
|
||
if __name__ == "__main__": | ||
parser = argparse.ArgumentParser( | ||
description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter | ||
) | ||
parser.add_argument( | ||
"--agent", help="Agent resource name. Required.", required=True | ||
) | ||
parser.add_argument( | ||
"--session-id", | ||
help="Identifier of the DetectIntent session. " "Defaults to a random UUID.", | ||
default=str(uuid.uuid4()), | ||
) | ||
parser.add_argument( | ||
"--language-code", | ||
help='Language code of the query. Defaults to "en-US".', | ||
default="en-US", | ||
) | ||
parser.add_argument( | ||
"--audio-file-path", help="Path to the audio file.", required=True | ||
) | ||
|
||
args = parser.parse_args() | ||
|
||
detect_intent_audio( | ||
args.agent, args.session_id, args.audio_file_path, args.language_code | ||
) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Copyright 2020, 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_texts.""" | ||
|
||
from __future__ import absolute_import | ||
|
||
import os | ||
import uuid | ||
|
||
|
||
from detect_intent_audio import detect_intent_audio | ||
|
||
DIRNAME = os.path.realpath(os.path.dirname(__file__)) | ||
PROJECT_ID = os.getenv("GOOGLE_CLOUD_PROJECT") | ||
AGENT_ID = "53516802-3e2a-4016-80b6-a3df0d240240" | ||
AGENT = "projects/{}/locations/global/agents/{}".format(PROJECT_ID, AGENT_ID) | ||
SESSION_ID = uuid.uuid4() | ||
AUDIO = "{}/resources/hello.wav".format(DIRNAME) | ||
|
||
|
||
def test_detect_intent_texts(capsys): | ||
detect_intent_audio(AGENT, SESSION_ID, AUDIO, "en-US") | ||
out, _ = capsys.readouterr() | ||
|
||
assert "Response text: Hi! I'm the virtual flights agent." in out |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This region tag should be above the
run_sample
function