google-cloud-dialogflow-v2 0.27.0 → 0.29.0

data/lib/google/cloud/dialogflow/v2/conversation_profiles/rest/client.rb

@@ -202,6 +202,26 @@ module Google
               # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::ConversationProfile>]
               #
               # @raise [::Google::Cloud::Error] if the REST call 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::ConversationProfiles::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::V2::ListConversationProfilesRequest.new
+              #
+              #   # Call the list_conversation_profiles method.
+              #   result = client.list_conversation_profiles request
+              #
+              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+              #   # over elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
+              #     # Each element is of type ::Google::Cloud::Dialogflow::V2::ConversationProfile.
+              #     p item
+              #   end
+              #
               def list_conversation_profiles request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -267,6 +287,22 @@ module Google
               # @return [::Google::Cloud::Dialogflow::V2::ConversationProfile]
               #
               # @raise [::Google::Cloud::Error] if the REST call 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::ConversationProfiles::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::V2::GetConversationProfileRequest.new
+              #
+              #   # Call the get_conversation_profile method.
+              #   result = client.get_conversation_profile request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::V2::ConversationProfile.
+              #   p result
+              #
               def get_conversation_profile request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -337,6 +373,22 @@ module Google
               # @return [::Google::Cloud::Dialogflow::V2::ConversationProfile]
               #
               # @raise [::Google::Cloud::Error] if the REST call 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::ConversationProfiles::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::V2::CreateConversationProfileRequest.new
+              #
+              #   # Call the create_conversation_profile method.
+              #   result = client.create_conversation_profile request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::V2::ConversationProfile.
+              #   p result
+              #
               def create_conversation_profile request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -406,6 +458,22 @@ module Google
               # @return [::Google::Cloud::Dialogflow::V2::ConversationProfile]
               #
               # @raise [::Google::Cloud::Error] if the REST call 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::ConversationProfiles::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::V2::UpdateConversationProfileRequest.new
+              #
+              #   # Call the update_conversation_profile method.
+              #   result = client.update_conversation_profile request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::V2::ConversationProfile.
+              #   p result
+              #
               def update_conversation_profile request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -470,6 +538,22 @@ module Google
               # @return [::Google::Protobuf::Empty]
               #
               # @raise [::Google::Cloud::Error] if the REST call 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::ConversationProfiles::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::V2::DeleteConversationProfileRequest.new
+              #
+              #   # Call the delete_conversation_profile method.
+              #   result = client.delete_conversation_profile request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def delete_conversation_profile request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -556,6 +640,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call 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::ConversationProfiles::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::V2::SetSuggestionFeatureConfigRequest.new
+              #
+              #   # Call the set_suggestion_feature_config method.
+              #   result = client.set_suggestion_feature_config request
+              #
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
+              #   result.wait_until_done! timeout: 60
+              #   if result.response?
+              #     p result.response
+              #   else
+              #     puts "No response received."
+              #   end
+              #
               def set_suggestion_feature_config request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -636,6 +743,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call 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::ConversationProfiles::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::V2::ClearSuggestionFeatureConfigRequest.new
+              #
+              #   # Call the clear_suggestion_feature_config method.
+              #   result = client.clear_suggestion_feature_config request
+              #
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
+              #   result.wait_until_done! timeout: 60
+              #   if result.response?
+              #     p result.response
+              #   else
+              #     puts "No response received."
+              #   end
+              #
               def clear_suggestion_feature_config request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 

data/lib/google/cloud/dialogflow/v2/conversation_profiles/rest/operations.rb

@@ -136,6 +136,26 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/longrunning"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Longrunning::Operations::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Longrunning::ListOperationsRequest.new
+              #
+              #   # Call the list_operations method.
+              #   result = client.list_operations request
+              #
+              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+              #   # over elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
+              #     # Each element is of type ::Google::Longrunning::Operation.
+              #     p item
+              #   end
+              #
               def list_operations request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -201,6 +221,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/longrunning"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Longrunning::Operations::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Longrunning::GetOperationRequest.new
+              #
+              #   # Call the get_operation method.
+              #   result = client.get_operation request
+              #
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
+              #   result.wait_until_done! timeout: 60
+              #   if result.response?
+              #     p result.response
+              #   else
+              #     puts "No response received."
+              #   end
+              #
               def get_operation request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -267,6 +310,22 @@ module Google
               # @return [::Google::Protobuf::Empty]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/longrunning"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Longrunning::Operations::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Longrunning::DeleteOperationRequest.new
+              #
+              #   # Call the delete_operation method.
+              #   result = client.delete_operation request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def delete_operation request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -338,6 +397,22 @@ module Google
               # @return [::Google::Protobuf::Empty]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/longrunning"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Longrunning::Operations::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Longrunning::CancelOperationRequest.new
+              #
+              #   # Call the cancel_operation method.
+              #   result = client.cancel_operation request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def cancel_operation request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 

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

@@ -76,6 +76,8 @@ module Google
             # Generates and returns a summary for a conversation that does not have a
             # resource created for it.
             rpc :GenerateStatelessSummary, ::Google::Cloud::Dialogflow::V2::GenerateStatelessSummaryRequest, ::Google::Cloud::Dialogflow::V2::GenerateStatelessSummaryResponse
+            # Get answers for the given query based on knowledge documents.
+            rpc :SearchKnowledge, ::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest, ::Google::Cloud::Dialogflow::V2::SearchKnowledgeResponse
           end
 
           Stub = Service.rpc_stub_class

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

@@ -151,7 +151,8 @@ module Google
                 credentials:  credentials,
                 endpoint:     @config.endpoint,
                 channel_args: @config.channel_args,
-                interceptors: @config.interceptors
+                interceptors: @config.interceptors,
+                channel_pool_config: @config.channel_pool
               )
             end
 
@@ -884,6 +885,116 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Get answers for the given query based on knowledge documents.
+            #
+            # @overload search_knowledge(request, options = nil)
+            #   Pass arguments to `search_knowledge` via a request object, either of type
+            #   {::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload search_knowledge(parent: nil, query: nil, conversation_profile: nil, session_id: nil, conversation: nil, latest_message: nil)
+            #   Pass arguments to `search_knowledge` 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).
+            #
+            #   @param parent [::String]
+            #     The parent resource contains the conversation profile
+            #     Format: 'projects/<Project ID>' or `projects/<Project
+            #     ID>/locations/<Location ID>`.
+            #   @param query [::Google::Cloud::Dialogflow::V2::TextInput, ::Hash]
+            #     Required. The natural language text query for knowledge search.
+            #   @param conversation_profile [::String]
+            #     Required. The conversation profile used to configure the search.
+            #     Format: `projects/<Project ID>/locations/<Location
+            #     ID>/conversationProfiles/<Conversation Profile ID>`.
+            #   @param session_id [::String]
+            #     The ID of the search session.
+            #     The session_id can be combined with Dialogflow V3 Agent ID retrieved from
+            #     conversation profile or on its own to identify a search session. The search
+            #     history of the same session will impact the search result. It's up to the
+            #     API caller to choose an appropriate `Session ID`. It can be a random number
+            #     or some type of session identifiers (preferably hashed). The length must
+            #     not exceed 36 characters.
+            #   @param conversation [::String]
+            #     The conversation (between human agent and end user) where the search
+            #     request is triggered. Format: `projects/<Project ID>/locations/<Location
+            #     ID>/conversations/<Conversation ID>`.
+            #   @param latest_message [::String]
+            #     The name of the latest conversation message when the request is
+            #     triggered.
+            #     Format: `projects/<Project ID>/locations/<Location
+            #     ID>/conversations/<Conversation ID>/messages/<Message ID>`.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::Dialogflow::V2::SearchKnowledgeResponse]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeResponse]
+            #
+            # @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::Conversations::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest.new
+            #
+            #   # Call the search_knowledge method.
+            #   result = client.search_knowledge request
+            #
+            #   # The returned object is of type Google::Cloud::Dialogflow::V2::SearchKnowledgeResponse.
+            #   p result
+            #
+            def search_knowledge request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.search_knowledge.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              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
+
+              options.apply_defaults timeout:      @config.rpcs.search_knowledge.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.search_knowledge.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @conversations_stub.call_rpc :search_knowledge, request, options: options do |response, operation|
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Configuration class for the Conversations API.
             #
@@ -1003,6 +1114,14 @@ module Google
                 end
               end
 
+              ##
+              # Configuration for the channel pool
+              # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
+              #
+              def channel_pool
+                @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
+              end
+
               ##
               # Configuration RPC class for the Conversations API.
               #
@@ -1056,6 +1175,11 @@ module Google
                 # @return [::Gapic::Config::Method]
                 #
                 attr_reader :generate_stateless_summary
+                ##
+                # RPC-specific configuration for `search_knowledge`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :search_knowledge
 
                 # @private
                 def initialize parent_rpcs = nil
@@ -1073,6 +1197,8 @@ module Google
                   @suggest_conversation_summary = ::Gapic::Config::Method.new suggest_conversation_summary_config
                   generate_stateless_summary_config = parent_rpcs.generate_stateless_summary if parent_rpcs.respond_to? :generate_stateless_summary
                   @generate_stateless_summary = ::Gapic::Config::Method.new generate_stateless_summary_config
+                  search_knowledge_config = parent_rpcs.search_knowledge if parent_rpcs.respond_to? :search_knowledge
+                  @search_knowledge = ::Gapic::Config::Method.new search_knowledge_config
 
                   yield self if block_given?
                 end