google-cloud-dialogflow-cx-v3 0.22.0 → 0.23.0

data/lib/google/cloud/dialogflow/cx/v3/sessions/client.rb

@@ -571,6 +571,100 @@ module Google
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
+              ##
+              # Updates the feedback received from the user for a single turn of the bot
+              # response.
+              #
+              # @overload submit_answer_feedback(request, options = nil)
+              #   Pass arguments to `submit_answer_feedback` via a request object, either of type
+              #   {::Google::Cloud::Dialogflow::CX::V3::SubmitAnswerFeedbackRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Dialogflow::CX::V3::SubmitAnswerFeedbackRequest, ::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 submit_answer_feedback(session: nil, response_id: nil, answer_feedback: nil, update_mask: nil)
+              #   Pass arguments to `submit_answer_feedback` 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 session [::String]
+              #     Required. The name of the session the feedback was sent to.
+              #   @param response_id [::String]
+              #     Required. ID of the response to update its feedback. This is the same as
+              #     DetectIntentResponse.response_id.
+              #   @param answer_feedback [::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback, ::Hash]
+              #     Required. Feedback provided for a bot answer.
+              #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
+              #     Optional. The mask to control which fields to update. If the mask is not
+              #     present, all fields will be updated.
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback]
+              #
+              # @raise [::Google::Cloud::Error] if the RPC is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/dialogflow/cx/v3"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Dialogflow::CX::V3::Sessions::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::SubmitAnswerFeedbackRequest.new
+              #
+              #   # Call the submit_answer_feedback method.
+              #   result = client.submit_answer_feedback request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::AnswerFeedback.
+              #   p result
+              #
+              def submit_answer_feedback request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::SubmitAnswerFeedbackRequest
+
+                # 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.submit_answer_feedback.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::CX::V3::VERSION
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                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
+
+                options.apply_defaults timeout:      @config.rpcs.submit_answer_feedback.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.submit_answer_feedback.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @sessions_stub.call_rpc :submit_answer_feedback, 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 Sessions API.
               #
@@ -736,6 +830,11 @@ module Google
                   # @return [::Gapic::Config::Method]
                   #
                   attr_reader :fulfill_intent
+                  ##
+                  # RPC-specific configuration for `submit_answer_feedback`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :submit_answer_feedback
 
                   # @private
                   def initialize parent_rpcs = nil
@@ -747,6 +846,8 @@ module Google
                     @match_intent = ::Gapic::Config::Method.new match_intent_config
                     fulfill_intent_config = parent_rpcs.fulfill_intent if parent_rpcs.respond_to? :fulfill_intent
                     @fulfill_intent = ::Gapic::Config::Method.new fulfill_intent_config
+                    submit_answer_feedback_config = parent_rpcs.submit_answer_feedback if parent_rpcs.respond_to? :submit_answer_feedback
+                    @submit_answer_feedback = ::Gapic::Config::Method.new submit_answer_feedback_config
 
                     yield self if block_given?
                   end

data/lib/google/cloud/dialogflow/cx/v3/sessions/paths.rb

@@ -25,6 +25,51 @@ module Google
           module Sessions
             # Path helper methods for the Sessions API.
             module Paths
+              ##
+              # Create a fully-qualified DataStore resource string.
+              #
+              # @overload data_store_path(project:, location:, data_store:)
+              #   The resource will be in the following format:
+              #
+              #   `projects/{project}/locations/{location}/dataStores/{data_store}`
+              #
+              #   @param project [String]
+              #   @param location [String]
+              #   @param data_store [String]
+              #
+              # @overload data_store_path(project:, location:, collection:, data_store:)
+              #   The resource will be in the following format:
+              #
+              #   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
+              #
+              #   @param project [String]
+              #   @param location [String]
+              #   @param collection [String]
+              #   @param data_store [String]
+              #
+              # @return [::String]
+              def data_store_path **args
+                resources = {
+                  "data_store:location:project" => (proc do |project:, location:, data_store:|
+                    raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                    raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+                    "projects/#{project}/locations/#{location}/dataStores/#{data_store}"
+                  end),
+                  "collection:data_store:location:project" => (proc do |project:, location:, collection:, data_store:|
+                    raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                    raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+                    raise ::ArgumentError, "collection cannot contain /" if collection.to_s.include? "/"
+
+                    "projects/#{project}/locations/#{location}/collections/#{collection}/dataStores/#{data_store}"
+                  end)
+                }
+
+                resource = resources[args.keys.sort.join(":")]
+                raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
+                resource.call(**args)
+              end
+
               ##
               # Create a fully-qualified EntityType resource string.
               #

data/lib/google/cloud/dialogflow/cx/v3/sessions/rest/client.rb

@@ -455,6 +455,93 @@ module Google
                   raise ::Google::Cloud::Error.from_error(e)
                 end
 
+                ##
+                # Updates the feedback received from the user for a single turn of the bot
+                # response.
+                #
+                # @overload submit_answer_feedback(request, options = nil)
+                #   Pass arguments to `submit_answer_feedback` via a request object, either of type
+                #   {::Google::Cloud::Dialogflow::CX::V3::SubmitAnswerFeedbackRequest} or an equivalent Hash.
+                #
+                #   @param request [::Google::Cloud::Dialogflow::CX::V3::SubmitAnswerFeedbackRequest, ::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 submit_answer_feedback(session: nil, response_id: nil, answer_feedback: nil, update_mask: nil)
+                #   Pass arguments to `submit_answer_feedback` 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 session [::String]
+                #     Required. The name of the session the feedback was sent to.
+                #   @param response_id [::String]
+                #     Required. ID of the response to update its feedback. This is the same as
+                #     DetectIntentResponse.response_id.
+                #   @param answer_feedback [::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback, ::Hash]
+                #     Required. Feedback provided for a bot answer.
+                #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
+                #     Optional. The mask to control which fields to update. If the mask is not
+                #     present, all fields will be updated.
+                # @yield [result, operation] Access the result along with the TransportOperation object
+                # @yieldparam result [::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback]
+                # @yieldparam operation [::Gapic::Rest::TransportOperation]
+                #
+                # @return [::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback]
+                #
+                # @raise [::Google::Cloud::Error] if the REST call is aborted.
+                #
+                # @example Basic example
+                #   require "google/cloud/dialogflow/cx/v3"
+                #
+                #   # Create a client object. The client can be reused for multiple calls.
+                #   client = Google::Cloud::Dialogflow::CX::V3::Sessions::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Dialogflow::CX::V3::SubmitAnswerFeedbackRequest.new
+                #
+                #   # Call the submit_answer_feedback method.
+                #   result = client.submit_answer_feedback request
+                #
+                #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::AnswerFeedback.
+                #   p result
+                #
+                def submit_answer_feedback request, options = nil
+                  raise ::ArgumentError, "request must be provided" if request.nil?
+
+                  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::SubmitAnswerFeedbackRequest
+
+                  # 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.submit_answer_feedback.metadata.to_h
+
+                  # Set x-goog-api-client and x-goog-user-project 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::CX::V3::VERSION,
+                    transports_version_send: [:rest]
+
+                  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                  options.apply_defaults timeout:      @config.rpcs.submit_answer_feedback.timeout,
+                                         metadata:     call_metadata,
+                                         retry_policy: @config.rpcs.submit_answer_feedback.retry_policy
+
+                  options.apply_defaults timeout:      @config.timeout,
+                                         metadata:     @config.metadata,
+                                         retry_policy: @config.retry_policy
+
+                  @sessions_stub.submit_answer_feedback 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 Sessions REST API.
                 #
@@ -602,6 +689,11 @@ module Google
                     # @return [::Gapic::Config::Method]
                     #
                     attr_reader :fulfill_intent
+                    ##
+                    # RPC-specific configuration for `submit_answer_feedback`
+                    # @return [::Gapic::Config::Method]
+                    #
+                    attr_reader :submit_answer_feedback
 
                     # @private
                     def initialize parent_rpcs = nil
@@ -611,6 +703,8 @@ module Google
                       @match_intent = ::Gapic::Config::Method.new match_intent_config
                       fulfill_intent_config = parent_rpcs.fulfill_intent if parent_rpcs.respond_to? :fulfill_intent
                       @fulfill_intent = ::Gapic::Config::Method.new fulfill_intent_config
+                      submit_answer_feedback_config = parent_rpcs.submit_answer_feedback if parent_rpcs.respond_to? :submit_answer_feedback
+                      @submit_answer_feedback = ::Gapic::Config::Method.new submit_answer_feedback_config
 
                       yield self if block_given?
                     end

data/lib/google/cloud/dialogflow/cx/v3/sessions/rest/service_stub.rb

@@ -155,6 +155,44 @@ module Google
                   result
                 end
 
+                ##
+                # Baseline implementation for the submit_answer_feedback REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::SubmitAnswerFeedbackRequest]
+                #   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::CX::V3::AnswerFeedback]
+                # @yieldparam operation [::Gapic::Rest::TransportOperation]
+                #
+                # @return [::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback]
+                #   A result object deserialized from the server's reply
+                def submit_answer_feedback request_pb, options = nil
+                  raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                  verb, uri, query_string_params, body = ServiceStub.transcode_submit_answer_feedback_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::CX::V3::AnswerFeedback.decode_json response.body, ignore_unknown_fields: true
+
+                  yield result, operation if block_given?
+                  result
+                end
+
                 ##
                 # @private
                 #
@@ -244,6 +282,28 @@ module Google
                                                           )
                   transcoder.transcode request_pb
                 end
+
+                ##
+                # @private
+                #
+                # GRPC transcoding helper method for the submit_answer_feedback REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::SubmitAnswerFeedbackRequest]
+                #   A request object representing the call parameters. Required.
+                # @return [Array(String, [String, nil], Hash{String => String})]
+                #   Uri, Body, Query string parameters
+                def self.transcode_submit_answer_feedback_request request_pb
+                  transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                          .with_bindings(
+                                                            uri_method: :post,
+                                                            uri_template: "/v3/{session}:submitAnswerFeedback",
+                                                            body: "*",
+                                                            matches: [
+                                                              ["session", %r{^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+/?$}, false]
+                                                            ]
+                                                          )
+                  transcoder.transcode request_pb
+                end
               end
             end
           end

data/lib/google/cloud/dialogflow/cx/v3/version.rb

@@ -22,7 +22,7 @@ module Google
     module Dialogflow
       module CX
         module V3
-          VERSION = "0.22.0"
+          VERSION = "0.23.0"
         end
       end
     end

data/lib/google/cloud/dialogflow/cx/v3.rb

@@ -30,6 +30,7 @@ require "google/cloud/dialogflow/cx/v3/test_cases"
 require "google/cloud/dialogflow/cx/v3/webhooks"
 require "google/cloud/dialogflow/cx/v3/environments"
 require "google/cloud/dialogflow/cx/v3/experiments"
+require "google/cloud/dialogflow/cx/v3/generators"
 require "google/cloud/dialogflow/cx/v3/security_settings_service"
 require "google/cloud/dialogflow/cx/v3/versions"
 require "google/cloud/dialogflow/cx/v3/version"

data/proto_docs/google/api/client.rb

@@ -304,6 +304,19 @@ module Google
     #                seconds: 360 # 6 minutes
     #              total_poll_timeout:
     #                 seconds: 54000 # 90 minutes
+    # @!attribute [rw] auto_populated_fields
+    #   @return [::Array<::String>]
+    #     List of top-level fields of the request message, that should be
+    #     automatically populated by the client libraries based on their
+    #     (google.api.field_info).format. Currently supported format: UUID4.
+    #
+    #     Example of a YAML configuration:
+    #
+    #      publishing:
+    #        method_settings:
+    #          - selector: google.example.v1.ExampleService.CreateExample
+    #            auto_populated_fields:
+    #            - request_id
     class MethodSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/dialogflow/cx/v3/agent.rb

@@ -127,6 +127,9 @@ module Google
           # @!attribute [rw] gen_app_builder_settings
           #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::GenAppBuilderSettings]
           #     Gen App Builder-related agent-level settings.
+          # @!attribute [rw] answer_feedback_settings
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Agent::AnswerFeedbackSettings]
+          #     Optional. Answer feedback collection settings.
           class Agent
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -172,6 +175,18 @@ module Google
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
+
+            # Settings for answer feedback collection.
+            # @!attribute [rw] enable_answer_feedback
+            #   @return [::Boolean]
+            #     Optional. If enabled, end users will be able to provide
+            #     {::Google::Cloud::Dialogflow::CX::V3::AnswerFeedback answer feedback} to
+            #     Dialogflow responses. Feature works only if interaction logging is
+            #     enabled in the Dialogflow agent.
+            class AnswerFeedbackSettings
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
           end
 
           # The request message for

data/proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb

@@ -50,6 +50,42 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # Configuration of the barge-in behavior. Barge-in instructs the API to return
+          # a detected utterance at a proper time while the client is playing back the
+          # response audio from a previous request. When the client sees the
+          # utterance, it should stop the playback and immediately get ready for
+          # receiving the responses for the current request.
+          #
+          # The barge-in handling requires the client to start streaming audio input
+          # as soon as it starts playing back the audio from the previous response. The
+          # playback is modeled into two phases:
+          #
+          # * No barge-in phase: which goes first and during which speech detection
+          #   should not be carried out.
+          #
+          # * Barge-in phase: which follows the no barge-in phase and during which
+          #   the API starts speech detection and may inform the client that an utterance
+          #   has been detected. Note that no-speech event is not expected in this
+          #   phase.
+          #
+          # The client provides this configuration in terms of the durations of those
+          # two phases. The durations are measured in terms of the audio length from the
+          # the start of the input audio.
+          #
+          # No-speech event is a response with END_OF_UTTERANCE without any transcript
+          # following up.
+          # @!attribute [rw] no_barge_in_duration
+          #   @return [::Google::Protobuf::Duration]
+          #     Duration that is not eligible for barge-in at the beginning of the input
+          #     audio.
+          # @!attribute [rw] total_duration
+          #   @return [::Google::Protobuf::Duration]
+          #     Total duration for the playback at the beginning of the input audio.
+          class BargeInConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # Instructs the speech recognizer on how to process the audio content.
           # @!attribute [rw] audio_encoding
           #   @return [::Google::Cloud::Dialogflow::CX::V3::AudioEncoding]
@@ -81,8 +117,8 @@ module Google
           #   @return [::String]
           #     Optional. Which Speech model to select for the given request. Select the
           #     model best suited to your domain to get best results. If a model is not
-          #     explicitly specified, then we auto-select a model based on the parameters
-          #     in the InputAudioConfig.
+          #     explicitly specified, then Dialogflow auto-selects a model based on other
+          #     parameters in the InputAudioConfig and Agent settings.
           #     If enhanced speech model is enabled for the agent and an enhanced
           #     version of the specified model for the language does not exist, then the
           #     speech is recognized using the standard version of the specified model.
@@ -95,7 +131,12 @@ module Google
           #
           #     - phone_call (best for Agent Assist and telephony)
           #     - latest_short (best for Dialogflow non-telephony)
-          #     - command_and_search (best for very short utterances and commands)
+          #     - command_and_search
+          #
+          #     Leave this field unspecified to use
+          #     [Agent Speech
+          #     settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech)
+          #     for model selection.
           # @!attribute [rw] model_variant
           #   @return [::Google::Cloud::Dialogflow::CX::V3::SpeechModelVariant]
           #     Optional. Which variant of the [Speech
@@ -110,6 +151,9 @@ module Google
           #     client should close the stream and start a new request with a new stream as
           #     needed.
           #     Note: This setting is relevant only for streaming methods.
+          # @!attribute [rw] barge_in_config
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::BargeInConfig]
+          #     Configuration of barge-in behavior during the streaming of input audio.
           class InputAudioConfig
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods