google-cloud-dialogflow 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +8 -0
  3. data/LICENSE +201 -0
  4. data/README.md +32 -0
  5. data/lib/google/cloud/dialogflow.rb +452 -0
  6. data/lib/google/cloud/dialogflow/credentials.rb +30 -0
  7. data/lib/google/cloud/dialogflow/v2.rb +454 -0
  8. data/lib/google/cloud/dialogflow/v2/agent_pb.rb +87 -0
  9. data/lib/google/cloud/dialogflow/v2/agent_services_pb.rb +104 -0
  10. data/lib/google/cloud/dialogflow/v2/agents_client.rb +639 -0
  11. data/lib/google/cloud/dialogflow/v2/agents_client_config.json +56 -0
  12. data/lib/google/cloud/dialogflow/v2/context_pb.rb +59 -0
  13. data/lib/google/cloud/dialogflow/v2/context_services_pb.rb +71 -0
  14. data/lib/google/cloud/dialogflow/v2/contexts_client.rb +445 -0
  15. data/lib/google/cloud/dialogflow/v2/contexts_client_config.json +56 -0
  16. data/lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb +223 -0
  17. data/lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/context.rb +115 -0
  18. data/lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/entity_type.rb +290 -0
  19. data/lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/intent.rb +714 -0
  20. data/lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/session.rb +451 -0
  21. data/lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/session_entity_type.rb +134 -0
  22. data/lib/google/cloud/dialogflow/v2/doc/google/protobuf/any.rb +124 -0
  23. data/lib/google/cloud/dialogflow/v2/doc/google/protobuf/field_mask.rb +223 -0
  24. data/lib/google/cloud/dialogflow/v2/doc/google/protobuf/struct.rb +73 -0
  25. data/lib/google/cloud/dialogflow/v2/doc/google/rpc/status.rb +83 -0
  26. data/lib/google/cloud/dialogflow/v2/doc/google/type/latlng.rb +64 -0
  27. data/lib/google/cloud/dialogflow/v2/doc/overview.rb +55 -0
  28. data/lib/google/cloud/dialogflow/v2/entity_type_pb.rb +120 -0
  29. data/lib/google/cloud/dialogflow/v2/entity_type_services_pb.rb +105 -0
  30. data/lib/google/cloud/dialogflow/v2/entity_types_client.rb +900 -0
  31. data/lib/google/cloud/dialogflow/v2/entity_types_client_config.json +76 -0
  32. data/lib/google/cloud/dialogflow/v2/intent_pb.rb +274 -0
  33. data/lib/google/cloud/dialogflow/v2/intent_services_pb.rb +91 -0
  34. data/lib/google/cloud/dialogflow/v2/intents_client.rb +684 -0
  35. data/lib/google/cloud/dialogflow/v2/intents_client_config.json +61 -0
  36. data/lib/google/cloud/dialogflow/v2/session_entity_type_pb.rb +61 -0
  37. data/lib/google/cloud/dialogflow/v2/session_entity_type_services_pb.rb +64 -0
  38. data/lib/google/cloud/dialogflow/v2/session_entity_types_client.rb +413 -0
  39. data/lib/google/cloud/dialogflow/v2/session_entity_types_client_config.json +51 -0
  40. data/lib/google/cloud/dialogflow/v2/session_pb.rb +127 -0
  41. data/lib/google/cloud/dialogflow/v2/session_services_pb.rb +55 -0
  42. data/lib/google/cloud/dialogflow/v2/sessions_client.rb +286 -0
  43. data/lib/google/cloud/dialogflow/v2/sessions_client_config.json +36 -0
  44. data/lib/google/cloud/dialogflow/v2/webhook_pb.rb +42 -0
  45. metadata +142 -0
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 229a61fb2d5d02dd466058f0e1b90b9a84619f933fd9c0a0432c7cf4c3c48813
4
+ data.tar.gz: 275e5947988d587ffe13cda4443e53ced1413ec28af0cae376eb872ca5305eae
5
+ SHA512:
6
+ metadata.gz: c204361b8718a32cb8dc3fdfdcea688b30a1bf566dee881ee8b3a770558b15c99f0ccbbcd8496adb76b13e8cd323381cee5da9d4f47095ba49915aed6d82b0ae
7
+ data.tar.gz: 5080029d8710ec1bd5894c80af56f9c5cf38efc57156970e44e847b5edecf9b38dd8c47237c859e2d0e999bb32990f721c9ba36195b94b541e23072aea3fc372
@@ -0,0 +1,8 @@
1
+ --no-private
2
+ --title=Dialogflow API
3
+ --exclude _pb\.rb$
4
+ --markup markdown
5
+
6
+ ./lib/**/*.rb
7
+ -
8
+ README.md
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ https://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ https://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,32 @@
1
+ # Ruby Client for Dialogflow API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
2
+
3
+ [Dialogflow API][Product Documentation]:
4
+ An end-to-end development suite for conversational interfaces (e.g.,
5
+ chatbots, voice-powered apps and devices).
6
+ - [Client Library Documentation][]
7
+ - [Product Documentation][]
8
+
9
+ ## Quick Start
10
+ In order to use this library, you first need to go through the following
11
+ steps:
12
+
13
+ 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
14
+ 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
15
+ 3. [Enable the Dialogflow API.](https://console.cloud.google.com/apis/library/dialogflow.googleapis.com)
16
+ 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
17
+
18
+ ### Installation
19
+ ```
20
+ $ gem install google-cloud-dialogflow
21
+ ```
22
+
23
+ ### Next Steps
24
+ - Read the [Client Library Documentation][https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-dialogflow/latest/google/cloud/dialogflow] for Dialogflow API
25
+ to see other available methods on the client.
26
+ - Read the [Dialogflow API Product documentation][Product Documentation]
27
+ to learn more about the product and see How-to Guides.
28
+ - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
29
+ to see the full list of Cloud APIs that we cover.
30
+
31
+ [Client Library Documentation]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-dialogflow/latest/google/cloud/dialogflow/v2
32
+ [Product Documentation]: https://cloud.google.com/dialogflow
@@ -0,0 +1,452 @@
1
+ # Copyright 2018 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # https://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require "google/gax"
16
+ require "pathname"
17
+
18
+ module Google
19
+ module Cloud
20
+ # rubocop:disable LineLength
21
+
22
+ ##
23
+ # # Ruby Client for Dialogflow API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
24
+ #
25
+ # [Dialogflow API][Product Documentation]:
26
+ # An end-to-end development suite for conversational interfaces (e.g.,
27
+ # chatbots, voice-powered apps and devices).
28
+ # - [Product Documentation][]
29
+ #
30
+ # ## Quick Start
31
+ # In order to use this library, you first need to go through the following
32
+ # steps:
33
+ #
34
+ # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
35
+ # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
36
+ # 3. [Enable the Dialogflow API.](https://console.cloud.google.com/apis/api/dialogflow)
37
+ # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
38
+ #
39
+ # ### Next Steps
40
+ # - Read the [Dialogflow API Product documentation][Product Documentation]
41
+ # to learn more about the product and see How-to Guides.
42
+ # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
43
+ # to see the full list of Cloud APIs that we cover.
44
+ #
45
+ # [Product Documentation]: https://cloud.google.com/dialogflow
46
+ #
47
+ #
48
+ module Dialogflow
49
+ # rubocop:enable LineLength
50
+
51
+ FILE_DIR = File.realdirpath(Pathname.new(__FILE__).join("..").join("dialogflow"))
52
+
53
+ AVAILABLE_VERSIONS = Dir["#{FILE_DIR}/*"]
54
+ .select { |file| File.directory?(file) }
55
+ .select { |dir| Google::Gax::VERSION_MATCHER.match(File.basename(dir)) }
56
+ .select { |dir| File.exist?(dir + ".rb") }
57
+ .map { |dir| File.basename(dir) }
58
+
59
+ module Agents
60
+ ##
61
+ # Agents are best described as Natural Language Understanding (NLU) modules
62
+ # that transform user requests into actionable data. You can include agents
63
+ # in your app, product, or service to determine user intent and respond to the
64
+ # user in a natural way.
65
+ #
66
+ # After you create an agent, you can add {Google::Cloud::Dialogflow::V2::Intents Intents}, {Google::Cloud::Dialogflow::V2::Contexts Contexts},
67
+ # {Google::Cloud::Dialogflow::V2::EntityTypes Entity Types}, {Google::Cloud::Dialogflow::V2::WebhookRequest Webhooks}, and so on to
68
+ # manage the flow of a conversation and match user input to predefined intents
69
+ # and actions.
70
+ #
71
+ # You can create an agent using both Dialogflow Standard Edition and
72
+ # Dialogflow Enterprise Edition. For details, see
73
+ # [Dialogflow Editions](https://cloud.google.com/dialogflow-enterprise/docs/editions).
74
+ #
75
+ # You can save your agent for backup or versioning by exporting the agent by
76
+ # using the {Google::Cloud::Dialogflow::V2::Agents::ExportAgent ExportAgent} method. You can import a saved
77
+ # agent by using the {Google::Cloud::Dialogflow::V2::Agents::ImportAgent ImportAgent} method.
78
+ #
79
+ # Dialogflow provides several
80
+ # [prebuilt agents](https://dialogflow.com/docs/prebuilt-agents) for common
81
+ # conversation scenarios such as determining a date and time, converting
82
+ # currency, and so on.
83
+ #
84
+ # For more information about agents, see the
85
+ # [Dialogflow documentation](https://dialogflow.com/docs/agents).
86
+ #
87
+ # @param version [Symbol, String]
88
+ # The major version of the service to be used. By default :v2
89
+ # is used.
90
+ # @overload new(version:, credentials:, scopes:, client_config:, timeout:)
91
+ # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
92
+ # Provides the means for authenticating requests made by the client. This parameter can
93
+ # be many types.
94
+ # A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
95
+ # authenticating requests made by this client.
96
+ # A `String` will be treated as the path to the keyfile to be used for the construction of
97
+ # credentials for this client.
98
+ # A `Hash` will be treated as the contents of a keyfile to be used for the construction of
99
+ # credentials for this client.
100
+ # A `GRPC::Core::Channel` will be used to make calls through.
101
+ # A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
102
+ # should already be composed with a `GRPC::Core::CallCredentials` object.
103
+ # A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
104
+ # metadata for requests, generally, to give OAuth credentials.
105
+ # @param scopes [Array<String>]
106
+ # The OAuth scopes for this service. This parameter is ignored if
107
+ # an updater_proc is supplied.
108
+ # @param client_config [Hash]
109
+ # A Hash for call options for each method. See
110
+ # Google::Gax#construct_settings for the structure of
111
+ # this data. Falls back to the default config if not specified
112
+ # or the specified config is missing data points.
113
+ # @param timeout [Numeric]
114
+ # The default timeout, in seconds, for calls made through this client.
115
+ def self.new(*args, version: :v2, **kwargs)
116
+ unless AVAILABLE_VERSIONS.include?(version.to_s.downcase)
117
+ raise "The version: #{version} is not available. The available versions " \
118
+ "are: [#{AVAILABLE_VERSIONS.join(", ")}]"
119
+ end
120
+
121
+ require "#{FILE_DIR}/#{version.to_s.downcase}"
122
+ version_module = Google::Cloud::Dialogflow
123
+ .constants
124
+ .select {|sym| sym.to_s.downcase == version.to_s.downcase}
125
+ .first
126
+ Google::Cloud::Dialogflow.const_get(version_module)::Agents.new(*args, **kwargs)
127
+ end
128
+ end
129
+
130
+ module Contexts
131
+ ##
132
+ # A context represents additional information included with user input or with
133
+ # an intent returned by the Dialogflow API. Contexts are helpful for
134
+ # differentiating user input which may be vague or have a different meaning
135
+ # depending on additional details from your application such as user setting
136
+ # and preferences, previous user input, where the user is in your application,
137
+ # geographic location, and so on.
138
+ #
139
+ # You can include contexts as input parameters of a
140
+ # {Google::Cloud::Dialogflow::V2::Sessions::DetectIntent DetectIntent} (or
141
+ # {Google::Cloud::Dialogflow::V2::Sessions::StreamingDetectIntent StreamingDetectIntent}) request,
142
+ # or as output contexts included in the returned intent.
143
+ # Contexts expire when an intent is matched, after the number of +DetectIntent+
144
+ # requests specified by the +lifespan_count+ parameter, or after 10 minutes
145
+ # if no intents are matched for a +DetectIntent+ request.
146
+ #
147
+ # For more information about contexts, see the
148
+ # [Dialogflow documentation](https://dialogflow.com/docs/contexts).
149
+ #
150
+ # @param version [Symbol, String]
151
+ # The major version of the service to be used. By default :v2
152
+ # is used.
153
+ # @overload new(version:, credentials:, scopes:, client_config:, timeout:)
154
+ # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
155
+ # Provides the means for authenticating requests made by the client. This parameter can
156
+ # be many types.
157
+ # A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
158
+ # authenticating requests made by this client.
159
+ # A `String` will be treated as the path to the keyfile to be used for the construction of
160
+ # credentials for this client.
161
+ # A `Hash` will be treated as the contents of a keyfile to be used for the construction of
162
+ # credentials for this client.
163
+ # A `GRPC::Core::Channel` will be used to make calls through.
164
+ # A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
165
+ # should already be composed with a `GRPC::Core::CallCredentials` object.
166
+ # A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
167
+ # metadata for requests, generally, to give OAuth credentials.
168
+ # @param scopes [Array<String>]
169
+ # The OAuth scopes for this service. This parameter is ignored if
170
+ # an updater_proc is supplied.
171
+ # @param client_config [Hash]
172
+ # A Hash for call options for each method. See
173
+ # Google::Gax#construct_settings for the structure of
174
+ # this data. Falls back to the default config if not specified
175
+ # or the specified config is missing data points.
176
+ # @param timeout [Numeric]
177
+ # The default timeout, in seconds, for calls made through this client.
178
+ def self.new(*args, version: :v2, **kwargs)
179
+ unless AVAILABLE_VERSIONS.include?(version.to_s.downcase)
180
+ raise "The version: #{version} is not available. The available versions " \
181
+ "are: [#{AVAILABLE_VERSIONS.join(", ")}]"
182
+ end
183
+
184
+ require "#{FILE_DIR}/#{version.to_s.downcase}"
185
+ version_module = Google::Cloud::Dialogflow
186
+ .constants
187
+ .select {|sym| sym.to_s.downcase == version.to_s.downcase}
188
+ .first
189
+ Google::Cloud::Dialogflow.const_get(version_module)::Contexts.new(*args, **kwargs)
190
+ end
191
+ end
192
+
193
+ module EntityTypes
194
+ ##
195
+ # Entities are extracted from user input and represent parameters that are
196
+ # meaningful to your application. For example, a date range, a proper name
197
+ # such as a geographic location or landmark, and so on. Entities represent
198
+ # actionable data for your application.
199
+ #
200
+ # When you define an entity, you can also include synonyms that all map to
201
+ # that entity. For example, "soft drink", "soda", "pop", and so on.
202
+ #
203
+ # There are three types of entities:
204
+ #
205
+ # * **System** - entities that are defined by the Dialogflow API for common
206
+ # data types such as date, time, currency, and so on. A system entity is
207
+ # represented by the +EntityType+ type.
208
+ #
209
+ # * **Developer** - entities that are defined by you that represent
210
+ # actionable data that is meaningful to your application. For example,
211
+ # you could define a +pizza.sauce+ entity for red or white pizza sauce,
212
+ # a +pizza.cheese+ entity for the different types of cheese on a pizza,
213
+ # a +pizza.topping+ entity for different toppings, and so on. A developer
214
+ # entity is represented by the +EntityType+ type.
215
+ #
216
+ # * **User** - entities that are built for an individual user such as
217
+ # favorites, preferences, playlists, and so on. A user entity is
218
+ # represented by the {Google::Cloud::Dialogflow::V2::SessionEntityType SessionEntityType} type.
219
+ #
220
+ # For more information about entity types, see the
221
+ # [Dialogflow documentation](https://dialogflow.com/docs/entities).
222
+ #
223
+ # @param version [Symbol, String]
224
+ # The major version of the service to be used. By default :v2
225
+ # is used.
226
+ # @overload new(version:, credentials:, scopes:, client_config:, timeout:)
227
+ # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
228
+ # Provides the means for authenticating requests made by the client. This parameter can
229
+ # be many types.
230
+ # A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
231
+ # authenticating requests made by this client.
232
+ # A `String` will be treated as the path to the keyfile to be used for the construction of
233
+ # credentials for this client.
234
+ # A `Hash` will be treated as the contents of a keyfile to be used for the construction of
235
+ # credentials for this client.
236
+ # A `GRPC::Core::Channel` will be used to make calls through.
237
+ # A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
238
+ # should already be composed with a `GRPC::Core::CallCredentials` object.
239
+ # A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
240
+ # metadata for requests, generally, to give OAuth credentials.
241
+ # @param scopes [Array<String>]
242
+ # The OAuth scopes for this service. This parameter is ignored if
243
+ # an updater_proc is supplied.
244
+ # @param client_config [Hash]
245
+ # A Hash for call options for each method. See
246
+ # Google::Gax#construct_settings for the structure of
247
+ # this data. Falls back to the default config if not specified
248
+ # or the specified config is missing data points.
249
+ # @param timeout [Numeric]
250
+ # The default timeout, in seconds, for calls made through this client.
251
+ def self.new(*args, version: :v2, **kwargs)
252
+ unless AVAILABLE_VERSIONS.include?(version.to_s.downcase)
253
+ raise "The version: #{version} is not available. The available versions " \
254
+ "are: [#{AVAILABLE_VERSIONS.join(", ")}]"
255
+ end
256
+
257
+ require "#{FILE_DIR}/#{version.to_s.downcase}"
258
+ version_module = Google::Cloud::Dialogflow
259
+ .constants
260
+ .select {|sym| sym.to_s.downcase == version.to_s.downcase}
261
+ .first
262
+ Google::Cloud::Dialogflow.const_get(version_module)::EntityTypes.new(*args, **kwargs)
263
+ end
264
+ end
265
+
266
+ module Intents
267
+ ##
268
+ # An intent represents a mapping between input from a user and an action to
269
+ # be taken by your application. When you pass user input to the
270
+ # {Google::Cloud::Dialogflow::V2::Sessions::DetectIntent DetectIntent} (or
271
+ # {Google::Cloud::Dialogflow::V2::Sessions::StreamingDetectIntent StreamingDetectIntent}) method, the
272
+ # Dialogflow API analyzes the input and searches
273
+ # for a matching intent. If no match is found, the Dialogflow API returns a
274
+ # fallback intent (+is_fallback+ = true).
275
+ #
276
+ # You can provide additional information for the Dialogflow API to use to
277
+ # match user input to an intent by adding the following to your intent.
278
+ #
279
+ # * **Contexts** - provide additional context for intent analysis. For
280
+ # example, if an intent is related to an object in your application that
281
+ # plays music, you can provide a context to determine when to match the
282
+ # intent if the user input is “turn it off”. You can include a context
283
+ # that matches the intent when there is previous user input of
284
+ # "play music", and not when there is previous user input of
285
+ # "turn on the light".
286
+ #
287
+ # * **Events** - allow for matching an intent by using an event name
288
+ # instead of user input. Your application can provide an event name and
289
+ # related parameters to the Dialogflow API to match an intent. For
290
+ # example, when your application starts, you can send a welcome event
291
+ # with a user name parameter to the Dialogflow API to match an intent with
292
+ # a personalized welcome message for the user.
293
+ #
294
+ # * **Training phrases** - provide examples of user input to train the
295
+ # Dialogflow API agent to better match intents.
296
+ #
297
+ # For more information about intents, see the
298
+ # [Dialogflow documentation](https://dialogflow.com/docs/intents).
299
+ #
300
+ # @param version [Symbol, String]
301
+ # The major version of the service to be used. By default :v2
302
+ # is used.
303
+ # @overload new(version:, credentials:, scopes:, client_config:, timeout:)
304
+ # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
305
+ # Provides the means for authenticating requests made by the client. This parameter can
306
+ # be many types.
307
+ # A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
308
+ # authenticating requests made by this client.
309
+ # A `String` will be treated as the path to the keyfile to be used for the construction of
310
+ # credentials for this client.
311
+ # A `Hash` will be treated as the contents of a keyfile to be used for the construction of
312
+ # credentials for this client.
313
+ # A `GRPC::Core::Channel` will be used to make calls through.
314
+ # A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
315
+ # should already be composed with a `GRPC::Core::CallCredentials` object.
316
+ # A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
317
+ # metadata for requests, generally, to give OAuth credentials.
318
+ # @param scopes [Array<String>]
319
+ # The OAuth scopes for this service. This parameter is ignored if
320
+ # an updater_proc is supplied.
321
+ # @param client_config [Hash]
322
+ # A Hash for call options for each method. See
323
+ # Google::Gax#construct_settings for the structure of
324
+ # this data. Falls back to the default config if not specified
325
+ # or the specified config is missing data points.
326
+ # @param timeout [Numeric]
327
+ # The default timeout, in seconds, for calls made through this client.
328
+ def self.new(*args, version: :v2, **kwargs)
329
+ unless AVAILABLE_VERSIONS.include?(version.to_s.downcase)
330
+ raise "The version: #{version} is not available. The available versions " \
331
+ "are: [#{AVAILABLE_VERSIONS.join(", ")}]"
332
+ end
333
+
334
+ require "#{FILE_DIR}/#{version.to_s.downcase}"
335
+ version_module = Google::Cloud::Dialogflow
336
+ .constants
337
+ .select {|sym| sym.to_s.downcase == version.to_s.downcase}
338
+ .first
339
+ Google::Cloud::Dialogflow.const_get(version_module)::Intents.new(*args, **kwargs)
340
+ end
341
+ end
342
+
343
+ module SessionEntityTypes
344
+ ##
345
+ # Entities are extracted from user input and represent parameters that are
346
+ # meaningful to your application. For example, a date range, a proper name
347
+ # such as a geographic location or landmark, and so on. Entities represent
348
+ # actionable data for your application.
349
+ #
350
+ # Session entity types are referred to as **User** entity types and are
351
+ # entities that are built for an individual user such as
352
+ # favorites, preferences, playlists, and so on. You can redefine a session
353
+ # entity type at the session level.
354
+ #
355
+ # For more information about entity types, see the
356
+ # [Dialogflow documentation](https://dialogflow.com/docs/entities).
357
+ #
358
+ # @param version [Symbol, String]
359
+ # The major version of the service to be used. By default :v2
360
+ # is used.
361
+ # @overload new(version:, credentials:, scopes:, client_config:, timeout:)
362
+ # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
363
+ # Provides the means for authenticating requests made by the client. This parameter can
364
+ # be many types.
365
+ # A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
366
+ # authenticating requests made by this client.
367
+ # A `String` will be treated as the path to the keyfile to be used for the construction of
368
+ # credentials for this client.
369
+ # A `Hash` will be treated as the contents of a keyfile to be used for the construction of
370
+ # credentials for this client.
371
+ # A `GRPC::Core::Channel` will be used to make calls through.
372
+ # A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
373
+ # should already be composed with a `GRPC::Core::CallCredentials` object.
374
+ # A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
375
+ # metadata for requests, generally, to give OAuth credentials.
376
+ # @param scopes [Array<String>]
377
+ # The OAuth scopes for this service. This parameter is ignored if
378
+ # an updater_proc is supplied.
379
+ # @param client_config [Hash]
380
+ # A Hash for call options for each method. See
381
+ # Google::Gax#construct_settings for the structure of
382
+ # this data. Falls back to the default config if not specified
383
+ # or the specified config is missing data points.
384
+ # @param timeout [Numeric]
385
+ # The default timeout, in seconds, for calls made through this client.
386
+ def self.new(*args, version: :v2, **kwargs)
387
+ unless AVAILABLE_VERSIONS.include?(version.to_s.downcase)
388
+ raise "The version: #{version} is not available. The available versions " \
389
+ "are: [#{AVAILABLE_VERSIONS.join(", ")}]"
390
+ end
391
+
392
+ require "#{FILE_DIR}/#{version.to_s.downcase}"
393
+ version_module = Google::Cloud::Dialogflow
394
+ .constants
395
+ .select {|sym| sym.to_s.downcase == version.to_s.downcase}
396
+ .first
397
+ Google::Cloud::Dialogflow.const_get(version_module)::SessionEntityTypes.new(*args, **kwargs)
398
+ end
399
+ end
400
+
401
+ module Sessions
402
+ ##
403
+ # A session represents an interaction with a user. You retrieve user input
404
+ # and pass it to the {Google::Cloud::Dialogflow::V2::Sessions::DetectIntent DetectIntent} (or
405
+ # {Google::Cloud::Dialogflow::V2::Sessions::StreamingDetectIntent StreamingDetectIntent}) method to determine
406
+ # user intent and respond.
407
+ #
408
+ # @param version [Symbol, String]
409
+ # The major version of the service to be used. By default :v2
410
+ # is used.
411
+ # @overload new(version:, credentials:, scopes:, client_config:, timeout:)
412
+ # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
413
+ # Provides the means for authenticating requests made by the client. This parameter can
414
+ # be many types.
415
+ # A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
416
+ # authenticating requests made by this client.
417
+ # A `String` will be treated as the path to the keyfile to be used for the construction of
418
+ # credentials for this client.
419
+ # A `Hash` will be treated as the contents of a keyfile to be used for the construction of
420
+ # credentials for this client.
421
+ # A `GRPC::Core::Channel` will be used to make calls through.
422
+ # A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
423
+ # should already be composed with a `GRPC::Core::CallCredentials` object.
424
+ # A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
425
+ # metadata for requests, generally, to give OAuth credentials.
426
+ # @param scopes [Array<String>]
427
+ # The OAuth scopes for this service. This parameter is ignored if
428
+ # an updater_proc is supplied.
429
+ # @param client_config [Hash]
430
+ # A Hash for call options for each method. See
431
+ # Google::Gax#construct_settings for the structure of
432
+ # this data. Falls back to the default config if not specified
433
+ # or the specified config is missing data points.
434
+ # @param timeout [Numeric]
435
+ # The default timeout, in seconds, for calls made through this client.
436
+ def self.new(*args, version: :v2, **kwargs)
437
+ unless AVAILABLE_VERSIONS.include?(version.to_s.downcase)
438
+ raise "The version: #{version} is not available. The available versions " \
439
+ "are: [#{AVAILABLE_VERSIONS.join(", ")}]"
440
+ end
441
+
442
+ require "#{FILE_DIR}/#{version.to_s.downcase}"
443
+ version_module = Google::Cloud::Dialogflow
444
+ .constants
445
+ .select {|sym| sym.to_s.downcase == version.to_s.downcase}
446
+ .first
447
+ Google::Cloud::Dialogflow.const_get(version_module)::Sessions.new(*args, **kwargs)
448
+ end
449
+ end
450
+ end
451
+ end
452
+ end