google-cloud-dialogflow-v2 1.0.0 → 1.1.0

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

@@ -1073,6 +1073,109 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Gets knowledge assist suggestions based on historical messages.
+            #
+            # @overload suggest_knowledge_assist(request, options = nil)
+            #   Pass arguments to `suggest_knowledge_assist` via a request object, either of type
+            #   {::Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistRequest, ::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 suggest_knowledge_assist(parent: nil, latest_message: nil, context_size: nil, previous_suggested_query: nil)
+            #   Pass arguments to `suggest_knowledge_assist` 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]
+            #     Required. The name of the participant to fetch suggestions for.
+            #     Format: `projects/<Project ID>/locations/<Location
+            #     ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
+            #   @param latest_message [::String]
+            #     Optional. The name of the latest conversation message to compile
+            #     suggestions for. If empty, it will be the latest message of the
+            #     conversation. Format: `projects/<Project ID>/locations/<Location
+            #     ID>/conversations/<Conversation ID>/messages/<Message ID>`.
+            #   @param context_size [::Integer]
+            #     Optional. Max number of messages prior to and including
+            #     {::Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistRequest#latest_message latest_message}
+            #     to use as context when compiling the suggestion. The context size is by
+            #     default 100 and at most 100.
+            #   @param previous_suggested_query [::String]
+            #     Optional. The previously suggested query for the given conversation. This
+            #     helps identify whether the next suggestion we generate is resonably
+            #     different from the previous one. This is useful to avoid similar
+            #     suggestions within the conversation.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistResponse]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistResponse]
+            #
+            # @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::SuggestKnowledgeAssistRequest.new
+            #
+            #   # Call the suggest_knowledge_assist method.
+            #   result = client.suggest_knowledge_assist request
+            #
+            #   # The returned object is of type Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistResponse.
+            #   p result
+            #
+            def suggest_knowledge_assist request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistRequest
+
+              # 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.suggest_knowledge_assist.metadata.to_h
+
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
+              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.suggest_knowledge_assist.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.suggest_knowledge_assist.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @participants_stub.call_rpc :suggest_knowledge_assist, 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 Participants API.
             #
@@ -1271,6 +1374,11 @@ module Google
                 # @return [::Gapic::Config::Method]
                 #
                 attr_reader :suggest_smart_replies
+                ##
+                # RPC-specific configuration for `suggest_knowledge_assist`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :suggest_knowledge_assist
 
                 # @private
                 def initialize parent_rpcs = nil
@@ -1292,6 +1400,8 @@ module Google
                   @suggest_faq_answers = ::Gapic::Config::Method.new suggest_faq_answers_config
                   suggest_smart_replies_config = parent_rpcs.suggest_smart_replies if parent_rpcs.respond_to? :suggest_smart_replies
                   @suggest_smart_replies = ::Gapic::Config::Method.new suggest_smart_replies_config
+                  suggest_knowledge_assist_config = parent_rpcs.suggest_knowledge_assist if parent_rpcs.respond_to? :suggest_knowledge_assist
+                  @suggest_knowledge_assist = ::Gapic::Config::Method.new suggest_knowledge_assist_config
 
                   yield self if block_given?
                 end

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

@@ -916,6 +916,102 @@ module Google
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
+              ##
+              # Gets knowledge assist suggestions based on historical messages.
+              #
+              # @overload suggest_knowledge_assist(request, options = nil)
+              #   Pass arguments to `suggest_knowledge_assist` via a request object, either of type
+              #   {::Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistRequest, ::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 suggest_knowledge_assist(parent: nil, latest_message: nil, context_size: nil, previous_suggested_query: nil)
+              #   Pass arguments to `suggest_knowledge_assist` 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]
+              #     Required. The name of the participant to fetch suggestions for.
+              #     Format: `projects/<Project ID>/locations/<Location
+              #     ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
+              #   @param latest_message [::String]
+              #     Optional. The name of the latest conversation message to compile
+              #     suggestions for. If empty, it will be the latest message of the
+              #     conversation. Format: `projects/<Project ID>/locations/<Location
+              #     ID>/conversations/<Conversation ID>/messages/<Message ID>`.
+              #   @param context_size [::Integer]
+              #     Optional. Max number of messages prior to and including
+              #     {::Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistRequest#latest_message latest_message}
+              #     to use as context when compiling the suggestion. The context size is by
+              #     default 100 and at most 100.
+              #   @param previous_suggested_query [::String]
+              #     Optional. The previously suggested query for the given conversation. This
+              #     helps identify whether the next suggestion we generate is resonably
+              #     different from the previous one. This is useful to avoid similar
+              #     suggestions within the conversation.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistResponse]
+              #
+              # @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::Participants::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistRequest.new
+              #
+              #   # Call the suggest_knowledge_assist method.
+              #   result = client.suggest_knowledge_assist request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistResponse.
+              #   p result
+              #
+              def suggest_knowledge_assist request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistRequest
+
+                # 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
+                call_metadata = @config.rpcs.suggest_knowledge_assist.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+                call_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,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.suggest_knowledge_assist.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.suggest_knowledge_assist.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @participants_stub.suggest_knowledge_assist request, options do |result, operation|
+                  yield result, operation if block_given?
+                  return result
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
               ##
               # Configuration class for the Participants REST API.
               #
@@ -1096,6 +1192,11 @@ module Google
                   # @return [::Gapic::Config::Method]
                   #
                   attr_reader :suggest_smart_replies
+                  ##
+                  # RPC-specific configuration for `suggest_knowledge_assist`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :suggest_knowledge_assist
 
                   # @private
                   def initialize parent_rpcs = nil
@@ -1115,6 +1216,8 @@ module Google
                     @suggest_faq_answers = ::Gapic::Config::Method.new suggest_faq_answers_config
                     suggest_smart_replies_config = parent_rpcs.suggest_smart_replies if parent_rpcs.respond_to? :suggest_smart_replies
                     @suggest_smart_replies = ::Gapic::Config::Method.new suggest_smart_replies_config
+                    suggest_knowledge_assist_config = parent_rpcs.suggest_knowledge_assist if parent_rpcs.respond_to? :suggest_knowledge_assist
+                    @suggest_knowledge_assist = ::Gapic::Config::Method.new suggest_knowledge_assist_config
 
                     yield self if block_given?
                   end

data/lib/google/cloud/dialogflow/v2/participants/rest/service_stub.rb

@@ -365,6 +365,44 @@ module Google
                 result
               end
 
+              ##
+              # Baseline implementation for the suggest_knowledge_assist REST call
+              #
+              # @param request_pb [::Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistResponse]
+              #   A result object deserialized from the server's reply
+              def suggest_knowledge_assist request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_suggest_knowledge_assist_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split "=", 2 }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistResponse.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
               ##
               # @private
               #
@@ -600,6 +638,36 @@ module Google
                                                         )
                 transcoder.transcode request_pb
               end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the suggest_knowledge_assist REST call
+              #
+              # @param request_pb [::Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_suggest_knowledge_assist_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v2/{parent}/suggestions:suggestKnowledgeAssist",
+                                                          body: "*",
+                                                          matches: [
+                                                            ["parent", %r{^projects/[^/]+/conversations/[^/]+/participants/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v2/{parent}/suggestions:suggestKnowledgeAssist",
+                                                          body: "*",
+                                                          matches: [
+                                                            ["parent", %r{^projects/[^/]+/locations/[^/]+/conversations/[^/]+/participants/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
             end
           end
         end

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

@@ -25,10 +25,12 @@ require "google/cloud/dialogflow/v2/sessions/rest"
 require "google/cloud/dialogflow/v2/participants/rest"
 require "google/cloud/dialogflow/v2/answer_records/rest"
 require "google/cloud/dialogflow/v2/conversation_profiles/rest"
+require "google/cloud/dialogflow/v2/generators/rest"
 require "google/cloud/dialogflow/v2/conversations/rest"
 require "google/cloud/dialogflow/v2/conversation_datasets/rest"
 require "google/cloud/dialogflow/v2/conversation_models/rest"
 require "google/cloud/dialogflow/v2/documents/rest"
+require "google/cloud/dialogflow/v2/encryption_spec_service/rest"
 require "google/cloud/dialogflow/v2/fulfillments/rest"
 require "google/cloud/dialogflow/v2/environments/rest"
 require "google/cloud/dialogflow/v2/knowledge_bases/rest"

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Dialogflow
       module V2
-        VERSION = "1.0.0"
+        VERSION = "1.1.0"
       end
     end
   end

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

@@ -25,10 +25,12 @@ require "google/cloud/dialogflow/v2/sessions"
 require "google/cloud/dialogflow/v2/participants"
 require "google/cloud/dialogflow/v2/answer_records"
 require "google/cloud/dialogflow/v2/conversation_profiles"
+require "google/cloud/dialogflow/v2/generators"
 require "google/cloud/dialogflow/v2/conversations"
 require "google/cloud/dialogflow/v2/conversation_datasets"
 require "google/cloud/dialogflow/v2/conversation_models"
 require "google/cloud/dialogflow/v2/documents"
+require "google/cloud/dialogflow/v2/encryption_spec_service"
 require "google/cloud/dialogflow/v2/fulfillments"
 require "google/cloud/dialogflow/v2/environments"
 require "google/cloud/dialogflow/v2/knowledge_bases"

data/proto_docs/google/api/client.rb

@@ -290,6 +290,13 @@ module Google
     #   @return [::String]
     #     The fully qualified name of the method, for which the options below apply.
     #     This is used to find the method to apply the options.
+    #
+    #     Example:
+    #
+    #        publishing:
+    #          method_settings:
+    #          - selector: google.storage.control.v2.StorageControl.CreateFolder
+    #            # method settings for CreateFolder...
     # @!attribute [rw] long_running
     #   @return [::Google::Api::MethodSettings::LongRunning]
     #     Describes settings to use for long-running operations when generating
@@ -298,17 +305,14 @@ module Google
     #
     #     Example of a YAML configuration::
     #
-    #      publishing:
-    #        method_settings:
+    #        publishing:
+    #          method_settings:
     #          - selector: google.cloud.speech.v2.Speech.BatchRecognize
     #            long_running:
-    #              initial_poll_delay:
-    #                seconds: 60 # 1 minute
+    #              initial_poll_delay: 60s # 1 minute
     #              poll_delay_multiplier: 1.5
-    #              max_poll_delay:
-    #                seconds: 360 # 6 minutes
-    #              total_poll_timeout:
-    #                 seconds: 54000 # 90 minutes
+    #              max_poll_delay: 360s # 6 minutes
+    #              total_poll_timeout: 54000s # 90 minutes
     # @!attribute [rw] auto_populated_fields
     #   @return [::Array<::String>]
     #     List of top-level fields of the request message, that should be
@@ -317,8 +321,8 @@ module Google
     #
     #     Example of a YAML configuration:
     #
-    #      publishing:
-    #        method_settings:
+    #        publishing:
+    #          method_settings:
     #          - selector: google.example.v1.ExampleService.CreateExample
     #            auto_populated_fields:
     #            - request_id

data/proto_docs/google/api/resource.rb

@@ -124,8 +124,13 @@ module Google
     #   @return [::String]
     #     The plural name used in the resource name and permission names, such as
     #     'projects' for the resource name of 'projects/\\{project}' and the permission
-    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
-    #     concept of the `plural` field in k8s CRD spec
+    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. One exception
+    #     to this is for Nested Collections that have stuttering names, as defined
+    #     in [AIP-122](https://google.aip.dev/122#nested-collections), where the
+    #     collection ID in the resource name pattern does not necessarily directly
+    #     match the `plural` value.
+    #
+    #     It is the same concept of the `plural` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
     #
     #     Note: The plural form is required even for singleton resources. See

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

@@ -210,6 +210,9 @@ module Google
         # @!attribute [rw] knowledge_search_feedback
         #   @return [::Google::Cloud::Dialogflow::V2::AgentAssistantFeedback::KnowledgeSearchFeedback]
         #     Optional. Feedback for knowledge search.
+        # @!attribute [rw] knowledge_assist_feedback
+        #   @return [::Google::Cloud::Dialogflow::V2::AgentAssistantFeedback::KnowledgeAssistFeedback]
+        #     Optional. Feedback for knowledge assist.
         class AgentAssistantFeedback
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -260,6 +263,25 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # Feedback for knowledge assist.
+          # @!attribute [rw] answer_copied
+          #   @return [::Boolean]
+          #     Whether the suggested answer was copied by the human agent.
+          #     If the value is set to be true,
+          #     {::Google::Cloud::Dialogflow::V2::AnswerFeedback#clicked AnswerFeedback.clicked}
+          #     will be updated to be true.
+          # @!attribute [rw] clicked_uris
+          #   @return [::Array<::String>]
+          #     The URIs clicked by the human agent. The value is appended for each
+          #     UpdateAnswerRecordRequest.
+          #     If the value is not empty,
+          #     {::Google::Cloud::Dialogflow::V2::AnswerFeedback#clicked AnswerFeedback.clicked}
+          #     will be updated to be true.
+          class KnowledgeAssistFeedback
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # Relevance of an answer.
           module AnswerRelevance
             # Answer relevance unspecified.

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

@@ -291,6 +291,30 @@ module Google
         #     [Agent Speech
         #     settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech)
         #     for model selection.
+        # @!attribute [rw] audio_encoding
+        #   @return [::Google::Cloud::Dialogflow::V2::AudioEncoding]
+        #     Audio encoding of the audio content to process.
+        # @!attribute [rw] sample_rate_hertz
+        #   @return [::Integer]
+        #     Sample rate (in Hertz) of the audio content sent in the query.
+        #     Refer to [Cloud Speech API
+        #     documentation](https://cloud.google.com/speech-to-text/docs/basics) for
+        #     more details.
+        # @!attribute [rw] language_code
+        #   @return [::String]
+        #     The language of the supplied audio. Dialogflow does not do
+        #     translations. See [Language
+        #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
+        #     for a list of the currently supported language codes. Note that queries in
+        #     the same session do not necessarily need to specify the same language.
+        # @!attribute [rw] enable_word_info
+        #   @return [::Boolean]
+        #     If `true`, Dialogflow returns
+        #     {::Google::Cloud::Dialogflow::V2::SpeechWordInfo SpeechWordInfo} in
+        #     {::Google::Cloud::Dialogflow::V2::StreamingRecognitionResult StreamingRecognitionResult}
+        #     with information about the recognized speech words, e.g. start and end time
+        #     offsets. If false or unspecified, Speech doesn't return any word-level
+        #     information.
         # @!attribute [rw] use_timeout_based_endpointing
         #   @return [::Boolean]
         #     Use timeout based endpointing, interpreting endpointer sensitivy as