google-cloud-dialogflow 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92b5c30e5897a4f6d758eb5cbd9310327f5990a092614eeb9706c6639f0607ca
-  data.tar.gz: d1cd937baff519d9826fe8496989cb530d463c75d06961710eaff958523b4b6c
+  metadata.gz: de14dd82beb35115c1c6e68a30a764c9ce892342e95391fca91540855df8d3c5
+  data.tar.gz: d0c74e2dc3c330173be0ede40f81892ade58897638805e0fd48baa894769c6e2
 SHA512:
-  metadata.gz: c1b9f3a934de895868b48706974b9f9304f6b60ad07c688c3b8f79c380da6ae97cf65e0e1cd819140699188787d74e1040e45de1cb79066a5a56170fff0bbb29
-  data.tar.gz: e00b444804da8598903cb76f74a3d1880216487ca91b7b4c6a65ff7f5a68ef58b597c370273ed7b0c227eb5e3d41b6b52d5bc0ae748c38b9f8a3f43358c302cb
+  metadata.gz: b1738cd4bbdc9c2d818b337bffea41962fe44698c5147a41f86ed1ef47cb8797e57165cc981ba24916f772b0f64263d1255072c42a533c48dfeb6fd6c054e171
+  data.tar.gz: 7f5cb21d7015a0801a13eda3c5d9959a777579a6c548eff9c7afdd5c51522a9a1db726bb4f901960b968bbde548ab7813febc5caca688b69c15ee2d538cddb09

data/lib/google/cloud/dialogflow/v2/audio_config_pb.rb

@@ -9,11 +9,24 @@ require 'google/api/resource_pb'
 require 'google/protobuf/duration_pb'
 require 'google/api/annotations_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "google.cloud.dialogflow.v2.SpeechContext" do
+    repeated :phrases, :string, 1
+    optional :boost, :float, 2
+  end
+  add_message "google.cloud.dialogflow.v2.SpeechWordInfo" do
+    optional :word, :string, 3
+    optional :start_offset, :message, 1, "google.protobuf.Duration"
+    optional :end_offset, :message, 2, "google.protobuf.Duration"
+    optional :confidence, :float, 4
+  end
   add_message "google.cloud.dialogflow.v2.InputAudioConfig" do
     optional :audio_encoding, :enum, 1, "google.cloud.dialogflow.v2.AudioEncoding"
     optional :sample_rate_hertz, :int32, 2
     optional :language_code, :string, 3
+    optional :enable_word_info, :bool, 13
     repeated :phrase_hints, :string, 4
+    repeated :speech_contexts, :message, 11, "google.cloud.dialogflow.v2.SpeechContext"
+    optional :model, :string, 7
     optional :model_variant, :enum, 10, "google.cloud.dialogflow.v2.SpeechModelVariant"
     optional :single_utterance, :bool, 8
   end
@@ -67,6 +80,8 @@ module Google
   module Cloud
     module Dialogflow
       module V2
+        SpeechContext = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.SpeechContext").msgclass
+        SpeechWordInfo = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.SpeechWordInfo").msgclass
         InputAudioConfig = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.InputAudioConfig").msgclass
         VoiceSelectionParams = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.VoiceSelectionParams").msgclass
         SynthesizeSpeechConfig = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.SynthesizeSpeechConfig").msgclass

data/lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/audio_config.rb

@@ -17,6 +17,59 @@ module Google
   module Cloud
     module Dialogflow
       module V2
+        # Hints for the speech recognizer to help with recognition in a specific
+        # conversation state.
+        # @!attribute [rw] phrases
+        #   @return [Array<String>]
+        #     Optional. A list of strings containing words and phrases that the speech
+        #     recognizer should recognize with higher likelihood.
+        #
+        #     This list can be used to:
+        #     * improve accuracy for words and phrases you expect the user to say,
+        #       e.g. typical commands for your Dialogflow agent
+        #     * add additional words to the speech recognizer vocabulary
+        #     * ...
+        #
+        #     See the [Cloud Speech
+        #     documentation](https://cloud.google.com/speech-to-text/quotas) for usage
+        #     limits.
+        # @!attribute [rw] boost
+        #   @return [Float]
+        #     Optional. Boost for this context compared to other contexts:
+        #     * If the boost is positive, Dialogflow will increase the probability that
+        #       the phrases in this context are recognized over similar sounding phrases.
+        #     * If the boost is unspecified or non-positive, Dialogflow will not apply
+        #       any boost.
+        #
+        #     Dialogflow recommends that you use boosts in the range (0, 20] and that you
+        #     find a value that fits your use case with binary search.
+        class SpeechContext; end
+
+        # Information for a word recognized by the speech recognizer.
+        # @!attribute [rw] word
+        #   @return [String]
+        #     The word this info is for.
+        # @!attribute [rw] start_offset
+        #   @return [Google::Protobuf::Duration]
+        #     Time offset relative to the beginning of the audio that corresponds to the
+        #     start of the spoken word. This is an experimental feature and the accuracy
+        #     of the time offset can vary.
+        # @!attribute [rw] end_offset
+        #   @return [Google::Protobuf::Duration]
+        #     Time offset relative to the beginning of the audio that corresponds to the
+        #     end of the spoken word. This is an experimental feature and the accuracy of
+        #     the time offset can vary.
+        # @!attribute [rw] confidence
+        #   @return [Float]
+        #     The Speech confidence between 0.0 and 1.0 for this word. A higher number
+        #     indicates an estimated greater likelihood that the recognized word is
+        #     correct. The default of 0.0 is a sentinel value indicating that confidence
+        #     was not set.
+        #
+        #     This field is not guaranteed to be fully stable over time for the same
+        #     audio input. Users should also not rely on it to always be provided.
+        class SpeechWordInfo; end
+
         # Instructs the speech recognizer how to process the audio content.
         # @!attribute [rw] audio_encoding
         #   @return [Google::Cloud::Dialogflow::V2::AudioEncoding]
@@ -35,6 +88,12 @@ module Google
         #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
         #     for a list of the currently supported language codes. Note that queries in
         #     the same session do not necessarily need to specify the same language.
+        # @!attribute [rw] enable_word_info
+        #   @return [true, false]
+        #     Optional. If `true`, Dialogflow returns {Google::Cloud::Dialogflow::V2::SpeechWordInfo SpeechWordInfo} in
+        #     {Google::Cloud::Dialogflow::V2::StreamingRecognitionResult StreamingRecognitionResult} with information about the recognized speech
+        #     words, e.g. start and end time offsets. If false or unspecified, Speech
+        #     doesn't return any word-level information.
         # @!attribute [rw] phrase_hints
         #   @return [Array<String>]
         #     Optional. A list of strings containing words and phrases that the speech
@@ -43,6 +102,30 @@ module Google
         #     See [the Cloud Speech
         #     documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints)
         #     for more details.
+        #
+        #     This field is deprecated. Please use [speech_contexts]() instead. If you
+        #     specify both [phrase_hints]() and [speech_contexts](), Dialogflow will
+        #     treat the [phrase_hints]() as a single additional [SpeechContext]().
+        # @!attribute [rw] speech_contexts
+        #   @return [Array<Google::Cloud::Dialogflow::V2::SpeechContext>]
+        #     Optional. Context information to assist speech recognition.
+        #
+        #     See [the Cloud Speech
+        #     documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints)
+        #     for more details.
+        # @!attribute [rw] model
+        #   @return [String]
+        #     Optional. Which Speech model to select for the given request. Select the
+        #     model best suited to your domain to get best results. If a model is not
+        #     explicitly specified, then we auto-select a model based on the parameters
+        #     in the InputAudioConfig.
+        #     If enhanced speech model is enabled for the agent and an enhanced
+        #     version of the specified model for the language does not exist, then the
+        #     speech is recognized using the standard version of the specified model.
+        #     Refer to
+        #     [Cloud Speech API
+        #     documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model)
+        #     for more details.
         # @!attribute [rw] model_variant
         #   @return [Google::Cloud::Dialogflow::V2::SpeechModelVariant]
         #     Optional. Which variant of the {Google::Cloud::Dialogflow::V2::InputAudioConfig#model Speech model} to use.

data/lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/context.rb

@@ -25,6 +25,13 @@ module Google
         #
         #     The `Context ID` is always converted to lowercase, may only contain
         #     characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long.
+        #
+        #     The following context names are reserved for internal use by Dialogflow.
+        #     You should not use these contexts or create contexts with these names:
+        #
+        #     * `__system_counters__`
+        #     * `*_id_dialog_context`
+        #     * `*_dialog_params_size`
         # @!attribute [rw] lifespan_count
         #   @return [Integer]
         #     Optional. The number of conversational query requests after which the

data/lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/intent.rb

@@ -102,8 +102,9 @@ module Google
         #   @return [String]
         #     Read-only after creation. The unique identifier of the parent intent in the
         #     chain of followup intents. You can set this field when creating an intent,
-        #     for example with {CreateIntent} or {BatchUpdateIntents}, in order to
-        #     make this intent a followup intent.
+        #     for example with {Google::Cloud::Dialogflow::V2::Intents::CreateIntent CreateIntent} or
+        #     {Google::Cloud::Dialogflow::V2::Intents::BatchUpdateIntents BatchUpdateIntents}, in order to make this
+        #     intent a followup intent.
         #
         #     It identifies the parent followup intent.
         #     Format: `projects/<Project ID>/agent/intents/<Intent ID>`.

data/lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/session.rb

@@ -208,9 +208,13 @@ module Google
         #     the greatest `knowledgeAnswers.match_confidence` value in the list.
         # @!attribute [rw] diagnostic_info
         #   @return [Google::Protobuf::Struct]
-        #     The free-form diagnostic info. For example, this field could contain
-        #     webhook call latency. The string keys of the Struct's fields map can change
-        #     without notice.
+        #     Free-form diagnostic information for the associated detect intent request.
+        #     The fields of this data can change without notice, so you should not write
+        #     code that depends on its structure.
+        #     The data may contain:
+        #
+        #     * webhook call latency
+        #     * webhook errors
         # @!attribute [rw] sentiment_analysis_result
         #   @return [Google::Cloud::Dialogflow::V2::SentimentAnalysisResult]
         #     The sentiment analysis result, which depends on the
@@ -218,23 +222,26 @@ module Google
         class QueryResult; end
 
         # The top-level message sent by the client to the
-        # {StreamingDetectIntent} method.
+        # {Google::Cloud::Dialogflow::V2::Sessions::StreamingDetectIntent Sessions::StreamingDetectIntent} method.
         #
         # Multiple request messages should be sent in order:
         #
-        # 1.  The first message must contain {Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#session StreamingDetectIntentRequest#session},
-        #     [StreamingDetectIntentRequest.query_input] plus optionally
-        #     [StreamingDetectIntentRequest.query_params]. If the client wants to
-        #     receive an audio response, it should also contain
-        #     {Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#output_audio_config StreamingDetectIntentRequest#output_audio_config}. The message
-        #     must not contain {Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#input_audio StreamingDetectIntentRequest#input_audio}.
-        # 2.  If {Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#query_input StreamingDetectIntentRequest#query_input} was set to
-        #     {StreamingDetectIntentRequest#query_input#audio_config}, all subsequent
-        #     messages must contain [StreamingDetectIntentRequest.input_audio] to
-        #     continue with Speech recognition.
+        # 1.  The first message must contain
+        # {Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#session session},
+        #     {Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#query_input query_input} plus optionally
+        #     {Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#query_params query_params}. If the client
+        #     wants to receive an audio response, it should also contain
+        #     {Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#output_audio_config output_audio_config}.
+        #     The message must not contain
+        #     {Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#input_audio input_audio}.
+        # 2.  If {Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#query_input query_input} was set to
+        #     {Google::Cloud::Dialogflow::V2::InputAudioConfig query_input::audio_config}, all subsequent
+        #     messages must contain
+        #     {Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest#input_audio input_audio} to continue with
+        #     Speech recognition.
         #     If you decide to rather detect an intent from text input after you
         #     already started Speech recognition, please send a message with
-        #     {StreamingDetectIntentRequest#query_input#text}.
+        #     {Google::Cloud::Dialogflow::V2::QueryInput#text query_input::text}.
         #
         #     However, note that:
         #
@@ -380,6 +387,15 @@ module Google
         #
         #     This field is typically only provided if `is_final` is true and you should
         #     not rely on it being accurate or even set.
+        # @!attribute [rw] speech_word_info
+        #   @return [Array<Google::Cloud::Dialogflow::V2::SpeechWordInfo>]
+        #     Word-specific information for the words recognized by Speech in
+        #     {Google::Cloud::Dialogflow::V2::StreamingRecognitionResult#transcript transcript}. Populated if and only if `message_type` = `TRANSCRIPT` and
+        #     [InputAudioConfig.enable_word_info] is set.
+        # @!attribute [rw] speech_end_offset
+        #   @return [Google::Protobuf::Duration]
+        #     Time offset of the end of this Speech recognition result relative to the
+        #     beginning of the audio. Only populated for `message_type` = `TRANSCRIPT`.
         class StreamingRecognitionResult
           # Type of the response message.
           module MessageType

data/lib/google/cloud/dialogflow/v2/doc/google/protobuf/duration.rb

@@ -0,0 +1,91 @@
+# Copyright 2019 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
+#
+#     https://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.
+
+
+module Google
+  module Protobuf
+    # A Duration represents a signed, fixed-length span of time represented
+    # as a count of seconds and fractions of seconds at nanosecond
+    # resolution. It is independent of any calendar and concepts like "day"
+    # or "month". It is related to Timestamp in that the difference between
+    # two Timestamp values is a Duration and it can be added or subtracted
+    # from a Timestamp. Range is approximately +-10,000 years.
+    #
+    # = Examples
+    #
+    # Example 1: Compute Duration from two Timestamps in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Timestamp end = ...;
+    #     Duration duration = ...;
+    #
+    #     duration.seconds = end.seconds - start.seconds;
+    #     duration.nanos = end.nanos - start.nanos;
+    #
+    #     if (duration.seconds < 0 && duration.nanos > 0) {
+    #       duration.seconds += 1;
+    #       duration.nanos -= 1000000000;
+    #     } else if (durations.seconds > 0 && duration.nanos < 0) {
+    #       duration.seconds -= 1;
+    #       duration.nanos += 1000000000;
+    #     }
+    #
+    # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Duration duration = ...;
+    #     Timestamp end = ...;
+    #
+    #     end.seconds = start.seconds + duration.seconds;
+    #     end.nanos = start.nanos + duration.nanos;
+    #
+    #     if (end.nanos < 0) {
+    #       end.seconds -= 1;
+    #       end.nanos += 1000000000;
+    #     } else if (end.nanos >= 1000000000) {
+    #       end.seconds += 1;
+    #       end.nanos -= 1000000000;
+    #     }
+    #
+    # Example 3: Compute Duration from datetime.timedelta in Python.
+    #
+    #     td = datetime.timedelta(days=3, minutes=10)
+    #     duration = Duration()
+    #     duration.FromTimedelta(td)
+    #
+    # = JSON Mapping
+    #
+    # In JSON format, the Duration type is encoded as a string rather than an
+    # object, where the string ends in the suffix "s" (indicating seconds) and
+    # is preceded by the number of seconds, with nanoseconds expressed as
+    # fractional seconds. For example, 3 seconds with 0 nanoseconds should be
+    # encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
+    # be expressed in JSON format as "3.000000001s", and 3 seconds and 1
+    # microsecond should be expressed in JSON format as "3.000001s".
+    # @!attribute [rw] seconds
+    #   @return [Integer]
+    #     Signed seconds of the span of time. Must be from -315,576,000,000
+    #     to +315,576,000,000 inclusive. Note: these bounds are computed from:
+    #     60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+    # @!attribute [rw] nanos
+    #   @return [Integer]
+    #     Signed fractions of a second at nanosecond resolution of the span
+    #     of time. Durations less than one second are represented with a 0
+    #     `seconds` field and a positive or negative `nanos` field. For durations
+    #     of one second or more, a non-zero value for the `nanos` field must be
+    #     of the same sign as the `seconds` field. Must be from -999,999,999
+    #     to +999,999,999 inclusive.
+    class Duration; end
+  end
+end

data/lib/google/cloud/dialogflow/v2/entity_type_services_pb.rb

@@ -88,10 +88,12 @@ module Google
             # method does not affect entities in the entity type that aren't explicitly
             # specified in the request.
             #
+            #
             # Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>
             rpc :BatchUpdateEntities, BatchUpdateEntitiesRequest, Google::Longrunning::Operation
             # Deletes entities in the specified entity type.
             #
+            #
             # Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>
             rpc :BatchDeleteEntities, BatchDeleteEntitiesRequest, Google::Longrunning::Operation
           end

data/lib/google/cloud/dialogflow/v2/entity_types_client.rb

@@ -820,6 +820,7 @@ module Google
           # method does not affect entities in the entity type that aren't explicitly
           # specified in the request.
           #
+          #
           # Operation <response: {Google::Protobuf::Empty}>
           #
           # @param parent [String]
@@ -907,6 +908,7 @@ module Google
 
           # Deletes entities in the specified entity type.
           #
+          #
           # Operation <response: {Google::Protobuf::Empty}>
           #
           # @param parent [String]

data/lib/google/cloud/dialogflow/v2/session_pb.rb

@@ -84,6 +84,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :transcript, :string, 2
     optional :is_final, :bool, 3
     optional :confidence, :float, 4
+    repeated :speech_word_info, :message, 7, "google.cloud.dialogflow.v2.SpeechWordInfo"
+    optional :speech_end_offset, :message, 8, "google.protobuf.Duration"
   end
   add_enum "google.cloud.dialogflow.v2.StreamingRecognitionResult.MessageType" do
     value :MESSAGE_TYPE_UNSPECIFIED, 0

data/lib/google/cloud/dialogflow/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Dialogflow
-      VERSION = "0.11.1".freeze
+      VERSION = "0.12.0".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-dialogflow
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-20 00:00:00.000000000 Z
+date: 2019-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-gax
@@ -165,6 +165,7 @@ files:
 - lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/session_entity_type.rb
 - lib/google/cloud/dialogflow/v2/doc/google/longrunning/operations.rb
 - lib/google/cloud/dialogflow/v2/doc/google/protobuf/any.rb
+- lib/google/cloud/dialogflow/v2/doc/google/protobuf/duration.rb
 - lib/google/cloud/dialogflow/v2/doc/google/protobuf/empty.rb
 - lib/google/cloud/dialogflow/v2/doc/google/protobuf/field_mask.rb
 - lib/google/cloud/dialogflow/v2/doc/google/protobuf/struct.rb