google-cloud-dialogflow 0.5.0 → 0.6.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9fdd0dce6a73bdf89095752f64da4d1cbb6a074c0b47d42a70f297e351446fc2
4
- data.tar.gz: 86c9a0cdd485372d51716f4b2147f73952ce862b3c88508dd74b389339c92046
3
+ metadata.gz: 83c6053a76c0362244a43af4e4c2f89f7aa8a1b5bcbbdce6b1a859d5179fecde
4
+ data.tar.gz: 25faa1f037f891155b4192f57ea17038e2fe04d4e82636c88e7c5ab733330903
5
5
  SHA512:
6
- metadata.gz: 9c757e4cbdcd06c4e8ec944b99ca5b3e2be456e8727fd884790f96d25d0df4e8a68b741554e5af1ce1ba929149df18afd49f5b2f2b3a44391a718a5504e5004f
7
- data.tar.gz: a7dfe767974d5027f5239bb99500bbeda6283a8ba5eeb7ef4083d84799b763b43fb24d3c9a0bd15798be7172b1c52f1a06c3da1cb75c9b8480af54b3710e6910
6
+ metadata.gz: b71e6b21a9c6c1700574f3662a532ceef5125cc732174d11f942079e2d806a88e982f304249762d6376c46f93690b247982c9a0ab7e7d2109462c163a649ecaa
7
+ data.tar.gz: 3a66957d8c62e5100d57cfea6b07fa5c4f63f46402c3ee4d04945d3890e5d0614322a9313e5cf453bbfc35508c25721eaab1b39247d50aed2dea6a3c8a8bd29e
data/README.md CHANGED
@@ -13,7 +13,7 @@ steps:
13
13
  1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
14
14
  2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
15
15
  3. [Enable the Dialogflow API.](https://console.cloud.google.com/apis/library/dialogflow.googleapis.com)
16
- 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
16
+ 4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-dialogflow/latest/file.AUTHENTICATION.html)
17
17
 
18
18
  ### Installation
19
19
  ```
@@ -28,14 +28,14 @@ $ gem install google-cloud-dialogflow
28
28
  - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
29
29
  to see the full list of Cloud APIs that we cover.
30
30
 
31
- [Client Library Documentation]: https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-dialogflow/latest/google/cloud/dialogflow/v2
31
+ [Client Library Documentation]: https://googleapis.dev/ruby/google-cloud-dialogflow/latest
32
32
  [Product Documentation]: https://cloud.google.com/dialogflow
33
33
 
34
34
  ## Enabling Logging
35
35
 
36
36
  To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
37
37
  The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
38
- or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
38
+ or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
39
39
  that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
40
40
  and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
41
41
 
@@ -35,7 +35,7 @@ module Google
35
35
  # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
36
36
  # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
37
37
  # 3. [Enable the Dialogflow API.](https://console.cloud.google.com/apis/library/dialogflow.googleapis.com)
38
- # 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
38
+ # 4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-dialogflow/latest/file.AUTHENTICATION.html)
39
39
  #
40
40
  # ### Installation
41
41
  # ```
@@ -54,7 +54,7 @@ module Google
54
54
  #
55
55
  # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
56
56
  # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
57
- # or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
57
+ # or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
58
58
  # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
59
59
  # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
60
60
  #
@@ -425,6 +425,10 @@ module Google
425
425
  # favorites, preferences, playlists, and so on. You can redefine a session
426
426
  # entity type at the session level.
427
427
  #
428
+ # Session entity methods do not work with Google Assistant integration.
429
+ # Contact Dialogflow support if you need to use session entities
430
+ # with Google Assistant integration.
431
+ #
428
432
  # For more information about entity types, see the
429
433
  # [Dialogflow
430
434
  # documentation](https://cloud.google.com/dialogflow/docs/entities-overview).
@@ -44,7 +44,7 @@ module Google
44
44
  # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
45
45
  # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
46
46
  # 3. [Enable the Dialogflow API.](https://console.cloud.google.com/apis/library/dialogflow.googleapis.com)
47
- # 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
47
+ # 4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-dialogflow/latest/file.AUTHENTICATION.html)
48
48
  #
49
49
  # ### Installation
50
50
  # ```
@@ -63,7 +63,7 @@ module Google
63
63
  #
64
64
  # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
65
65
  # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
66
- # or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
66
+ # or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
67
67
  # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
68
68
  # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
69
69
  #
@@ -458,6 +458,10 @@ module Google
458
458
  # favorites, preferences, playlists, and so on. You can redefine a session
459
459
  # entity type at the session level.
460
460
  #
461
+ # Session entity methods do not work with Google Assistant integration.
462
+ # Contact Dialogflow support if you need to use session entities
463
+ # with Google Assistant integration.
464
+ #
461
465
  # For more information about entity types, see the
462
466
  # [Dialogflow
463
467
  # documentation](https://cloud.google.com/dialogflow/docs/entities-overview).
@@ -13,6 +13,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
13
13
  optional :language_code, :string, 3
14
14
  repeated :phrase_hints, :string, 4
15
15
  optional :model_variant, :enum, 10, "google.cloud.dialogflow.v2.SpeechModelVariant"
16
+ optional :single_utterance, :bool, 8
16
17
  end
17
18
  add_message "google.cloud.dialogflow.v2.VoiceSelectionParams" do
18
19
  optional :name, :string, 1
@@ -46,6 +46,18 @@ module Google
46
46
  # @!attribute [rw] model_variant
47
47
  # @return [Google::Cloud::Dialogflow::V2::SpeechModelVariant]
48
48
  # Optional. Which variant of the {Google::Cloud::Dialogflow::V2::InputAudioConfig#model Speech model} to use.
49
+ # @!attribute [rw] single_utterance
50
+ # @return [true, false]
51
+ # Optional. If `false` (default), recognition does not cease until the
52
+ # client closes the stream.
53
+ # If `true`, the recognizer will detect a single spoken utterance in input
54
+ # audio. Recognition ceases when it detects the audio's voice has
55
+ # stopped or paused. In this case, once a detected intent is received, the
56
+ # client should close the stream and start a new request with a new stream as
57
+ # needed.
58
+ # Note: This setting is relevant only for streaming methods.
59
+ # Note: When specified, InputAudioConfig.single_utterance takes precedence
60
+ # over StreamingDetectIntentRequest.single_utterance.
49
61
  class InputAudioConfig; end
50
62
 
51
63
  # Description of which voice to use for speech synthesis.
@@ -195,11 +195,15 @@ module Google
195
195
  # @return [Google::Cloud::Dialogflow::V2::Intent]
196
196
  # The intent that matched the conversational query. Some, not
197
197
  # all fields are filled in this message, including but not limited to:
198
- # `name`, `display_name` and `webhook_state`.
198
+ # `name`, `display_name`, `end_interaction` and `is_fallback`.
199
199
  # @!attribute [rw] intent_detection_confidence
200
200
  # @return [Float]
201
201
  # The intent detection confidence. Values range from 0.0
202
202
  # (completely uncertain) to 1.0 (completely certain).
203
+ # This value is for informational purpose only and is only used to
204
+ # help match the best intent within the classification threshold.
205
+ # This value may change for the same end-user expression at any time due to a
206
+ # model retraining or change in implementation.
203
207
  # If there are `multiple knowledge_answers` messages, this value is set to
204
208
  # the greatest `knowledgeAnswers.match_confidence` value in the list.
205
209
  # @!attribute [rw] diagnostic_info
@@ -214,16 +218,32 @@ module Google
214
218
  class QueryResult; end
215
219
 
216
220
  # The top-level message sent by the client to the
217
- # `StreamingDetectIntent` method.
221
+ # {StreamingDetectIntent} method.
218
222
  #
219
223
  # Multiple request messages should be sent in order:
220
224
  #
221
- # 1. The first message must contain `session`, `query_input` plus optionally
222
- # `query_params` and/or `single_utterance`. The message must not contain `input_audio`.
223
- #
224
- # 2. If `query_input` was set to a streaming input audio config,
225
- # all subsequent messages must contain only `input_audio`.
226
- # Otherwise, finish the request stream.
225
+ # 1. The first message must contain {Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#session StreamingDetectIntentRequest#session},
226
+ # [StreamingDetectIntentRequest.query_input] plus optionally
227
+ # [StreamingDetectIntentRequest.query_params]. If the client wants to
228
+ # receive an audio response, it should also contain
229
+ # {Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#output_audio_config StreamingDetectIntentRequest#output_audio_config}. The message
230
+ # must not contain {Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#input_audio StreamingDetectIntentRequest#input_audio}.
231
+ # 2. If {Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#query_input StreamingDetectIntentRequest#query_input} was set to
232
+ # {StreamingDetectIntentRequest#query_input#audio_config}, all subsequent
233
+ # messages must contain [StreamingDetectIntentRequest.input_audio] to
234
+ # continue with Speech recognition.
235
+ # If you decide to rather detect an intent from text input after you
236
+ # already started Speech recognition, please send a message with
237
+ # {StreamingDetectIntentRequest#query_input#text}.
238
+ #
239
+ # However, note that:
240
+ #
241
+ # * Dialogflow will bill you for the audio duration so far.
242
+ # * Dialogflow discards all Speech recognition results in favor of the
243
+ # input text.
244
+ # * Dialogflow will use the language code from the first message.
245
+ #
246
+ # After you sent all input, you must half-close or abort the request stream.
227
247
  # @!attribute [rw] session
228
248
  # @return [String]
229
249
  # Required. The name of the session the query is sent to.
@@ -247,13 +267,13 @@ module Google
247
267
  # 3. an event that specifies which intent to trigger.
248
268
  # @!attribute [rw] single_utterance
249
269
  # @return [true, false]
250
- # Optional. If `false` (default), recognition does not cease until the
251
- # client closes the stream.
252
- # If `true`, the recognizer will detect a single spoken utterance in input
253
- # audio. Recognition ceases when it detects the audio's voice has
254
- # stopped or paused. In this case, once a detected intent is received, the
255
- # client should close the stream and start a new request with a new stream as
256
- # needed.
270
+ # DEPRECATED. Please use {Google::Cloud::Dialogflow::V2::InputAudioConfig#single_utterance InputAudioConfig#single_utterance} instead.
271
+ # Optional. If `false` (default), recognition does not cease until
272
+ # the client closes the stream. If `true`, the recognizer will detect a
273
+ # single spoken utterance in input audio. Recognition ceases when it detects
274
+ # the audio's voice has stopped or paused. In this case, once a detected
275
+ # intent is received, the client should close the stream and start a new
276
+ # request with a new stream as needed.
257
277
  # This setting is ignored when `query_input` is a piece of text or an event.
258
278
  # @!attribute [rw] output_audio_config
259
279
  # @return [Google::Cloud::Dialogflow::V2::OutputAudioConfig]
@@ -324,7 +344,7 @@ module Google
324
344
  #
325
345
  # 6. transcript: " that is"
326
346
  #
327
- # 7. message_type: `MESSAGE_TYPE_END_OF_SINGLE_UTTERANCE`
347
+ # 7. message_type: `END_OF_SINGLE_UTTERANCE`
328
348
  #
329
349
  # 8. transcript: " that is the question"
330
350
  # is_final: true
@@ -335,22 +355,22 @@ module Google
335
355
  #
336
356
  # In each response we populate:
337
357
  #
338
- # * for `MESSAGE_TYPE_TRANSCRIPT`: `transcript` and possibly `is_final`.
358
+ # * for `TRANSCRIPT`: `transcript` and possibly `is_final`.
339
359
  #
340
- # * for `MESSAGE_TYPE_END_OF_SINGLE_UTTERANCE`: only `message_type`.
360
+ # * for `END_OF_SINGLE_UTTERANCE`: only `message_type`.
341
361
  # @!attribute [rw] message_type
342
362
  # @return [Google::Cloud::Dialogflow::V2::StreamingRecognitionResult::MessageType]
343
363
  # Type of the result message.
344
364
  # @!attribute [rw] transcript
345
365
  # @return [String]
346
366
  # Transcript text representing the words that the user spoke.
347
- # Populated if and only if `message_type` = `MESSAGE_TYPE_TRANSCRIPT`.
367
+ # Populated if and only if `message_type` = `TRANSCRIPT`.
348
368
  # @!attribute [rw] is_final
349
369
  # @return [true, false]
350
370
  # If `false`, the `StreamingRecognitionResult` represents an
351
371
  # interim result that may change. If `true`, the recognizer will not return
352
372
  # any further hypotheses about this piece of the audio. May only be populated
353
- # for `message_type` = `MESSAGE_TYPE_TRANSCRIPT`.
373
+ # for `message_type` = `TRANSCRIPT`.
354
374
  # @!attribute [rw] confidence
355
375
  # @return [Float]
356
376
  # The Speech confidence between 0.0 and 1.0 for the current portion of audio.
@@ -36,6 +36,10 @@ module Google
36
36
  # favorites, preferences, playlists, and so on. You can redefine a session
37
37
  # entity type at the session level.
38
38
  #
39
+ # Session entity methods do not work with Google Assistant integration.
40
+ # Contact Dialogflow support if you need to use session entities
41
+ # with Google Assistant integration.
42
+ #
39
43
  # For more information about entity types, see the
40
44
  # [Dialogflow
41
45
  # documentation](https://cloud.google.com/dialogflow/docs/entities-overview).
@@ -48,17 +52,37 @@ module Google
48
52
  self.service_name = 'google.cloud.dialogflow.v2.SessionEntityTypes'
49
53
 
50
54
  # Returns the list of all session entity types in the specified session.
55
+ #
56
+ # This method doesn't work with Google Assistant integration.
57
+ # Contact Dialogflow support if you need to use session entities
58
+ # with Google Assistant integration.
51
59
  rpc :ListSessionEntityTypes, ListSessionEntityTypesRequest, ListSessionEntityTypesResponse
52
60
  # Retrieves the specified session entity type.
61
+ #
62
+ # This method doesn't work with Google Assistant integration.
63
+ # Contact Dialogflow support if you need to use session entities
64
+ # with Google Assistant integration.
53
65
  rpc :GetSessionEntityType, GetSessionEntityTypeRequest, SessionEntityType
54
66
  # Creates a session entity type.
55
67
  #
56
68
  # If the specified session entity type already exists, overrides the session
57
69
  # entity type.
70
+ #
71
+ # This method doesn't work with Google Assistant integration.
72
+ # Contact Dialogflow support if you need to use session entities
73
+ # with Google Assistant integration.
58
74
  rpc :CreateSessionEntityType, CreateSessionEntityTypeRequest, SessionEntityType
59
75
  # Updates the specified session entity type.
76
+ #
77
+ # This method doesn't work with Google Assistant integration.
78
+ # Contact Dialogflow support if you need to use session entities
79
+ # with Google Assistant integration.
60
80
  rpc :UpdateSessionEntityType, UpdateSessionEntityTypeRequest, SessionEntityType
61
81
  # Deletes the specified session entity type.
82
+ #
83
+ # This method doesn't work with Google Assistant integration.
84
+ # Contact Dialogflow support if you need to use session entities
85
+ # with Google Assistant integration.
62
86
  rpc :DeleteSessionEntityType, DeleteSessionEntityTypeRequest, Google::Protobuf::Empty
63
87
  end
64
88
 
@@ -43,6 +43,10 @@ module Google
43
43
  # favorites, preferences, playlists, and so on. You can redefine a session
44
44
  # entity type at the session level.
45
45
  #
46
+ # Session entity methods do not work with Google Assistant integration.
47
+ # Contact Dialogflow support if you need to use session entities
48
+ # with Google Assistant integration.
49
+ #
46
50
  # For more information about entity types, see the
47
51
  # [Dialogflow
48
52
  # documentation](https://cloud.google.com/dialogflow/docs/entities-overview).
@@ -272,6 +276,10 @@ module Google
272
276
 
273
277
  # Returns the list of all session entity types in the specified session.
274
278
  #
279
+ # This method doesn't work with Google Assistant integration.
280
+ # Contact Dialogflow support if you need to use session entities
281
+ # with Google Assistant integration.
282
+ #
275
283
  # @param parent [String]
276
284
  # Required. The session to list all session entity types from.
277
285
  # Format: `projects/<Project ID>/agent/sessions/<Session ID>`.
@@ -327,6 +335,10 @@ module Google
327
335
 
328
336
  # Retrieves the specified session entity type.
329
337
  #
338
+ # This method doesn't work with Google Assistant integration.
339
+ # Contact Dialogflow support if you need to use session entities
340
+ # with Google Assistant integration.
341
+ #
330
342
  # @param name [String]
331
343
  # Required. The name of the session entity type. Format:
332
344
  # `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
@@ -362,6 +374,10 @@ module Google
362
374
  # If the specified session entity type already exists, overrides the session
363
375
  # entity type.
364
376
  #
377
+ # This method doesn't work with Google Assistant integration.
378
+ # Contact Dialogflow support if you need to use session entities
379
+ # with Google Assistant integration.
380
+ #
365
381
  # @param parent [String]
366
382
  # Required. The session to create a session entity type for.
367
383
  # Format: `projects/<Project ID>/agent/sessions/<Session ID>`.
@@ -402,6 +418,10 @@ module Google
402
418
 
403
419
  # Updates the specified session entity type.
404
420
  #
421
+ # This method doesn't work with Google Assistant integration.
422
+ # Contact Dialogflow support if you need to use session entities
423
+ # with Google Assistant integration.
424
+ #
405
425
  # @param session_entity_type [Google::Cloud::Dialogflow::V2::SessionEntityType | Hash]
406
426
  # Required. The entity type to update. Format:
407
427
  # `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
@@ -444,6 +464,10 @@ module Google
444
464
 
445
465
  # Deletes the specified session entity type.
446
466
  #
467
+ # This method doesn't work with Google Assistant integration.
468
+ # Contact Dialogflow support if you need to use session entities
469
+ # with Google Assistant integration.
470
+ #
447
471
  # @param name [String]
448
472
  # Required. The name of the entity type to delete. Format:
449
473
  # `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
@@ -16,7 +16,7 @@
16
16
  module Google
17
17
  module Cloud
18
18
  module Dialogflow
19
- VERSION = "0.5.0".freeze
19
+ VERSION = "0.6.0".freeze
20
20
  end
21
21
  end
22
22
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-dialogflow
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.5.0
4
+ version: 0.6.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: 2019-07-09 00:00:00.000000000 Z
11
+ date: 2019-08-23 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-gax
@@ -187,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
187
187
  - !ruby/object:Gem::Version
188
188
  version: '0'
189
189
  requirements: []
190
- rubygems_version: 3.0.3
190
+ rubygems_version: 3.0.4
191
191
  signing_key:
192
192
  specification_version: 4
193
193
  summary: API Client library for Dialogflow API