google-cloud-dialogflow-v2 0.11.4 → 0.11.5

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

@@ -192,6 +192,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::SessionEntityTypes::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::ListSessionEntityTypesRequest.new
+            #
+            #   # Call the list_session_entity_types method.
+            #   result = client.list_session_entity_types request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Cloud::Dialogflow::V2::SessionEntityType.
+            #     p response
+            #   end
+            #
             def list_session_entity_types request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -209,9 +230,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -271,6 +294,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::SessionEntityTypes::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::GetSessionEntityTypeRequest.new
+            #
+            #   # Call the get_session_entity_type method.
+            #   result = client.get_session_entity_type request
+            #
+            #   # The returned object is of type Google::Cloud::Dialogflow::V2::SessionEntityType.
+            #   p result
+            #
             def get_session_entity_type request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -288,9 +326,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -353,6 +393,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::SessionEntityTypes::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::CreateSessionEntityTypeRequest.new
+            #
+            #   # Call the create_session_entity_type method.
+            #   result = client.create_session_entity_type request
+            #
+            #   # The returned object is of type Google::Cloud::Dialogflow::V2::SessionEntityType.
+            #   p result
+            #
             def create_session_entity_type request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -370,9 +425,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -427,6 +484,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::SessionEntityTypes::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::UpdateSessionEntityTypeRequest.new
+            #
+            #   # Call the update_session_entity_type method.
+            #   result = client.update_session_entity_type request
+            #
+            #   # The returned object is of type Google::Cloud::Dialogflow::V2::SessionEntityType.
+            #   p result
+            #
             def update_session_entity_type request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -444,9 +516,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "session_entity_type.name" => request.session_entity_type.name
-              }
+              header_params = {}
+              if request.session_entity_type&.name
+                header_params["session_entity_type.name"] = request.session_entity_type.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -505,6 +579,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::SessionEntityTypes::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::DeleteSessionEntityTypeRequest.new
+            #
+            #   # Call the delete_session_entity_type method.
+            #   result = client.delete_session_entity_type request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def delete_session_entity_type request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -522,9 +611,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 

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

@@ -244,6 +244,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::Sessions::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::DetectIntentRequest.new
+            #
+            #   # Call the detect_intent method.
+            #   result = client.detect_intent request
+            #
+            #   # The returned object is of type Google::Cloud::Dialogflow::V2::DetectIntentResponse.
+            #   p result
+            #
             def detect_intent request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -261,9 +276,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "session" => request.session
-              }
+              header_params = {}
+              if request.session
+                header_params["session"] = request.session
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -312,6 +329,30 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::Sessions::Client.new
+            #
+            #   # Create an input stream
+            #   input = Gapic::StreamInput.new
+            #
+            #   # Call the streaming_detect_intent method to start streaming.
+            #   output = client.streaming_detect_intent input
+            #
+            #   # Send requests on the stream. For each request, pass in keyword
+            #   # arguments to set fields. Be sure to close the stream when done.
+            #   input << Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest.new
+            #   input << Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest.new
+            #   input.close
+            #
+            #   # Handle streamed responses. These may be interleaved with inputs.
+            #   # Each response is of type ::Google::Cloud::Dialogflow::V2::StreamingDetectIntentResponse.
+            #   output.each do |response|
+            #     p response
+            #   end
+            #
             def streaming_detect_intent request, options = nil
               unless request.is_a? ::Enumerable
                 raise ::ArgumentError, "request must be an Enumerable" unless request.respond_to? :to_enum

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

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

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

@@ -187,6 +187,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::Versions::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::ListVersionsRequest.new
+            #
+            #   # Call the list_versions method.
+            #   result = client.list_versions request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Cloud::Dialogflow::V2::Version.
+            #     p response
+            #   end
+            #
             def list_versions request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -204,9 +225,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -261,6 +284,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::Versions::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::GetVersionRequest.new
+            #
+            #   # Call the get_version method.
+            #   result = client.get_version request
+            #
+            #   # The returned object is of type Google::Cloud::Dialogflow::V2::Version.
+            #   p result
+            #
             def get_version request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -278,9 +316,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -337,6 +377,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::Versions::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::CreateVersionRequest.new
+            #
+            #   # Call the create_version method.
+            #   result = client.create_version request
+            #
+            #   # The returned object is of type Google::Cloud::Dialogflow::V2::Version.
+            #   p result
+            #
             def create_version request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -354,9 +409,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -416,6 +473,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::Versions::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::UpdateVersionRequest.new
+            #
+            #   # Call the update_version method.
+            #   result = client.update_version request
+            #
+            #   # The returned object is of type Google::Cloud::Dialogflow::V2::Version.
+            #   p result
+            #
             def update_version request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -433,9 +505,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "version.name" => request.version.name
-              }
+              header_params = {}
+              if request.version&.name
+                header_params["version.name"] = request.version.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -489,6 +563,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::Versions::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::DeleteVersionRequest.new
+            #
+            #   # Call the delete_version method.
+            #   result = client.delete_version request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def delete_version request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -506,9 +595,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 

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

@@ -63,9 +63,21 @@ module Google
         #     Settings for speech transcription.
         # @!attribute [rw] language_code
         #   @return [::String]
-        #     Language which represents the conversationProfile.
-        #     If unspecified, the default language code en-us applies. Users need to
-        #     create a ConversationProfile for each language they want to support.
+        #     Language code for the conversation profile. If not specified, the language
+        #     is en-US. Language at ConversationProfile should be set for all non en-US
+        #     languages.
+        #     This should be a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt)
+        #     language tag. Example: "en-US".
+        # @!attribute [rw] time_zone
+        #   @return [::String]
+        #     The time zone of this conversational profile from the
+        #     [time zone database](https://www.iana.org/time-zones), e.g.,
+        #     America/New_York, Europe/Paris. Defaults to America/New_York.
+        # @!attribute [rw] security_settings
+        #   @return [::String]
+        #     Name of the CX SecuritySettings reference for the agent.
+        #     Format: `projects/<Project ID>/locations/<Location
+        #     ID>/securitySettings/<Security Settings ID>`.
         class ConversationProfile
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -162,11 +174,16 @@ module Google
         #     Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Dialogflow API
         #     Service Agent` role in this project.
         #
-        #     Format: `projects/<Project ID>/locations/<Location
+        #     - For ES agents, use format: `projects/<Project ID>/locations/<Location
         #     ID>/agent/environments/<Environment ID or '-'>`. If environment is not
         #     specified, the default `draft` environment is used. Refer to
         #     [DetectIntentRequest](/dialogflow/docs/reference/rpc/google.cloud.dialogflow.v2#google.cloud.dialogflow.v2.DetectIntentRequest)
         #     for more details.
+        #
+        #     - For CX agents, use format `projects/<Project ID>/locations/<Location
+        #     ID>/agents/<Agent ID>/environments/<Environment ID
+        #     or '-'>`. If environment is not specified, the default `draft` environment
+        #     is used.
         class AutomatedAgentConfig
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -289,7 +306,7 @@ module Google
           #     If this field is not set, it defaults to 0.0, which means that all
           #     suggestions are returned.
           #
-          #     Supported features: ARTICLE_SUGGESTION.
+          #     Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE.
           # @!attribute [rw] context_filter_settings
           #   @return [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionQueryConfig::ContextFilterSettings]
           #     Determines how recent conversation context is filtered when generating
@@ -471,13 +488,13 @@ module Google
 
           # Format of cloud pub/sub message.
           module MessageFormat
-            # If it is unspeified, PROTO will be used.
+            # If it is unspecified, PROTO will be used.
             MESSAGE_FORMAT_UNSPECIFIED = 0
 
-            # Pubsub message will be serialized proto.
+            # Pub/Sub message will be serialized proto.
             PROTO = 1
 
-            # Pubsub message will be json.
+            # Pub/Sub message will be json.
             JSON = 2
           end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-dialogflow-v2
 version: !ruby/object:Gem::Version
-  version: 0.11.4
+  version: 0.11.5
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-28 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common