google-cloud-dialogflow-v2 0.3.0 → 0.4.0

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

@@ -24,6 +24,20 @@ module Google
         module Intents
           # Path helper methods for the Intents API.
           module Paths
+            ##
+            # Create a fully-qualified Agent resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/agent`
+            #
+            # @param project [String]
+            #
+            # @return [String]
+            def agent_path project:
+              "projects/#{project}/agent"
+            end
+
             ##
             # Create a fully-qualified Context resource string.
             #

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

@@ -16,5 +16,50 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-require "google/cloud/dialogflow/v2/session_entity_types/client"
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/dialogflow/v2/version"
+
 require "google/cloud/dialogflow/v2/session_entity_types/credentials"
+require "google/cloud/dialogflow/v2/session_entity_types/paths"
+require "google/cloud/dialogflow/v2/session_entity_types/client"
+
+module Google
+  module Cloud
+    module Dialogflow
+      module V2
+        ##
+        # Entities are extracted from user input and represent parameters that are
+        # meaningful to your application. For example, a date range, a proper name
+        # such as a geographic location or landmark, and so on. Entities represent
+        # actionable data for your application.
+        #
+        # Session entity types are referred to as **User** entity types and are
+        # entities that are built for an individual user such as
+        # favorites, preferences, playlists, and so on. You can redefine a session
+        # entity type at the session level.
+        #
+        # Session entity methods do not work with Google Assistant integration.
+        # Contact Dialogflow support if you need to use session entities
+        # with Google Assistant integration.
+        #
+        # For more information about entity types, see the
+        # [Dialogflow
+        # documentation](https://cloud.google.com/dialogflow/docs/entities-overview).
+        #
+        # To load this service and instantiate a client:
+        #
+        #     require "google/cloud/dialogflow/v2/session_entity_types"
+        #     client = Google::Cloud::Dialogflow::V2::SessionEntityTypes::Client.new
+        #
+        module SessionEntityTypes
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "session_entity_types", "helpers.rb"
+require "google/cloud/dialogflow/v2/session_entity_types/helpers" if ::File.file? helper_path

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

@@ -16,15 +16,8 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-require "gapic/common"
-require "gapic/config"
-require "gapic/config/method"
-
 require "google/cloud/errors"
-require "google/cloud/dialogflow/v2/version"
 require "google/cloud/dialogflow/v2/session_entity_type_pb"
-require "google/cloud/dialogflow/v2/session_entity_types/credentials"
-require "google/cloud/dialogflow/v2/session_entity_types/paths"
 
 module Google
   module Cloud
@@ -202,16 +195,20 @@ module Google
             # with Google Assistant integration.
             #
             # @overload list_session_entity_types(request, options = nil)
-            #   @param request [Google::Cloud::Dialogflow::V2::ListSessionEntityTypesRequest | Hash]
-            #     Returns the list of all session entity types in the specified session.
+            #   Pass arguments to `list_session_entity_types` via a request object, either of type
+            #   {Google::Cloud::Dialogflow::V2::ListSessionEntityTypesRequest} or an equivalent Hash.
             #
-            #     This method doesn't work with Google Assistant integration.
-            #     Contact Dialogflow support if you need to use session entities
-            #     with Google Assistant integration.
+            #   @param request [Google::Cloud::Dialogflow::V2::ListSessionEntityTypesRequest, 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 list_session_entity_types(parent: nil, page_size: nil, page_token: nil)
+            #   Pass arguments to `list_session_entity_types` 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 session to list all session entity types from.
             #     Format: `projects/<Project ID>/agent/sessions/<Session ID>` or
@@ -225,7 +222,6 @@ module Google
             #   @param page_token [String]
             #     Optional. The next_page_token value returned from a previous list request.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Gapic::PagedEnumerable<Google::Cloud::Dialogflow::V2::SessionEntityType>]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -280,16 +276,20 @@ module Google
             # with Google Assistant integration.
             #
             # @overload get_session_entity_type(request, options = nil)
-            #   @param request [Google::Cloud::Dialogflow::V2::GetSessionEntityTypeRequest | Hash]
-            #     Retrieves the specified session entity type.
+            #   Pass arguments to `get_session_entity_type` via a request object, either of type
+            #   {Google::Cloud::Dialogflow::V2::GetSessionEntityTypeRequest} or an equivalent Hash.
             #
-            #     This method doesn't work with Google Assistant integration.
-            #     Contact Dialogflow support if you need to use session entities
-            #     with Google Assistant integration.
+            #   @param request [Google::Cloud::Dialogflow::V2::GetSessionEntityTypeRequest, 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 get_session_entity_type(name: nil)
+            #   Pass arguments to `get_session_entity_type` 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 name [String]
             #     Required. The name of the session entity type. Format:
             #     `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
@@ -299,7 +299,6 @@ module Google
             #     If `Environment ID` is not specified, we assume default 'draft'
             #     environment. If `User ID` is not specified, we assume default '-' user.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Cloud::Dialogflow::V2::SessionEntityType]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -356,19 +355,20 @@ module Google
             # with Google Assistant integration.
             #
             # @overload create_session_entity_type(request, options = nil)
-            #   @param request [Google::Cloud::Dialogflow::V2::CreateSessionEntityTypeRequest | Hash]
-            #     Creates a session entity type.
-            #
-            #     If the specified session entity type already exists, overrides the session
-            #     entity type.
+            #   Pass arguments to `create_session_entity_type` via a request object, either of type
+            #   {Google::Cloud::Dialogflow::V2::CreateSessionEntityTypeRequest} or an equivalent Hash.
             #
-            #     This method doesn't work with Google Assistant integration.
-            #     Contact Dialogflow support if you need to use session entities
-            #     with Google Assistant integration.
+            #   @param request [Google::Cloud::Dialogflow::V2::CreateSessionEntityTypeRequest, 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 create_session_entity_type(parent: nil, session_entity_type: nil)
+            #   Pass arguments to `create_session_entity_type` 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 session to create a session entity type for.
             #     Format: `projects/<Project ID>/agent/sessions/<Session ID>` or
@@ -376,10 +376,9 @@ module Google
             #     sessions/<Session ID>`.
             #     If `Environment ID` is not specified, we assume default 'draft'
             #     environment. If `User ID` is not specified, we assume default '-' user.
-            #   @param session_entity_type [Google::Cloud::Dialogflow::V2::SessionEntityType | Hash]
+            #   @param session_entity_type [Google::Cloud::Dialogflow::V2::SessionEntityType, Hash]
             #     Required. The session entity type to create.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Cloud::Dialogflow::V2::SessionEntityType]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -433,22 +432,25 @@ module Google
             # with Google Assistant integration.
             #
             # @overload update_session_entity_type(request, options = nil)
-            #   @param request [Google::Cloud::Dialogflow::V2::UpdateSessionEntityTypeRequest | Hash]
-            #     Updates the specified session entity type.
+            #   Pass arguments to `update_session_entity_type` via a request object, either of type
+            #   {Google::Cloud::Dialogflow::V2::UpdateSessionEntityTypeRequest} or an equivalent Hash.
             #
-            #     This method doesn't work with Google Assistant integration.
-            #     Contact Dialogflow support if you need to use session entities
-            #     with Google Assistant integration.
+            #   @param request [Google::Cloud::Dialogflow::V2::UpdateSessionEntityTypeRequest, 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 update_session_entity_type(session_entity_type: nil, update_mask: nil)
-            #   @param session_entity_type [Google::Cloud::Dialogflow::V2::SessionEntityType | Hash]
+            #   Pass arguments to `update_session_entity_type` 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_entity_type [Google::Cloud::Dialogflow::V2::SessionEntityType, Hash]
             #     Required. The session entity type to update.
-            #   @param update_mask [Google::Protobuf::FieldMask | Hash]
+            #   @param update_mask [Google::Protobuf::FieldMask, Hash]
             #     Optional. The mask to control which fields get updated.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Cloud::Dialogflow::V2::SessionEntityType]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -502,16 +504,20 @@ module Google
             # with Google Assistant integration.
             #
             # @overload delete_session_entity_type(request, options = nil)
-            #   @param request [Google::Cloud::Dialogflow::V2::DeleteSessionEntityTypeRequest | Hash]
-            #     Deletes the specified session entity type.
+            #   Pass arguments to `delete_session_entity_type` via a request object, either of type
+            #   {Google::Cloud::Dialogflow::V2::DeleteSessionEntityTypeRequest} or an equivalent Hash.
             #
-            #     This method doesn't work with Google Assistant integration.
-            #     Contact Dialogflow support if you need to use session entities
-            #     with Google Assistant integration.
+            #   @param request [Google::Cloud::Dialogflow::V2::DeleteSessionEntityTypeRequest, 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 delete_session_entity_type(name: nil)
+            #   Pass arguments to `delete_session_entity_type` 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 name [String]
             #     Required. The name of the entity type to delete. Format:
             #     `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
@@ -521,7 +527,6 @@ module Google
             #     If `Environment ID` is not specified, we assume default 'draft'
             #     environment. If `User ID` is not specified, we assume default '-' user.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Protobuf::Empty]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -748,13 +753,3 @@ module Google
     end
   end
 end
-
-# rubocop:disable Lint/HandleExceptions
-
-# Once client is loaded, load helpers.rb if it exists.
-begin
-  require "google/cloud/dialogflow/v2/session_entity_types/helpers"
-rescue LoadError
-end
-
-# rubocop:enable Lint/HandleExceptions

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

@@ -24,6 +24,49 @@ module Google
         module SessionEntityTypes
           # Path helper methods for the SessionEntityTypes API.
           module Paths
+            ##
+            # Create a fully-qualified Session resource string.
+            #
+            # @overload session_path(project:, session:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/agent/sessions/{session}`
+            #
+            #   @param project [String]
+            #   @param session [String]
+            #
+            # @overload session_path(project:, environment:, user:, session:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}`
+            #
+            #   @param project [String]
+            #   @param environment [String]
+            #   @param user [String]
+            #   @param session [String]
+            #
+            # @return [String]
+            def session_path **args
+              resources = {
+                "project:session"                  => (proc do |project:, session:|
+                  raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+                  "projects/#{project}/agent/sessions/#{session}"
+                end),
+                "environment:project:session:user" => (proc do |project:, environment:, user:, session:|
+                  raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                  raise ArgumentError, "environment cannot contain /" if environment.to_s.include? "/"
+                  raise ArgumentError, "user cannot contain /" if user.to_s.include? "/"
+
+                  "projects/#{project}/agent/environments/#{environment}/users/#{user}/sessions/#{session}"
+                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 SessionEntityType resource string.
             #

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

@@ -16,5 +16,37 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-require "google/cloud/dialogflow/v2/sessions/client"
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/dialogflow/v2/version"
+
 require "google/cloud/dialogflow/v2/sessions/credentials"
+require "google/cloud/dialogflow/v2/sessions/paths"
+require "google/cloud/dialogflow/v2/sessions/client"
+
+module Google
+  module Cloud
+    module Dialogflow
+      module V2
+        ##
+        # A session represents an interaction with a user. You retrieve user input
+        # and pass it to the {Google::Cloud::Dialogflow::V2::Sessions::Client#detect_intent DetectIntent} (or
+        # {Google::Cloud::Dialogflow::V2::Sessions::Client#streaming_detect_intent StreamingDetectIntent}) method to determine
+        # user intent and respond.
+        #
+        # To load this service and instantiate a client:
+        #
+        #     require "google/cloud/dialogflow/v2/sessions"
+        #     client = Google::Cloud::Dialogflow::V2::Sessions::Client.new
+        #
+        module Sessions
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "sessions", "helpers.rb"
+require "google/cloud/dialogflow/v2/sessions/helpers" if ::File.file? helper_path

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

@@ -16,15 +16,8 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-require "gapic/common"
-require "gapic/config"
-require "gapic/config/method"
-
 require "google/cloud/errors"
-require "google/cloud/dialogflow/v2/version"
 require "google/cloud/dialogflow/v2/session_pb"
-require "google/cloud/dialogflow/v2/sessions/credentials"
-require "google/cloud/dialogflow/v2/sessions/paths"
 
 module Google
   module Cloud
@@ -164,15 +157,20 @@ module Google
             # results of future queries.
             #
             # @overload detect_intent(request, options = nil)
-            #   @param request [Google::Cloud::Dialogflow::V2::DetectIntentRequest | Hash]
-            #     Processes a natural language query and returns structured, actionable data
-            #     as a result. This method is not idempotent, because it may cause contexts
-            #     and session entity types to be updated, which in turn might affect
-            #     results of future queries.
+            #   Pass arguments to `detect_intent` via a request object, either of type
+            #   {Google::Cloud::Dialogflow::V2::DetectIntentRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Cloud::Dialogflow::V2::DetectIntentRequest, 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 detect_intent(session: nil, query_params: nil, query_input: nil, output_audio_config: nil, output_audio_config_mask: nil, input_audio: nil)
+            #   Pass arguments to `detect_intent` 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 this query is sent to. Format:
             #     `projects/<Project ID>/agent/sessions/<Session ID>`, or
@@ -183,9 +181,9 @@ module Google
             #     `User Id`. They can be a random number or some type of user and session
             #     identifiers (preferably hashed). The length of the `Session ID` and
             #     `User ID` must not exceed 36 characters.
-            #   @param query_params [Google::Cloud::Dialogflow::V2::QueryParameters | Hash]
+            #   @param query_params [Google::Cloud::Dialogflow::V2::QueryParameters, Hash]
             #     The parameters of this query.
-            #   @param query_input [Google::Cloud::Dialogflow::V2::QueryInput | Hash]
+            #   @param query_input [Google::Cloud::Dialogflow::V2::QueryInput, Hash]
             #     Required. The input specification. It can be set to:
             #
             #     1.  an audio config
@@ -194,11 +192,11 @@ module Google
             #     2.  a conversational query in the form of text, or
             #
             #     3.  an event that specifies which intent to trigger.
-            #   @param output_audio_config [Google::Cloud::Dialogflow::V2::OutputAudioConfig | Hash]
+            #   @param output_audio_config [Google::Cloud::Dialogflow::V2::OutputAudioConfig, Hash]
             #     Instructs the speech synthesizer how to generate the output
             #     audio. If this field is not set and agent-level speech synthesizer is not
             #     configured, no output audio is generated.
-            #   @param output_audio_config_mask [Google::Protobuf::FieldMask | Hash]
+            #   @param output_audio_config_mask [Google::Protobuf::FieldMask, Hash]
             #     Mask for {Google::Cloud::Dialogflow::V2::DetectIntentRequest#output_audio_config output_audio_config} indicating which settings in this
             #     request-level config should override speech synthesizer settings defined at
             #     agent-level.
@@ -210,7 +208,6 @@ module Google
             #     should be populated iff `query_input` is set to an input audio config.
             #     A single request can contain up to 1 minute of speech audio data.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Cloud::Dialogflow::V2::DetectIntentResponse]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -261,7 +258,7 @@ module Google
             # and returns structured, actionable data as a result. This method is only
             # available via the gRPC API (not REST).
             #
-            # @param request [Gapic::StreamInput, Enumerable<Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest | Hash>]
+            # @param request [Gapic::StreamInput, Enumerable<Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest, Hash>]
             #   An enumerable of {Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest} instances.
             # @param options [Gapic::CallOptions, Hash]
             #   Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@@ -470,13 +467,3 @@ module Google
     end
   end
 end
-
-# rubocop:disable Lint/HandleExceptions
-
-# Once client is loaded, load helpers.rb if it exists.
-begin
-  require "google/cloud/dialogflow/v2/sessions/helpers"
-rescue LoadError
-end
-
-# rubocop:enable Lint/HandleExceptions