|
1 |
| -Dialogflow: Python Client |
2 |
| -========================= |
| 1 | +Python Client for Dialogflow API |
| 2 | +================================ |
3 | 3 |
|
4 |
| -|ga| |pypi| |versions| |
| 4 | +|stable| |pypi| |versions| |
5 | 5 |
|
6 |
| - Python idiomatic client for `Dialogflow ES`_ |
| 6 | +`Dialogflow API`_: is an end-to-end, build-once deploy-everywhere development suite for creating conversational interfaces for websites, mobile applications, popular messaging platforms, and IoT devices. You can use it to build interfaces (such as chatbots and conversational IVR) that enable natural and rich interactions between your users and your business. Dialogflow Enterprise Edition users have access to Google Cloud Support and a service level agreement (SLA) for production deployments. |
7 | 7 |
|
8 |
| -`Dialogflow ES`_ is an enterprise-grade NLU platform that makes it easy for |
9 |
| -developers to design and integrate conversational user interfaces into |
10 |
| -mobile apps, web applications, devices, and bots. |
| 8 | +- `Client Library Documentation`_ |
| 9 | +- `Product Documentation`_ |
11 | 10 |
|
12 |
| -* `Dialogflow ES Python Client API Reference <https://cloud.google.com/python/docs/reference/dialogflow/latest/index.html>`_ |
13 |
| -* `Dialogflow ES Documentation <https://cloud.google.com/dialogflow/es/docs>`_ |
14 |
| - |
15 |
| -Read more about the client libraries for Cloud APIs, including the older |
16 |
| -Google APIs Client Libraries, in |
17 |
| -`Client Libraries Explained <https://cloud.google.com/apis/docs/client-libraries-explained>`_. |
18 |
| - |
19 |
| -.. |ga| image:: https://img.shields.io/badge/support-ga-gold.svg |
20 |
| - :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#ga-support |
| 11 | +.. |stable| image:: https://img.shields.io/badge/support-stable-gold.svg |
| 12 | + :target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels |
21 | 13 | .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-dialogflow.svg
|
22 | 14 | :target: https://pypi.org/project/google-cloud-dialogflow/
|
23 | 15 | .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-dialogflow.svg
|
24 | 16 | :target: https://pypi.org/project/google-cloud-dialogflow/
|
25 |
| -.. _Dialogflow ES: https://cloud.google.com/dialogflow/docs/ |
| 17 | +.. _Dialogflow API: https://www.dialogflow.com/ |
| 18 | +.. _Client Library Documentation: https://cloud.google.com/python/docs/reference/dialogflow/latest |
| 19 | +.. _Product Documentation: https://www.dialogflow.com/ |
26 | 20 |
|
| 21 | +Quick Start |
| 22 | +----------- |
27 | 23 |
|
28 |
| -Before you begin |
29 |
| ----------------- |
| 24 | +In order to use this library, you first need to go through the following steps: |
30 | 25 |
|
31 |
| -#. Select or create a Cloud Platform `project`_. |
32 |
| -#. `Enable billing`_ for your project. |
33 |
| -#. `Enable the Google Cloud Dialogflow API`_. |
34 |
| -#. `Set up authentication`_ with a service account so you can access the |
35 |
| - API from your local workstation. |
36 |
| - |
37 |
| -.. _project: https://console.cloud.google.com/project |
38 |
| -.. _Enable billing: https://support.google.com/cloud/answer/6293499#enable-billing |
39 |
| -.. _Enable the Google Cloud Dialogflow API: https://console.cloud.google.com/flows/enableapi?apiid=dialogflow.googleapis.com |
40 |
| -.. _Set up authentication: https://cloud.google.com/docs/authentication/getting-started |
| 26 | +1. `Select or create a Cloud Platform project.`_ |
| 27 | +2. `Enable billing for your project.`_ |
| 28 | +3. `Enable the Dialogflow API.`_ |
| 29 | +4. `Setup Authentication.`_ |
41 | 30 |
|
| 31 | +.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project |
| 32 | +.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project |
| 33 | +.. _Enable the Dialogflow API.: https://www.dialogflow.com/ |
| 34 | +.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html |
42 | 35 |
|
43 | 36 | Installation
|
44 |
| ------------- |
| 37 | +~~~~~~~~~~~~ |
| 38 | + |
| 39 | +Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to |
| 40 | +create isolated Python environments. The basic problem it addresses is one of |
| 41 | +dependencies and versions, and indirectly permissions. |
45 | 42 |
|
46 |
| -.. code-block:: shell |
| 43 | +With `virtualenv`_, it's possible to install this library without needing system |
| 44 | +install permissions, and without clashing with the installed system |
| 45 | +dependencies. |
47 | 46 |
|
48 |
| - pip install google-cloud-dialogflow |
| 47 | +.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ |
49 | 48 |
|
50 |
| -.. note:: |
51 | 49 |
|
52 |
| - We highly recommend that you install this library in a |
53 |
| - `virtualenv <https://virtualenv.pypa.io/en/latest/>`_. |
| 50 | +Code samples and snippets |
| 51 | +~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 52 | + |
| 53 | +Code samples and snippets live in the `samples/` folder. |
54 | 54 |
|
55 | 55 |
|
56 | 56 | Supported Python Versions
|
57 | 57 | ^^^^^^^^^^^^^^^^^^^^^^^^^
|
58 |
| -Python >= 3.6 |
| 58 | +Our client libraries are compatible with all current [active](https://devguide.python.org/devcycle/#in-development-main-branch) and [maintenance](https://devguide.python.org/devcycle/#maintenance-branches) versions of |
| 59 | +Python. |
| 60 | + |
| 61 | +Python >= 3.7 |
59 | 62 |
|
60 | 63 | Unsupported Python Versions
|
61 | 64 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
62 |
| -The last version of this library compatible with Python 2.7 is dialogflow==1.1.0. |
63 |
| - |
| 65 | +Python <= 3.6 |
64 | 66 |
|
65 |
| -Usage |
66 |
| ------ |
| 67 | +If you are using an [end-of-life](https://devguide.python.org/devcycle/#end-of-life-branches) |
| 68 | +version of Python, we recommend that you update as soon as possible to an actively supported version. |
67 | 69 |
|
68 |
| -View `usage documentation <https://cloud.google.com/python/docs/reference/dialogflow/latest/index.html>`_. |
69 | 70 |
|
| 71 | +Mac/Linux |
| 72 | +^^^^^^^^^ |
70 | 73 |
|
71 |
| -Versioning |
72 |
| ----------- |
| 74 | +.. code-block:: console |
73 | 75 |
|
74 |
| -This library follows `Semantic Versioning <http://semver.org/>`_. |
| 76 | + pip install virtualenv |
| 77 | + virtualenv <your-env> |
| 78 | + source <your-env>/bin/activate |
| 79 | + <your-env>/bin/pip install google-cloud-dialogflow |
75 | 80 |
|
76 |
| -This library is considered to be stable. This means and that the code surface will not change in backwards-incompatible |
77 |
| -ways unless either absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation |
78 |
| -period. Issues and requests against GA libraries are addressed with the highest priority. |
79 | 81 |
|
80 |
| -More Information: `Google Cloud Python Library Support <https://github.com/googleapis/google-cloud-python/blob/master/README.rst#general-availability>`_ |
| 82 | +Windows |
| 83 | +^^^^^^^ |
81 | 84 |
|
82 |
| -Contributing |
83 |
| ------------- |
| 85 | +.. code-block:: console |
84 | 86 |
|
85 |
| -Contributions welcome! See the `Contributing Guide <https://github.com/googleapis/python-dialogflow/blob/main/.github/CONTRIBUTING.md>`_. |
| 87 | + pip install virtualenv |
| 88 | + virtualenv <your-env> |
| 89 | + <your-env>\Scripts\activate |
| 90 | + <your-env>\Scripts\pip.exe install google-cloud-dialogflow |
86 | 91 |
|
87 |
| -License |
88 |
| -------- |
| 92 | +Next Steps |
| 93 | +~~~~~~~~~~ |
89 | 94 |
|
90 |
| -Apache Version 2.0 |
| 95 | +- Read the `Client Library Documentation`_ for Dialogflow API |
| 96 | + to see other available methods on the client. |
| 97 | +- Read the `Dialogflow API Product documentation`_ to learn |
| 98 | + more about the product and see How-to Guides. |
| 99 | +- View this `README`_ to see the full list of Cloud |
| 100 | + APIs that we cover. |
91 | 101 |
|
92 |
| -See `the LICENSE file <https://github.com/googleapis/python-dialogflow/blob/main/LICENSE>`_ for more information. |
| 102 | +.. _Dialogflow API Product documentation: https://www.dialogflow.com/ |
| 103 | +.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst |
0 commit comments