google-cloud-dialogflow-v2 0.11.0 → 0.11.4

data/lib/google/cloud/dialogflow/v2/sessions/client.rb

@@ -44,13 +44,12 @@ module Google
             # See {::Google::Cloud::Dialogflow::V2::Sessions::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all Sessions clients:
-            #
-            #     ::Google::Cloud::Dialogflow::V2::Sessions::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all Sessions clients
+            #   ::Google::Cloud::Dialogflow::V2::Sessions::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -109,19 +108,15 @@ module Google
             ##
             # Create a new Sessions client object.
             #
-            # ## Examples
-            #
-            # To create a new Sessions client with the default
-            # configuration:
-            #
-            #     client = ::Google::Cloud::Dialogflow::V2::Sessions::Client.new
+            # @example
             #
-            # To create a new Sessions client with a custom
-            # configuration:
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Dialogflow::V2::Sessions::Client.new
             #
-            #     client = ::Google::Cloud::Dialogflow::V2::Sessions::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::Dialogflow::V2::Sessions::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Sessions client.
             # @yieldparam config [Client::Configuration]
@@ -141,10 +136,9 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # Use self-signed JWT if the endpoint is unchanged from default,
               # but only if the default endpoint does not have a region prefix.
-              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
@@ -171,6 +165,13 @@ module Google
             # and session entity types to be updated, which in turn might affect
             # results of future queries.
             #
+            # If you might use
+            # [Agent Assist](https://cloud.google.com/dialogflow/docs/#aa)
+            # or other CCAI products now or in the future, consider using
+            # {::Google::Cloud::Dialogflow::V2::Participants::Client#analyze_content AnalyzeContent}
+            # instead of `DetectIntent`. `AnalyzeContent` has additional
+            # functionality for Agent Assist and other CCAI products.
+            #
             # Note: Always use agent versions for production traffic.
             # See [Versions and
             # environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).
@@ -269,7 +270,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.detect_intent.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.detect_intent.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @sessions_stub.call_rpc :detect_intent, request, options: options do |response, operation|
@@ -285,6 +288,13 @@ module Google
             # and returns structured, actionable data as a result. This method is only
             # available via the gRPC API (not REST).
             #
+            # If you might use
+            # [Agent Assist](https://cloud.google.com/dialogflow/docs/#aa)
+            # or other CCAI products now or in the future, consider using
+            # [StreamingAnalyzeContent][google.cloud.dialogflow.v2.Participants.StreamingAnalyzeContent]
+            # instead of `StreamingDetectIntent`. `StreamingAnalyzeContent` has
+            # additional functionality for Agent Assist and other CCAI products.
+            #
             # Note: Always use agent versions for production traffic.
             # See [Versions and
             # environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).
@@ -327,7 +337,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.streaming_detect_intent.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.streaming_detect_intent.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @sessions_stub.call_rpc :streaming_detect_intent, request, options: options do |response, operation|
@@ -351,22 +363,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for detect_intent
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::Dialogflow::V2::Sessions::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.detect_intent.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::Dialogflow::V2::Sessions::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.detect_intent.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # detect_intent to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::Dialogflow::V2::Sessions::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.detect_intent.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::Dialogflow::V2::Sessions::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.detect_intent.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.

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

@@ -1,9 +1,9 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/dialogflow/v2/validation_result.proto
 
+require 'google/api/annotations_pb'
 require 'google/protobuf'
 
-require 'google/api/annotations_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/dialogflow/v2/validation_result.proto", :syntax => :proto3) do
     add_message "google.cloud.dialogflow.v2.ValidationError" do

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Dialogflow
       module V2
-        VERSION = "0.11.0"
+        VERSION = "0.11.4"
       end
     end
   end

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

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/dialogflow/v2/version.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
@@ -10,6 +8,8 @@ require 'google/api/resource_pb'
 require 'google/protobuf/empty_pb'
 require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/timestamp_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/dialogflow/v2/version.proto", :syntax => :proto3) do
     add_message "google.cloud.dialogflow.v2.Version" do

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

@@ -27,7 +27,7 @@ module Google
           # Service for managing [Versions][google.cloud.dialogflow.v2.Version].
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode

data/lib/google/cloud/dialogflow/v2/versions/client.rb

@@ -41,13 +41,12 @@ module Google
             # See {::Google::Cloud::Dialogflow::V2::Versions::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all Versions clients:
-            #
-            #     ::Google::Cloud::Dialogflow::V2::Versions::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all Versions clients
+            #   ::Google::Cloud::Dialogflow::V2::Versions::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -99,19 +98,15 @@ module Google
             ##
             # Create a new Versions client object.
             #
-            # ## Examples
-            #
-            # To create a new Versions client with the default
-            # configuration:
-            #
-            #     client = ::Google::Cloud::Dialogflow::V2::Versions::Client.new
+            # @example
             #
-            # To create a new Versions client with a custom
-            # configuration:
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Dialogflow::V2::Versions::Client.new
             #
-            #     client = ::Google::Cloud::Dialogflow::V2::Versions::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::Dialogflow::V2::Versions::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Versions client.
             # @yieldparam config [Client::Configuration]
@@ -131,10 +126,9 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # Use self-signed JWT if the endpoint is unchanged from default,
               # but only if the default endpoint does not have a region prefix.
-              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
@@ -219,7 +213,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.list_versions.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_versions.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @versions_stub.call_rpc :list_versions, request, options: options do |response, operation|
@@ -291,7 +287,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.get_version.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_version.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @versions_stub.call_rpc :get_version, request, options: options do |response, operation|
@@ -365,7 +363,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.create_version.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.create_version.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @versions_stub.call_rpc :create_version, request, options: options do |response, operation|
@@ -442,7 +442,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.update_version.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.update_version.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @versions_stub.call_rpc :update_version, request, options: options do |response, operation|
@@ -513,7 +515,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.delete_version.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.delete_version.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @versions_stub.call_rpc :delete_version, request, options: options do |response, operation|
@@ -537,22 +541,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for list_versions
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::Dialogflow::V2::Versions::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_versions.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::Dialogflow::V2::Versions::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_versions.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # list_versions to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::Dialogflow::V2::Versions::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_versions.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::Dialogflow::V2::Versions::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_versions.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.

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

@@ -1,14 +1,14 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/dialogflow/v2/webhook.proto
 
-require 'google/protobuf'
-
 require 'google/cloud/dialogflow/v2/context_pb'
 require 'google/cloud/dialogflow/v2/intent_pb'
 require 'google/cloud/dialogflow/v2/session_pb'
 require 'google/cloud/dialogflow/v2/session_entity_type_pb'
 require 'google/protobuf/struct_pb'
 require 'google/api/annotations_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/dialogflow/v2/webhook.proto", :syntax => :proto3) do
     add_message "google.cloud.dialogflow.v2.WebhookRequest" do

data/proto_docs/google/cloud/dialogflow/v2/agent.rb

@@ -126,13 +126,14 @@ module Google
             # Not specified. This value should never be used.
             TIER_UNSPECIFIED = 0
 
-            # Standard tier.
+            # Trial Edition, previously known as Standard Edition.
             TIER_STANDARD = 1
 
-            # Enterprise tier (Essentials).
+            # Essentials Edition, previously known as Enterprise Essential Edition.
             TIER_ENTERPRISE = 2
 
-            # Enterprise tier (Plus).
+            # Essentials Edition (same as TIER_ENTERPRISE), previously known as
+            # Enterprise Plus Edition.
             TIER_ENTERPRISE_PLUS = 3
           end
         end

data/proto_docs/google/cloud/dialogflow/v2/intent.rb

@@ -113,8 +113,9 @@ module Google
         #   @return [::Array<::Google::Cloud::Dialogflow::V2::Intent::Message::Platform>]
         #     Optional. The list of platforms for which the first responses will be
         #     copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).
-        # @!attribute [rw] root_followup_intent_name
+        # @!attribute [r] root_followup_intent_name
         #   @return [::String]
+        #     Output only.
         #     Read-only. The unique identifier of the root intent in the chain of
         #     followup intents. It identifies the correct followup intents chain for
         #     this intent. We populate this field only in the output.
@@ -130,9 +131,9 @@ module Google
         #
         #     It identifies the parent followup intent.
         #     Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
-        # @!attribute [rw] followup_intent_info
+        # @!attribute [r] followup_intent_info
         #   @return [::Array<::Google::Cloud::Dialogflow::V2::Intent::FollowupIntentInfo>]
-        #     Read-only. Information about all followup intents that have this intent as
+        #     Output only. Read-only. Information about all followup intents that have this intent as
         #     a direct or indirect parent. We populate this field only in the output.
         class Intent
           include ::Google::Protobuf::MessageExts

data/proto_docs/google/cloud/dialogflow/v2/session.rb

@@ -406,10 +406,11 @@ module Google
         #
         # Multiple response messages can be returned in order:
         #
-        # 1.  If the input was set to streaming audio, the first one or more messages
-        #     contain `recognition_result`. Each `recognition_result` represents a more
-        #     complete transcript of what the user said. The last `recognition_result`
-        #     has `is_final` set to `true`.
+        # 1.  If the `StreamingDetectIntentRequest.input_audio` field was
+        #     set, the `recognition_result` field is populated for one
+        #     or more messages.
+        #     See the {::Google::Cloud::Dialogflow::V2::StreamingRecognitionResult StreamingRecognitionResult} message for details
+        #     about the result message sequence.
         #
         # 2.  The next message contains `response_id`, `query_result`
         #     and optionally `webhook_status` if a WebHook was called.
@@ -450,35 +451,39 @@ module Google
         # that is currently being processed or an indication that this is the end
         # of the single requested utterance.
         #
-        # Example:
-        #
-        # 1.  transcript: "tube"
-        #
-        # 2.  transcript: "to be a"
-        #
-        # 3.  transcript: "to be"
-        #
-        # 4.  transcript: "to be or not to be"
-        #     is_final: true
-        #
-        # 5.  transcript: " that's"
-        #
-        # 6.  transcript: " that is"
-        #
-        # 7.  message_type: `END_OF_SINGLE_UTTERANCE`
-        #
-        # 8.  transcript: " that is the question"
-        #     is_final: true
-        #
-        # Only two of the responses contain final results (#4 and #8 indicated by
-        # `is_final: true`). Concatenating these generates the full transcript: "to be
-        # or not to be that is the question".
-        #
-        # In each response we populate:
-        #
-        # *  for `TRANSCRIPT`: `transcript` and possibly `is_final`.
-        #
-        # *  for `END_OF_SINGLE_UTTERANCE`: only `message_type`.
+        # While end-user audio is being processed, Dialogflow sends a series of
+        # results. Each result may contain a `transcript` value. A transcript
+        # represents a portion of the utterance. While the recognizer is processing
+        # audio, transcript values may be interim values or finalized values.
+        # Once a transcript is finalized, the `is_final` value is set to true and
+        # processing continues for the next transcript.
+        #
+        # If `StreamingDetectIntentRequest.query_input.audio_config.single_utterance`
+        # was true, and the recognizer has completed processing audio,
+        # the `message_type` value is set to `END_OF_SINGLE_UTTERANCE and the
+        # following (last) result contains the last finalized transcript.
+        #
+        # The complete end-user utterance is determined by concatenating the
+        # finalized transcript values received for the series of results.
+        #
+        # In the following example, single utterance is enabled. In the case where
+        # single utterance is not enabled, result 7 would not occur.
+        #
+        # ```
+        # Num | transcript              | message_type            | is_final
+        # --- | ----------------------- | ----------------------- | --------
+        # 1   | "tube"                  | TRANSCRIPT              | false
+        # 2   | "to be a"               | TRANSCRIPT              | false
+        # 3   | "to be"                 | TRANSCRIPT              | false
+        # 4   | "to be or not to be"    | TRANSCRIPT              | true
+        # 5   | "that's"                | TRANSCRIPT              | false
+        # 6   | "that is                | TRANSCRIPT              | false
+        # 7   | unset                   | END_OF_SINGLE_UTTERANCE | unset
+        # 8   | " that is the question" | TRANSCRIPT              | true
+        # ```
+        #
+        # Concatenating the finalized transcripts with `is_final` set to true,
+        # the complete utterance becomes "to be or not to be that is the question".
         # @!attribute [rw] message_type
         #   @return [::Google::Cloud::Dialogflow::V2::StreamingRecognitionResult::MessageType]
         #     Type of the result message.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-dialogflow-v2
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.4
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-05 00:00:00.000000000 Z
+date: 2021-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -160,9 +160,10 @@ description: Dialogflow is an end-to-end, build-once deploy-everywhere developme
   suite for creating conversational interfaces for websites, mobile applications,
   popular messaging platforms, and IoT devices. You can use it to build interfaces
   (such as chatbots and conversational IVR) that enable natural and rich interactions
-  between your users and your business. Note that google-cloud-dialogflow-v2 is a
-  version-specific client library. For most uses, we recommend installing the main
-  client library google-cloud-dialogflow instead. See the readme for more details.
+  between your users and your business. This client is for Dialogflow ES, providing
+  the standard agent type suitable for small and simple agents. Note that google-cloud-dialogflow-v2
+  is a version-specific client library. For most uses, we recommend installing the
+  main client library google-cloud-dialogflow instead. See the readme for more details.
 email: googleapis-packages@google.com
 executables: []
 extensions: []