google-cloud-dialogflow-cx-v3 0.1.1 → 0.4.0

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

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/dialogflow/cx/v3/session_entity_type.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
@@ -10,6 +8,8 @@ require 'google/api/resource_pb'
 require 'google/cloud/dialogflow/cx/v3/entity_type_pb'
 require 'google/protobuf/empty_pb'
 require 'google/protobuf/field_mask_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/dialogflow/cx/v3/session_entity_type.proto", :syntax => :proto3) do
     add_message "google.cloud.dialogflow.cx.v3.SessionEntityType" do

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

@@ -28,7 +28,7 @@ module Google
             # Service for managing [SessionEntityTypes][google.cloud.dialogflow.cx.v3.SessionEntityType].
             class Service
 
-              include GRPC::GenericService
+              include ::GRPC::GenericService
 
               self.marshal_class_method = :encode
               self.unmarshal_class_method = :decode

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

@@ -189,6 +189,27 @@ module Google
               #
               # @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::SessionEntityTypes::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::ListSessionEntityTypesRequest.new
+              #
+              #   # Call the list_session_entity_types method.
+              #   result = client.list_session_entity_types 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::CX::V3::SessionEntityType.
+              #     p response
+              #   end
+              #
               def list_session_entity_types request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -206,9 +227,11 @@ module Google
                   gapic_version: ::Google::Cloud::Dialogflow::CX::V3::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
 
@@ -264,6 +287,21 @@ module Google
               #
               # @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::SessionEntityTypes::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::GetSessionEntityTypeRequest.new
+              #
+              #   # Call the get_session_entity_type method.
+              #   result = client.get_session_entity_type request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::SessionEntityType.
+              #   p result
+              #
               def get_session_entity_type request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -281,9 +319,11 @@ module Google
                   gapic_version: ::Google::Cloud::Dialogflow::CX::V3::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
 
@@ -339,6 +379,21 @@ module Google
               #
               # @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::SessionEntityTypes::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::CreateSessionEntityTypeRequest.new
+              #
+              #   # Call the create_session_entity_type method.
+              #   result = client.create_session_entity_type request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::SessionEntityType.
+              #   p result
+              #
               def create_session_entity_type request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -356,9 +411,11 @@ module Google
                   gapic_version: ::Google::Cloud::Dialogflow::CX::V3::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
 
@@ -415,6 +472,21 @@ module Google
               #
               # @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::SessionEntityTypes::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::UpdateSessionEntityTypeRequest.new
+              #
+              #   # Call the update_session_entity_type method.
+              #   result = client.update_session_entity_type request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::SessionEntityType.
+              #   p result
+              #
               def update_session_entity_type request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -432,9 +504,11 @@ module Google
                   gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
                 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-                header_params = {
-                  "session_entity_type.name" => request.session_entity_type.name
-                }
+                header_params = {}
+                if request.session_entity_type&.name
+                  header_params["session_entity_type.name"] = request.session_entity_type.name
+                end
+
                 request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
                 metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -489,6 +563,21 @@ module Google
               #
               # @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::SessionEntityTypes::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Dialogflow::CX::V3::DeleteSessionEntityTypeRequest.new
+              #
+              #   # Call the delete_session_entity_type method.
+              #   result = client.delete_session_entity_type request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def delete_session_entity_type request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -506,9 +595,11 @@ module Google
                   gapic_version: ::Google::Cloud::Dialogflow::CX::V3::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
 

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

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/dialogflow/cx/v3/session.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
@@ -18,6 +16,8 @@ require 'google/protobuf/struct_pb'
 require 'google/rpc/status_pb'
 require 'google/type/latlng_pb'
 require 'google/api/client_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/dialogflow/cx/v3/session.proto", :syntax => :proto3) do
     add_message "google.cloud.dialogflow.cx.v3.DetectIntentRequest" do
@@ -106,6 +106,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
         optional :trigger_intent, :string, 11
         optional :transcript, :string, 12
         optional :trigger_event, :string, 14
+        optional :dtmf, :message, 23, "google.cloud.dialogflow.cx.v3.DtmfInput"
       end
     end
     add_message "google.cloud.dialogflow.cx.v3.TextInput" do

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

@@ -30,7 +30,7 @@ module Google
             # user intent and respond.
             class Service
 
-              include GRPC::GenericService
+              include ::GRPC::GenericService
 
               self.marshal_class_method = :encode
               self.unmarshal_class_method = :decode

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

@@ -216,6 +216,21 @@ module Google
               #
               # @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::DetectIntentRequest.new
+              #
+              #   # Call the detect_intent method.
+              #   result = client.detect_intent request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::DetectIntentResponse.
+              #   p result
+              #
               def detect_intent request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -233,9 +248,11 @@ module Google
                   gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
                 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-                header_params = {
-                  "session" => request.session
-                }
+                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
 
@@ -277,6 +294,30 @@ module Google
               #
               # @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 an input stream
+              #   input = Gapic::StreamInput.new
+              #
+              #   # Call the streaming_detect_intent method to start streaming.
+              #   output = client.streaming_detect_intent input
+              #
+              #   # Send requests on the stream. For each request, pass in keyword
+              #   # arguments to set fields. Be sure to close the stream when done.
+              #   input << Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest.new
+              #   input << Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentRequest.new
+              #   input.close
+              #
+              #   # Handle streamed responses. These may be interleaved with inputs.
+              #   # Each response is of type ::Google::Cloud::Dialogflow::CX::V3::StreamingDetectIntentResponse.
+              #   output.each do |response|
+              #     p response
+              #   end
+              #
               def streaming_detect_intent request, options = nil
                 unless request.is_a? ::Enumerable
                   raise ::ArgumentError, "request must be an Enumerable" unless request.respond_to? :to_enum
@@ -360,6 +401,21 @@ module Google
               #
               # @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::MatchIntentRequest.new
+              #
+              #   # Call the match_intent method.
+              #   result = client.match_intent request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::MatchIntentResponse.
+              #   p result
+              #
               def match_intent request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -377,9 +433,11 @@ module Google
                   gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
                 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-                header_params = {
-                  "session" => request.session
-                }
+                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
 
@@ -435,6 +493,21 @@ module Google
               #
               # @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::FulfillIntentRequest.new
+              #
+              #   # Call the fulfill_intent method.
+              #   result = client.fulfill_intent request
+              #
+              #   # The returned object is of type Google::Cloud::Dialogflow::CX::V3::FulfillIntentResponse.
+              #   p result
+              #
               def fulfill_intent request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -452,9 +525,11 @@ module Google
                   gapic_version: ::Google::Cloud::Dialogflow::CX::V3::VERSION
                 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-                header_params = {
-                  "match_intent_request.session" => request.match_intent_request.session
-                }
+                header_params = {}
+                if request.match_intent_request&.session
+                  header_params["match_intent_request.session"] = request.match_intent_request.session
+                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/cx/v3/test_case_pb.rb

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/dialogflow/cx/v3/test_case.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
@@ -19,6 +17,8 @@ require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/struct_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/rpc/status_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/dialogflow/cx/v3/test_case.proto", :syntax => :proto3) do
     add_message "google.cloud.dialogflow.cx.v3.TestCase" do

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

@@ -29,7 +29,7 @@ module Google
             # [Test Case Results][google.cloud.dialogflow.cx.v3.TestCaseResult].
             class Service
 
-              include GRPC::GenericService
+              include ::GRPC::GenericService
 
               self.marshal_class_method = :encode
               self.unmarshal_class_method = :decode
@@ -46,6 +46,7 @@ module Google
               # Updates the specified test case.
               rpc :UpdateTestCase, ::Google::Cloud::Dialogflow::CX::V3::UpdateTestCaseRequest, ::Google::Cloud::Dialogflow::CX::V3::TestCase
               # Kicks off a test case run.
+              #
               # This method is a [long-running
               # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
               # The returned `Operation` type has the following method-specific fields:
@@ -54,15 +55,36 @@ module Google
               # - `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3.RunTestCaseResponse]
               rpc :RunTestCase, ::Google::Cloud::Dialogflow::CX::V3::RunTestCaseRequest, ::Google::Longrunning::Operation
               # Kicks off a batch run of test cases.
+              #
+              # This method is a [long-running
+              # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
+              # The returned `Operation` type has the following method-specific fields:
+              #
+              # - `metadata`: [BatchRunTestCasesMetadata][google.cloud.dialogflow.cx.v3.BatchRunTestCasesMetadata]
+              # - `response`: [BatchRunTestCasesResponse][google.cloud.dialogflow.cx.v3.BatchRunTestCasesResponse]
               rpc :BatchRunTestCases, ::Google::Cloud::Dialogflow::CX::V3::BatchRunTestCasesRequest, ::Google::Longrunning::Operation
               # Calculates the test coverage for an agent.
               rpc :CalculateCoverage, ::Google::Cloud::Dialogflow::CX::V3::CalculateCoverageRequest, ::Google::Cloud::Dialogflow::CX::V3::CalculateCoverageResponse
               # Imports the test cases from a Cloud Storage bucket or a local file. It
               # always creates new test cases and won't overwite any existing ones. The
               # provided ID in the imported test case is neglected.
+              #
+              # This method is a [long-running
+              # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
+              # The returned `Operation` type has the following method-specific fields:
+              #
+              # - `metadata`: [ImportTestCasesMetadata][google.cloud.dialogflow.cx.v3.ImportTestCasesMetadata]
+              # - `response`: [ImportTestCasesResponse][google.cloud.dialogflow.cx.v3.ImportTestCasesResponse]
               rpc :ImportTestCases, ::Google::Cloud::Dialogflow::CX::V3::ImportTestCasesRequest, ::Google::Longrunning::Operation
               # Exports the test cases under the agent to a Cloud Storage bucket or a local
               # file. Filter can be applied to export a subset of test cases.
+              #
+              # This method is a [long-running
+              # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
+              # The returned `Operation` type has the following method-specific fields:
+              #
+              # - `metadata`: [ExportTestCasesMetadata][google.cloud.dialogflow.cx.v3.ExportTestCasesMetadata]
+              # - `response`: [ExportTestCasesResponse][google.cloud.dialogflow.cx.v3.ExportTestCasesResponse]
               rpc :ExportTestCases, ::Google::Cloud::Dialogflow::CX::V3::ExportTestCasesRequest, ::Google::Longrunning::Operation
               # Fetches a list of results for a given test case.
               rpc :ListTestCaseResults, ::Google::Cloud::Dialogflow::CX::V3::ListTestCaseResultsRequest, ::Google::Cloud::Dialogflow::CX::V3::ListTestCaseResultsResponse