google-cloud-dialogflow-cx-v3 0.2.0 → 0.5.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +1 -1
- data/AUTHENTICATION.md +7 -25
- data/lib/google/cloud/dialogflow/cx/v3/agents/client.rb +201 -27
- data/lib/google/cloud/dialogflow/cx/v3/agents/operations.rb +115 -12
- data/lib/google/cloud/dialogflow/cx/v3/changelog_pb.rb +52 -0
- data/lib/google/cloud/dialogflow/cx/v3/changelog_services_pb.rb +49 -0
- data/lib/google/cloud/dialogflow/cx/v3/changelogs/client.rb +522 -0
- data/lib/google/cloud/dialogflow/cx/v3/changelogs/credentials.rb +54 -0
- data/lib/google/cloud/dialogflow/cx/v3/changelogs/paths.rb +75 -0
- data/lib/google/cloud/dialogflow/cx/v3/changelogs.rb +51 -0
- data/lib/google/cloud/dialogflow/cx/v3/deployments/client.rb +46 -6
- data/lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb +106 -15
- data/lib/google/cloud/dialogflow/cx/v3/environment_pb.rb +1 -0
- data/lib/google/cloud/dialogflow/cx/v3/environments/client.rb +227 -27
- data/lib/google/cloud/dialogflow/cx/v3/environments/operations.rb +115 -12
- data/lib/google/cloud/dialogflow/cx/v3/experiments/client.rb +146 -21
- data/lib/google/cloud/dialogflow/cx/v3/flows/client.rb +228 -30
- data/lib/google/cloud/dialogflow/cx/v3/flows/operations.rb +115 -12
- data/lib/google/cloud/dialogflow/cx/v3/intents/client.rb +106 -15
- data/lib/google/cloud/dialogflow/cx/v3/pages/client.rb +106 -15
- data/lib/google/cloud/dialogflow/cx/v3/response_message_pb.rb +7 -0
- data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/client.rb +106 -15
- data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/client.rb +106 -15
- data/lib/google/cloud/dialogflow/cx/v3/sessions/client.rb +84 -9
- data/lib/google/cloud/dialogflow/cx/v3/test_cases/client.rb +281 -36
- data/lib/google/cloud/dialogflow/cx/v3/test_cases/operations.rb +115 -12
- data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/client.rb +106 -15
- data/lib/google/cloud/dialogflow/cx/v3/version.rb +1 -1
- data/lib/google/cloud/dialogflow/cx/v3/version_pb.rb +12 -0
- data/lib/google/cloud/dialogflow/cx/v3/version_services_pb.rb +2 -0
- data/lib/google/cloud/dialogflow/cx/v3/versions/client.rb +250 -18
- data/lib/google/cloud/dialogflow/cx/v3/versions/operations.rb +115 -12
- data/lib/google/cloud/dialogflow/cx/v3/webhook_pb.rb +2 -0
- data/lib/google/cloud/dialogflow/cx/v3/webhooks/client.rb +106 -15
- data/lib/google/cloud/dialogflow/cx/v3.rb +2 -1
- data/proto_docs/google/api/resource.rb +10 -71
- data/proto_docs/google/cloud/dialogflow/cx/v3/changelog.rb +122 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/response_message.rb +15 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/security_settings.rb +11 -1
- data/proto_docs/google/cloud/dialogflow/cx/v3/session.rb +54 -42
- data/proto_docs/google/cloud/dialogflow/cx/v3/version.rb +43 -0
- data/proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb +17 -0
- metadata +10 -3
@@ -129,6 +129,11 @@ module Google
|
|
129
129
|
# [DLP](https://cloud.google.com/dlp/docs) inspect template name. Use this
|
130
130
|
# template to define inspect base settings.
|
131
131
|
#
|
132
|
+
# The `DLP Inspect Templates Reader` role is needed on the Dialogflow
|
133
|
+
# service identity service account (has the form
|
134
|
+
# `service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com`)
|
135
|
+
# for your agent's project.
|
136
|
+
#
|
132
137
|
# If empty, we use the default DLP inspect config.
|
133
138
|
#
|
134
139
|
# The template name will have one of the following formats:
|
@@ -143,6 +148,11 @@ module Google
|
|
143
148
|
# [DLP](https://cloud.google.com/dlp/docs) deidentify template name. Use this
|
144
149
|
# template to define de-identification configuration for the content.
|
145
150
|
#
|
151
|
+
# The `DLP De-identify Templates Reader` role is needed on the Dialogflow
|
152
|
+
# service identity service account (has the form
|
153
|
+
# `service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com`)
|
154
|
+
# for your agent's project.
|
155
|
+
#
|
146
156
|
# If empty, Dialogflow replaces sensitive info with `[redacted]` text.
|
147
157
|
#
|
148
158
|
# The template name will have one of the following formats:
|
@@ -157,7 +167,7 @@ module Google
|
|
157
167
|
# Retains data in interaction logging for the specified number of days.
|
158
168
|
# This does not apply to Cloud logging, which is owned by the user - not
|
159
169
|
# Dialogflow.
|
160
|
-
# User must
|
170
|
+
# User must set a value lower than Dialogflow's default 365d TTL. Setting a
|
161
171
|
# value higher than that has no effect.
|
162
172
|
# A missing value or setting to 0 also means we use Dialogflow's default
|
163
173
|
# TTL.
|
@@ -112,7 +112,7 @@ module Google
|
|
112
112
|
# Multiple request messages should be sent in order:
|
113
113
|
#
|
114
114
|
# 1. The first message must contain
|
115
|
-
#
|
115
|
+
# {::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest#session session},
|
116
116
|
# {::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest#query_input query_input} plus optionally
|
117
117
|
# {::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest#query_params query_params}. If the client
|
118
118
|
# wants to receive an audio response, it should also contain
|
@@ -173,21 +173,29 @@ module Google
|
|
173
173
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
174
174
|
end
|
175
175
|
|
176
|
-
# The top-level message returned from the
|
176
|
+
# The top-level message returned from the
|
177
|
+
# {::Google::Cloud::Dialogflow::CX::V3::Sessions::Client#streaming_detect_intent StreamingDetectIntent} method.
|
177
178
|
#
|
178
|
-
# Multiple response messages can be returned in order
|
179
|
+
# Multiple response messages (N) can be returned in order.
|
179
180
|
#
|
180
|
-
#
|
181
|
-
#
|
182
|
-
# complete transcript of what the user said. The last `recognition_result`
|
183
|
-
# has `is_final` set to `true`.
|
181
|
+
# The first (N-1) responses set either the `recognition_result` or
|
182
|
+
# `detect_intent_response` field, depending on the request:
|
184
183
|
#
|
185
|
-
#
|
186
|
-
#
|
187
|
-
#
|
188
|
-
#
|
189
|
-
#
|
190
|
-
# the
|
184
|
+
# * If the `StreamingDetectIntentRequest.query_input.audio` field was
|
185
|
+
# set, and the `StreamingDetectIntentRequest.enable_partial_response`
|
186
|
+
# field was false, the `recognition_result` field is populated for each
|
187
|
+
# of the (N-1) responses.
|
188
|
+
# See the {::Google::Cloud::Dialogflow::CX::V3::StreamingRecognitionResult StreamingRecognitionResult} message for details
|
189
|
+
# about the result message sequence.
|
190
|
+
#
|
191
|
+
# * If the `StreamingDetectIntentRequest.enable_partial_response` field was
|
192
|
+
# true, the `detect_intent_response` field is populated for each
|
193
|
+
# of the (N-1) responses, where 1 <= N <= 4.
|
194
|
+
# These responses set the {::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse#response_type DetectIntentResponse.response_type} field
|
195
|
+
# to `PARTIAL`.
|
196
|
+
#
|
197
|
+
# For the final Nth response message, the `detect_intent_response` is fully
|
198
|
+
# populated, and {::Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse#response_type DetectIntentResponse.response_type} is set to `FINAL`.
|
191
199
|
# @!attribute [rw] recognition_result
|
192
200
|
# @return [::Google::Cloud::Dialogflow::CX::V3::StreamingRecognitionResult]
|
193
201
|
# The result of speech recognition.
|
@@ -203,35 +211,39 @@ module Google
|
|
203
211
|
# that is currently being processed or an indication that this is the end
|
204
212
|
# of the single requested utterance.
|
205
213
|
#
|
206
|
-
#
|
207
|
-
#
|
208
|
-
#
|
209
|
-
#
|
210
|
-
#
|
211
|
-
#
|
212
|
-
#
|
213
|
-
#
|
214
|
-
#
|
215
|
-
#
|
216
|
-
#
|
217
|
-
#
|
218
|
-
#
|
219
|
-
#
|
220
|
-
#
|
221
|
-
#
|
222
|
-
#
|
223
|
-
#
|
224
|
-
#
|
225
|
-
#
|
226
|
-
#
|
227
|
-
#
|
228
|
-
#
|
229
|
-
#
|
230
|
-
#
|
231
|
-
#
|
232
|
-
#
|
233
|
-
#
|
234
|
-
#
|
214
|
+
# While end-user audio is being processed, Dialogflow sends a series of
|
215
|
+
# results. Each result may contain a `transcript` value. A transcript
|
216
|
+
# represents a portion of the utterance. While the recognizer is processing
|
217
|
+
# audio, transcript values may be interim values or finalized values.
|
218
|
+
# Once a transcript is finalized, the `is_final` value is set to true and
|
219
|
+
# processing continues for the next transcript.
|
220
|
+
#
|
221
|
+
# If `StreamingDetectIntentRequest.query_input.audio.config.single_utterance`
|
222
|
+
# was true, and the recognizer has completed processing audio,
|
223
|
+
# the `message_type` value is set to `END_OF_SINGLE_UTTERANCE and the
|
224
|
+
# following (last) result contains the last finalized transcript.
|
225
|
+
#
|
226
|
+
# The complete end-user utterance is determined by concatenating the
|
227
|
+
# finalized transcript values received for the series of results.
|
228
|
+
#
|
229
|
+
# In the following example, single utterance is enabled. In the case where
|
230
|
+
# single utterance is not enabled, result 7 would not occur.
|
231
|
+
#
|
232
|
+
# ```
|
233
|
+
# Num | transcript | message_type | is_final
|
234
|
+
# --- | ----------------------- | ----------------------- | --------
|
235
|
+
# 1 | "tube" | TRANSCRIPT | false
|
236
|
+
# 2 | "to be a" | TRANSCRIPT | false
|
237
|
+
# 3 | "to be" | TRANSCRIPT | false
|
238
|
+
# 4 | "to be or not to be" | TRANSCRIPT | true
|
239
|
+
# 5 | "that's" | TRANSCRIPT | false
|
240
|
+
# 6 | "that is | TRANSCRIPT | false
|
241
|
+
# 7 | unset | END_OF_SINGLE_UTTERANCE | unset
|
242
|
+
# 8 | " that is the question" | TRANSCRIPT | true
|
243
|
+
# ```
|
244
|
+
#
|
245
|
+
# Concatenating the finalized transcripts with `is_final` set to true,
|
246
|
+
# the complete utterance becomes "to be or not to be that is the question".
|
235
247
|
# @!attribute [rw] message_type
|
236
248
|
# @return [::Google::Cloud::Dialogflow::CX::V3::StreamingRecognitionResult::MessageType]
|
237
249
|
# Type of the result message.
|
@@ -175,6 +175,49 @@ module Google
|
|
175
175
|
include ::Google::Protobuf::MessageExts
|
176
176
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
177
177
|
end
|
178
|
+
|
179
|
+
# The request message for {::Google::Cloud::Dialogflow::CX::V3::Versions::Client#compare_versions Versions.CompareVersions}.
|
180
|
+
# @!attribute [rw] base_version
|
181
|
+
# @return [::String]
|
182
|
+
# Required. Name of the base flow version to compare with the target version. Use
|
183
|
+
# version ID `0` to indicate the draft version of the specified flow.
|
184
|
+
#
|
185
|
+
# Format: `projects/<Project ID>/locations/<Location ID>/agents/
|
186
|
+
# <Agent ID>/flows/<Flow ID>/versions/<Version ID>`.
|
187
|
+
# @!attribute [rw] target_version
|
188
|
+
# @return [::String]
|
189
|
+
# Required. Name of the target flow version to compare with the
|
190
|
+
# base version. Use version ID `0` to indicate the draft version of the
|
191
|
+
# specified flow. Format: `projects/<Project ID>/locations/<Location
|
192
|
+
# ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>`.
|
193
|
+
# @!attribute [rw] language_code
|
194
|
+
# @return [::String]
|
195
|
+
# The language to compare the flow versions for.
|
196
|
+
#
|
197
|
+
# If not specified, the agent's default language is used.
|
198
|
+
# [Many
|
199
|
+
# languages](https://cloud.google.com/dialogflow/docs/reference/language) are
|
200
|
+
# supported. Note: languages must be enabled in the agent before they can be
|
201
|
+
# used.
|
202
|
+
class CompareVersionsRequest
|
203
|
+
include ::Google::Protobuf::MessageExts
|
204
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
205
|
+
end
|
206
|
+
|
207
|
+
# The response message for {::Google::Cloud::Dialogflow::CX::V3::Versions::Client#compare_versions Versions.CompareVersions}.
|
208
|
+
# @!attribute [rw] base_version_content_json
|
209
|
+
# @return [::String]
|
210
|
+
# JSON representation of the base version content.
|
211
|
+
# @!attribute [rw] target_version_content_json
|
212
|
+
# @return [::String]
|
213
|
+
# JSON representation of the target version content.
|
214
|
+
# @!attribute [rw] compare_time
|
215
|
+
# @return [::Google::Protobuf::Timestamp]
|
216
|
+
# The timestamp when the two version compares.
|
217
|
+
class CompareVersionsResponse
|
218
|
+
include ::Google::Protobuf::MessageExts
|
219
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
220
|
+
end
|
178
221
|
end
|
179
222
|
end
|
180
223
|
end
|
@@ -69,6 +69,19 @@ module Google
|
|
69
69
|
# @return [::Google::Protobuf::Map{::String => ::String}]
|
70
70
|
# The HTTP request headers to send together with webhook
|
71
71
|
# requests.
|
72
|
+
# @!attribute [rw] allowed_ca_certs
|
73
|
+
# @return [::Array<::String>]
|
74
|
+
# Optional. Specifies a list of allowed custom CA certificates (in DER format) for
|
75
|
+
# HTTPS verification. This overrides the default SSL trust store. If this
|
76
|
+
# is empty or unspecified, Dialogflow will use Google's default trust store
|
77
|
+
# to verify certificates.
|
78
|
+
# N.B. Make sure the HTTPS server certificates are signed with "subject alt
|
79
|
+
# name". For instance a certificate can be self-signed using the following
|
80
|
+
# command,
|
81
|
+
# openssl x509 -req -days 200 -in example.com.csr \
|
82
|
+
# -signkey example.com.key \
|
83
|
+
# -out example.com.crt \
|
84
|
+
# -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
|
72
85
|
class GenericWebService
|
73
86
|
include ::Google::Protobuf::MessageExts
|
74
87
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -386,6 +399,10 @@ module Google
|
|
386
399
|
# The unique identifier of the current page.
|
387
400
|
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
|
388
401
|
# ID>/flows/<Flow ID>/pages/<Page ID>`.
|
402
|
+
# @!attribute [rw] display_name
|
403
|
+
# @return [::String]
|
404
|
+
# Always present for {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest}. Ignored for {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}.
|
405
|
+
# The display name of the current page.
|
389
406
|
# @!attribute [rw] form_info
|
390
407
|
# @return [::Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo]
|
391
408
|
# Optional for both {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest} and {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}.
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-dialogflow-cx-v3
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.5.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2022-01-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -185,6 +185,12 @@ files:
|
|
185
185
|
- lib/google/cloud/dialogflow/cx/v3/agents/operations.rb
|
186
186
|
- lib/google/cloud/dialogflow/cx/v3/agents/paths.rb
|
187
187
|
- lib/google/cloud/dialogflow/cx/v3/audio_config_pb.rb
|
188
|
+
- lib/google/cloud/dialogflow/cx/v3/changelog_pb.rb
|
189
|
+
- lib/google/cloud/dialogflow/cx/v3/changelog_services_pb.rb
|
190
|
+
- lib/google/cloud/dialogflow/cx/v3/changelogs.rb
|
191
|
+
- lib/google/cloud/dialogflow/cx/v3/changelogs/client.rb
|
192
|
+
- lib/google/cloud/dialogflow/cx/v3/changelogs/credentials.rb
|
193
|
+
- lib/google/cloud/dialogflow/cx/v3/changelogs/paths.rb
|
188
194
|
- lib/google/cloud/dialogflow/cx/v3/deployment_pb.rb
|
189
195
|
- lib/google/cloud/dialogflow/cx/v3/deployment_services_pb.rb
|
190
196
|
- lib/google/cloud/dialogflow/cx/v3/deployments.rb
|
@@ -283,6 +289,7 @@ files:
|
|
283
289
|
- proto_docs/google/cloud/dialogflow/cx/v3/advanced_settings.rb
|
284
290
|
- proto_docs/google/cloud/dialogflow/cx/v3/agent.rb
|
285
291
|
- proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb
|
292
|
+
- proto_docs/google/cloud/dialogflow/cx/v3/changelog.rb
|
286
293
|
- proto_docs/google/cloud/dialogflow/cx/v3/deployment.rb
|
287
294
|
- proto_docs/google/cloud/dialogflow/cx/v3/entity_type.rb
|
288
295
|
- proto_docs/google/cloud/dialogflow/cx/v3/environment.rb
|
@@ -328,7 +335,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
328
335
|
- !ruby/object:Gem::Version
|
329
336
|
version: '0'
|
330
337
|
requirements: []
|
331
|
-
rubygems_version: 3.
|
338
|
+
rubygems_version: 3.3.4
|
332
339
|
signing_key:
|
333
340
|
specification_version: 4
|
334
341
|
summary: API Client library for the Dialogflow CX V3 API
|