google-cloud-dialogflow-v2 1.0.0 → 1.1.0

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

@@ -318,18 +318,9 @@ module Google
               #   @param page_token [::String]
               #     Optional. The next_page_token value returned from a previous list request.
               #   @param filter [::String]
-              #     A filter expression that filters conversations listed in the response. In
-              #     general, the expression must specify the field name, a comparison operator,
-              #     and the value to use for filtering:
-              #     <ul>
-              #       <li>The value must be a string, a number, or a boolean.</li>
-              #       <li>The comparison operator must be either `=`,`!=`, `>`, or `<`.</li>
-              #       <li>To filter on multiple expressions, separate the
-              #           expressions with `AND` or `OR` (omitting both implies `AND`).</li>
-              #       <li>For clarity, expressions can be enclosed in parentheses.</li>
-              #     </ul>
-              #     Only `lifecycle_state` can be filtered on in this way. For example,
-              #     the following expression only returns `COMPLETED` conversations:
+              #     Optional. A filter expression that filters conversations listed in the
+              #     response. Only `lifecycle_state` can be filtered on in this way. For
+              #     example, the following expression only returns `COMPLETED` conversations:
               #
               #     `lifecycle_state = "COMPLETED"`
               #
@@ -691,18 +682,19 @@ module Google
               #     Format: `projects/<Project ID>/locations/<Location
               #     ID>/conversations/<Conversation ID>`.
               #   @param latest_message [::String]
-              #     The name of the latest conversation message used as context for
+              #     Optional. The name of the latest conversation message used as context for
               #     compiling suggestion. If empty, the latest message of the conversation will
               #     be used.
               #
               #     Format: `projects/<Project ID>/locations/<Location
               #     ID>/conversations/<Conversation ID>/messages/<Message ID>`.
               #   @param context_size [::Integer]
-              #     Max number of messages prior to and including
+              #     Optional. Max number of messages prior to and including
               #     [latest_message] to use as context when compiling the
               #     suggestion. By default 500 and at most 1000.
               #   @param assist_query_params [::Google::Cloud::Dialogflow::V2::AssistQueryParameters, ::Hash]
-              #     Parameters for a human assist query. Only used for POC/demo purpose.
+              #     Optional. Parameters for a human assist query. Only used for POC/demo
+              #     purpose.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::Dialogflow::V2::SuggestConversationSummaryResponse]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -789,12 +781,12 @@ module Google
               #     Required fields: \\{language_code, security_settings}
               #     Optional fields: \\{agent_assistant_config}
               #   @param latest_message [::String]
-              #     The name of the latest conversation message used as context for
+              #     Optional. The name of the latest conversation message used as context for
               #     generating a Summary. If empty, the latest message of the conversation will
               #     be used. The format is specific to the user and the names of the messages
               #     provided.
               #   @param max_context_size [::Integer]
-              #     Max number of messages prior to and including
+              #     Optional. Max number of messages prior to and including
               #     [latest_message] to use as context when compiling the
               #     suggestion. By default 500 and at most 1000.
               # @yield [result, operation] Access the result along with the TransportOperation object
@@ -856,6 +848,98 @@ module Google
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
+              ##
+              # Generates and returns a suggestion for a conversation that does not have a
+              # resource created for it.
+              #
+              # @overload generate_stateless_suggestion(request, options = nil)
+              #   Pass arguments to `generate_stateless_suggestion` via a request object, either of type
+              #   {::Google::Cloud::Dialogflow::V2::GenerateStatelessSuggestionRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Dialogflow::V2::GenerateStatelessSuggestionRequest, ::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 generate_stateless_suggestion(parent: nil, generator: nil, generator_name: nil, conversation_context: nil, trigger_events: nil)
+              #   Pass arguments to `generate_stateless_suggestion` 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 parent resource to charge for the Suggestion's generation.
+              #     Format: `projects/<Project ID>/locations/<Location ID>`.
+              #   @param generator [::Google::Cloud::Dialogflow::V2::Generator, ::Hash]
+              #     Uncreated generator. It should be a complete generator that includes all
+              #     information about the generator.
+              #   @param generator_name [::String]
+              #     The resource name of the existing created generator. Format:
+              #     `projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>`
+              #   @param conversation_context [::Google::Cloud::Dialogflow::V2::ConversationContext, ::Hash]
+              #     Optional. Context of the conversation, including transcripts.
+              #   @param trigger_events [::Array<::Google::Cloud::Dialogflow::V2::TriggerEvent>]
+              #     Optional. A list of trigger events. Generator will be triggered only if
+              #     it's trigger event is included here.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::Dialogflow::V2::GenerateStatelessSuggestionResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Dialogflow::V2::GenerateStatelessSuggestionResponse]
+              #
+              # @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::Conversations::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::V2::GenerateStatelessSuggestionRequest.new
+              #
+              #   # Call the generate_stateless_suggestion method.
+              #   result = client.generate_stateless_suggestion request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::V2::GenerateStatelessSuggestionResponse.
+              #   p result
+              #
+              def generate_stateless_suggestion request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::GenerateStatelessSuggestionRequest
+
+                # 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.generate_stateless_suggestion.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.generate_stateless_suggestion.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.generate_stateless_suggestion.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @conversations_stub.generate_stateless_suggestion 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
+
               ##
               # Get answers for the given query based on knowledge documents.
               #
@@ -875,7 +959,7 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param parent [::String]
-              #     The parent resource contains the conversation profile
+              #     Required. 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]
@@ -885,7 +969,7 @@ module Google
               #     Format: `projects/<Project ID>/locations/<Location
               #     ID>/conversationProfiles/<Conversation Profile ID>`.
               #   @param session_id [::String]
-              #     The ID of the search session.
+              #     Required. 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
@@ -893,11 +977,11 @@ module Google
               #     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>`.
+              #     Optional. 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
+              #     Optional. 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>`.
@@ -1136,6 +1220,11 @@ module Google
                   #
                   attr_reader :generate_stateless_summary
                   ##
+                  # RPC-specific configuration for `generate_stateless_suggestion`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :generate_stateless_suggestion
+                  ##
                   # RPC-specific configuration for `search_knowledge`
                   # @return [::Gapic::Config::Method]
                   #
@@ -1157,6 +1246,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
+                    generate_stateless_suggestion_config = parent_rpcs.generate_stateless_suggestion if parent_rpcs.respond_to? :generate_stateless_suggestion
+                    @generate_stateless_suggestion = ::Gapic::Config::Method.new generate_stateless_suggestion_config
                     search_knowledge_config = parent_rpcs.search_knowledge if parent_rpcs.respond_to? :search_knowledge
                     @search_knowledge = ::Gapic::Config::Method.new search_knowledge_config
 

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

@@ -327,6 +327,44 @@ module Google
                 result
               end
 
+              ##
+              # Baseline implementation for the generate_stateless_suggestion REST call
+              #
+              # @param request_pb [::Google::Cloud::Dialogflow::V2::GenerateStatelessSuggestionRequest]
+              #   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::GenerateStatelessSuggestionResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Dialogflow::V2::GenerateStatelessSuggestionResponse]
+              #   A result object deserialized from the server's reply
+              def generate_stateless_suggestion request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_generate_stateless_suggestion_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::GenerateStatelessSuggestionResponse.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
               ##
               # Baseline implementation for the search_knowledge REST call
               #
@@ -569,6 +607,28 @@ module Google
                 transcoder.transcode request_pb
               end
 
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the generate_stateless_suggestion REST call
+              #
+              # @param request_pb [::Google::Cloud::Dialogflow::V2::GenerateStatelessSuggestionRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_generate_stateless_suggestion_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v2/{parent}/statelessSuggestion:generate",
+                                                          body: "*",
+                                                          matches: [
+                                                            ["parent", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
               ##
               # @private
               #

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/dialogflow/v2/encryption_spec.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/client_pb'
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/longrunning/operations_pb'
+
+
+descriptor_data = "\n0google/cloud/dialogflow/v2/encryption_spec.proto\x12\x1agoogle.cloud.dialogflow.v2\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a#google/longrunning/operations.proto\"Z\n\x18GetEncryptionSpecRequest\x12>\n\x04name\x18\x01 \x01(\tB0\xe0\x41\x02\xfa\x41*\n(dialogflow.googleapis.com/EncryptionSpec\"\xc3\x01\n\x0e\x45ncryptionSpec\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x05\x12\x14\n\x07kms_key\x18\x02 \x01(\tB\x03\xe0\x41\x02:\x87\x01\xea\x41\x83\x01\n(dialogflow.googleapis.com/EncryptionSpec\x12\x36projects/{project}/locations/{location}/encryptionSpec*\x0f\x65ncryptionSpecs2\x0e\x65ncryptionSpec\"k\n\x1fInitializeEncryptionSpecRequest\x12H\n\x0f\x65ncryption_spec\x18\x01 \x01(\x0b\x32*.google.cloud.dialogflow.v2.EncryptionSpecB\x03\xe0\x41\x02\"\"\n InitializeEncryptionSpecResponse\"u\n InitializeEncryptionSpecMetadata\x12Q\n\x07request\x18\x04 \x01(\x0b\x32;.google.cloud.dialogflow.v2.InitializeEncryptionSpecRequestB\x03\xe0\x41\x03\x32\xf5\x04\n\x15\x45ncryptionSpecService\x12\xb6\x01\n\x11GetEncryptionSpec\x12\x34.google.cloud.dialogflow.v2.GetEncryptionSpecRequest\x1a*.google.cloud.dialogflow.v2.EncryptionSpec\"?\xda\x41\x04name\x82\xd3\xe4\x93\x02\x32\x12\x30/v2/{name=projects/*/locations/*/encryptionSpec}\x12\xa8\x02\n\x18InitializeEncryptionSpec\x12;.google.cloud.dialogflow.v2.InitializeEncryptionSpecRequest\x1a\x1d.google.longrunning.Operation\"\xaf\x01\xca\x41\x44\n InitializeEncryptionSpecResponse\x12 InitializeEncryptionSpecMetadata\xda\x41\x0f\x65ncryption_spec\x82\xd3\xe4\x93\x02P\"K/v2/{encryption_spec.name=projects/*/locations/*/encryptionSpec}:initialize:\x01*\x1ax\xca\x41\x19\x64ialogflow.googleapis.com\xd2\x41Yhttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/dialogflowB\x9c\x01\n\x1e\x63om.google.cloud.dialogflow.v2B\x13\x45ncryptionSpecProtoP\x01Z>cloud.google.com/go/dialogflow/apiv2/dialogflowpb;dialogflowpb\xf8\x01\x01\xa2\x02\x02\x44\x46\xaa\x02\x1aGoogle.Cloud.Dialogflow.V2b\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+
+begin
+  pool.add_serialized_file(descriptor_data)
+rescue TypeError
+  # Compatibility code: will be removed in the next major version.
+  require 'google/protobuf/descriptor_pb'
+  parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
+  parsed.clear_dependency
+  serialized = parsed.class.encode(parsed)
+  file = pool.add_serialized_file(serialized)
+  warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
+  imports = [
+  ]
+  imports.each do |type_name, expected_filename|
+    import_file = pool.lookup(type_name).file_descriptor
+    if import_file.name != expected_filename
+      warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
+    end
+  end
+  warn "Each proto file must use a consistent fully-qualified name."
+  warn "This will become an error in the next major version."
+end
+
+module Google
+  module Cloud
+    module Dialogflow
+      module V2
+        GetEncryptionSpecRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.GetEncryptionSpecRequest").msgclass
+        EncryptionSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.EncryptionSpec").msgclass
+        InitializeEncryptionSpecRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.InitializeEncryptionSpecRequest").msgclass
+        InitializeEncryptionSpecResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.InitializeEncryptionSpecResponse").msgclass
+        InitializeEncryptionSpecMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.InitializeEncryptionSpecMetadata").msgclass
+      end
+    end
+  end
+end