google-cloud-dialogflow-v2 0.11.3 → 0.13.0

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

@@ -187,6 +187,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::Participants::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::CreateParticipantRequest.new
+            #
+            #   # Call the create_participant method.
+            #   result = client.create_participant request
+            #
+            #   # The returned object is of type Google::Cloud::Dialogflow::V2::Participant.
+            #   p result
+            #
             def create_participant request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -204,9 +219,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
 
@@ -257,6 +274,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::Participants::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::GetParticipantRequest.new
+            #
+            #   # Call the get_participant method.
+            #   result = client.get_participant request
+            #
+            #   # The returned object is of type Google::Cloud::Dialogflow::V2::Participant.
+            #   p result
+            #
             def get_participant request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -274,9 +306,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
 
@@ -332,6 +366,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::Participants::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::ListParticipantsRequest.new
+            #
+            #   # Call the list_participants method.
+            #   result = client.list_participants 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::Participant.
+            #     p response
+            #   end
+            #
             def list_participants request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -349,9 +404,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
 
@@ -403,6 +460,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::Participants::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::UpdateParticipantRequest.new
+            #
+            #   # Call the update_participant method.
+            #   result = client.update_participant request
+            #
+            #   # The returned object is of type Google::Cloud::Dialogflow::V2::Participant.
+            #   p result
+            #
             def update_participant request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -420,9 +492,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "participant.name" => request.participant.name
-              }
+              header_params = {}
+              if request.participant&.name
+                header_params["participant.name"] = request.participant.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -460,7 +534,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload analyze_content(participant: nil, text_input: nil, event_input: nil, reply_audio_config: nil, query_params: nil, request_id: nil)
+            # @overload analyze_content(participant: nil, text_input: nil, event_input: nil, reply_audio_config: nil, query_params: nil, assist_query_params: nil, request_id: nil)
             #   Pass arguments to `analyze_content` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -481,6 +555,8 @@ module Google
             #     is disabled.
             #   @param query_params [::Google::Cloud::Dialogflow::V2::QueryParameters, ::Hash]
             #     Parameters for a Dialogflow virtual-agent query.
+            #   @param assist_query_params [::Google::Cloud::Dialogflow::V2::AssistQueryParameters, ::Hash]
+            #     Parameters for a human assist query.
             #   @param request_id [::String]
             #     A unique identifier for this request. Restricted to 36 ASCII characters.
             #     A random UUID is recommended.
@@ -494,6 +570,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::Participants::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::AnalyzeContentRequest.new
+            #
+            #   # Call the analyze_content method.
+            #   result = client.analyze_content request
+            #
+            #   # The returned object is of type Google::Cloud::Dialogflow::V2::AnalyzeContentResponse.
+            #   p result
+            #
             def analyze_content request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -511,9 +602,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "participant" => request.participant
-              }
+              header_params = {}
+              if request.participant
+                header_params["participant"] = request.participant
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -547,7 +640,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload suggest_articles(parent: nil, latest_message: nil, context_size: nil)
+            # @overload suggest_articles(parent: nil, latest_message: nil, context_size: nil, assist_query_params: nil)
             #   Pass arguments to `suggest_articles` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -566,6 +659,8 @@ module Google
             #     Max number of messages prior to and including
             #     {::Google::Cloud::Dialogflow::V2::SuggestArticlesRequest#latest_message latest_message} to use as context
             #     when compiling the suggestion. By default 20 and at most 50.
+            #   @param assist_query_params [::Google::Cloud::Dialogflow::V2::AssistQueryParameters, ::Hash]
+            #     Parameters for a human assist query.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Dialogflow::V2::SuggestArticlesResponse]
@@ -575,6 +670,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::Participants::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::SuggestArticlesRequest.new
+            #
+            #   # Call the suggest_articles method.
+            #   result = client.suggest_articles request
+            #
+            #   # The returned object is of type Google::Cloud::Dialogflow::V2::SuggestArticlesResponse.
+            #   p result
+            #
             def suggest_articles request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -592,9 +702,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
 
@@ -628,7 +740,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload suggest_faq_answers(parent: nil, latest_message: nil, context_size: nil)
+            # @overload suggest_faq_answers(parent: nil, latest_message: nil, context_size: nil, assist_query_params: nil)
             #   Pass arguments to `suggest_faq_answers` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -647,6 +759,8 @@ module Google
             #     Max number of messages prior to and including
             #     [latest_message] to use as context when compiling the
             #     suggestion. By default 20 and at most 50.
+            #   @param assist_query_params [::Google::Cloud::Dialogflow::V2::AssistQueryParameters, ::Hash]
+            #     Parameters for a human assist query.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Dialogflow::V2::SuggestFaqAnswersResponse]
@@ -656,6 +770,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::Participants::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::SuggestFaqAnswersRequest.new
+            #
+            #   # Call the suggest_faq_answers method.
+            #   result = client.suggest_faq_answers request
+            #
+            #   # The returned object is of type Google::Cloud::Dialogflow::V2::SuggestFaqAnswersResponse.
+            #   p result
+            #
             def suggest_faq_answers request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -673,9 +802,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
 

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/session_pb.rb

@@ -7,6 +7,7 @@ require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/dialogflow/v2/audio_config_pb'
 require 'google/cloud/dialogflow/v2/context_pb'
+require 'google/cloud/dialogflow/v2/gcs_pb'
 require 'google/cloud/dialogflow/v2/intent_pb'
 require 'google/cloud/dialogflow/v2/session_entity_type_pb'
 require 'google/protobuf/duration_pb'

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.3"
+        VERSION = "0.13.0"
       end
     end
   end