google-cloud-dialogflow-v2 0.11.3 → 0.13.0

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

@@ -143,6 +143,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::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 all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Longrunning::Operation.
+            #     p response
+            #   end
+            #
             def list_operations request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -160,9 +181,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -215,6 +238,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::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 this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def get_operation request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -232,9 +277,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -287,6 +334,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::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?
 
@@ -304,9 +366,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -364,6 +428,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::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?
 
@@ -381,9 +460,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -444,6 +525,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Longrunning::WaitOperationRequest.new
+            #
+            #   # Call the wait_operation method.
+            #   result = client.wait_operation request
+            #
+            #   # The returned object is of type Gapic::Operation. You can use this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def wait_operation request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 

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

@@ -20,6 +20,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :parent, :string, 1
       optional :page_size, :int32, 2
       optional :page_token, :string, 3
+      optional :filter, :string, 4
     end
     add_message "google.cloud.dialogflow.v2.ListKnowledgeBasesResponse" do
       repeated :knowledge_bases, :message, 1, "google.cloud.dialogflow.v2.KnowledgeBase"

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

@@ -162,7 +162,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload list_knowledge_bases(parent: nil, page_size: nil, page_token: nil)
+            # @overload list_knowledge_bases(parent: nil, page_size: nil, page_token: nil, filter: nil)
             #   Pass arguments to `list_knowledge_bases` 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).
@@ -175,6 +175,33 @@ module Google
             #     default 10 and at most 100.
             #   @param page_token [::String]
             #     The next_page_token value returned from a previous list request.
+            #   @param filter [::String]
+            #     The filter expression used to filter knowledge bases returned by the list
+            #     method. The expression has the following syntax:
+            #
+            #       <field> <operator> <value> [AND <field> <operator> <value>] ...
+            #
+            #     The following fields and operators are supported:
+            #
+            #     * display_name with has(:) operator
+            #     * language_code with equals(=) operator
+            #
+            #     Examples:
+            #
+            #     * 'language_code=en-us' matches knowledge bases with en-us language code.
+            #     * 'display_name:articles' matches knowledge bases whose display name
+            #       contains "articles".
+            #     * 'display_name:"Best Articles"' matches knowledge bases whose display
+            #       name contains "Best Articles".
+            #     * 'language_code=en-gb AND display_name=articles' matches all knowledge
+            #       bases whose display name contains "articles" and whose language code is
+            #       "en-gb".
+            #
+            #     Note: An empty filter string (i.e. "") is a no-op and will result in no
+            #     filtering.
+            #
+            #     For more information about filtering, see
+            #     [API Filtering](https://aip.dev/160).
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::KnowledgeBase>]
@@ -184,6 +211,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::KnowledgeBases::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::ListKnowledgeBasesRequest.new
+            #
+            #   # Call the list_knowledge_bases method.
+            #   result = client.list_knowledge_bases request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Cloud::Dialogflow::V2::KnowledgeBase.
+            #     p response
+            #   end
+            #
             def list_knowledge_bases request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -201,9 +249,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -255,6 +305,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::KnowledgeBases::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::GetKnowledgeBaseRequest.new
+            #
+            #   # Call the get_knowledge_base method.
+            #   result = client.get_knowledge_base request
+            #
+            #   # The returned object is of type Google::Cloud::Dialogflow::V2::KnowledgeBase.
+            #   p result
+            #
             def get_knowledge_base request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -272,9 +337,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -326,6 +393,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::KnowledgeBases::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::CreateKnowledgeBaseRequest.new
+            #
+            #   # Call the create_knowledge_base method.
+            #   result = client.create_knowledge_base request
+            #
+            #   # The returned object is of type Google::Cloud::Dialogflow::V2::KnowledgeBase.
+            #   p result
+            #
             def create_knowledge_base request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -343,9 +425,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -399,6 +483,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::KnowledgeBases::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::DeleteKnowledgeBaseRequest.new
+            #
+            #   # Call the delete_knowledge_base method.
+            #   result = client.delete_knowledge_base request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def delete_knowledge_base request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -416,9 +515,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -471,6 +572,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::KnowledgeBases::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::UpdateKnowledgeBaseRequest.new
+            #
+            #   # Call the update_knowledge_base method.
+            #   result = client.update_knowledge_base request
+            #
+            #   # The returned object is of type Google::Cloud::Dialogflow::V2::KnowledgeBase.
+            #   p result
+            #
             def update_knowledge_base request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -488,9 +604,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "knowledge_base.name" => request.knowledge_base.name
-              }
+              header_params = {}
+              if request.knowledge_base&.name
+                header_params["knowledge_base.name"] = request.knowledge_base.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 

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

@@ -6,6 +6,7 @@ require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/dialogflow/v2/audio_config_pb'
+require 'google/cloud/dialogflow/v2/gcs_pb'
 require 'google/cloud/dialogflow/v2/session_pb'
 require 'google/protobuf/any_pb'
 require 'google/protobuf/duration_pb'
@@ -21,6 +22,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :name, :string, 1
       optional :role, :enum, 2, "google.cloud.dialogflow.v2.Participant.Role"
       optional :sip_recording_media_label, :string, 6
+      map :documents_metadata_filters, :string, :string, 8
     end
     add_enum "google.cloud.dialogflow.v2.Participant.Role" do
       value :ROLE_UNSPECIFIED, 0
@@ -61,6 +63,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :participant, :string, 1
       optional :reply_audio_config, :message, 5, "google.cloud.dialogflow.v2.OutputAudioConfig"
       optional :query_params, :message, 9, "google.cloud.dialogflow.v2.QueryParameters"
+      optional :assist_query_params, :message, 14, "google.cloud.dialogflow.v2.AssistQueryParameters"
       optional :request_id, :string, 11
       oneof :input do
         optional :text_input, :message, 6, "google.cloud.dialogflow.v2.TextInput"
@@ -83,6 +86,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :parent, :string, 1
       optional :latest_message, :string, 2
       optional :context_size, :int32, 3
+      optional :assist_query_params, :message, 4, "google.cloud.dialogflow.v2.AssistQueryParameters"
     end
     add_message "google.cloud.dialogflow.v2.SuggestArticlesResponse" do
       repeated :article_answers, :message, 1, "google.cloud.dialogflow.v2.ArticleAnswer"
@@ -93,6 +97,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :parent, :string, 1
       optional :latest_message, :string, 2
       optional :context_size, :int32, 3
+      optional :assist_query_params, :message, 4, "google.cloud.dialogflow.v2.AssistQueryParameters"
     end
     add_message "google.cloud.dialogflow.v2.SuggestFaqAnswersResponse" do
       repeated :faq_answers, :message, 1, "google.cloud.dialogflow.v2.FaqAnswer"
@@ -145,6 +150,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       repeated :parts, :message, 1, "google.cloud.dialogflow.v2.AnnotatedMessagePart"
       optional :contain_entities, :bool, 2
     end
+    add_message "google.cloud.dialogflow.v2.AssistQueryParameters" do
+      map :documents_metadata_filters, :string, :string, 1
+    end
   end
 end
 
@@ -175,6 +183,7 @@ module Google
         SuggestionResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.SuggestionResult").msgclass
         AnnotatedMessagePart = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.AnnotatedMessagePart").msgclass
         MessageAnnotation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.MessageAnnotation").msgclass
+        AssistQueryParameters = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.AssistQueryParameters").msgclass
       end
     end
   end