google-cloud-dialogflow-v2 0.7.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49ab6f480968323b74e5195b650fa3e2dacb078e43489f0475ed4aae9e65e1b3
-  data.tar.gz: 3e469288e32fd1018c276885698c838b04ef00a486ce0a244d6644118fe7082e
+  metadata.gz: c023c07476d29e91e2b3f6e943f5e6a0deecdea280e661fe0c469ce4cfe0cac4
+  data.tar.gz: 77d7d8f0136cec992efc97f5f228501bd1a7343010caa7285b09ae1e04245e88
 SHA512:
-  metadata.gz: f07cf9441031ad758e1d6e91bd3e4d113710955cec19d59c6e81dc381a7139fae74896b5d41b48d3583143ac96a090c863017809432cdefae9f9b03b7837a4a9
-  data.tar.gz: 67f1b620e5cff9fae14c649d11f735fd98e2638821b8363f99ddaa7458a0b94c0d0a9e10ac9ce2396f33eaf43ff9767242211c4a78c2d243b5f09260d9b309bd
+  metadata.gz: 6e23ef0fdbc073fff3d268e9e16cb43583efeb8e62612187f30fd54ec9d7551cff324478535842c6d2995fe422773651bbe57da5612fe73ec38ca9013b3f78b9
+  data.tar.gz: 6837388b581f23b0049114ed4667500050a770e177fd2eef4bc029f011e2ce0d15fd63e2f2b67edd075e7bc18a25e4d4d0b529cba75fe303689b44ef620303c0

data/AUTHENTICATION.md

@@ -66,11 +66,11 @@ The environment variables that google-cloud-dialogflow-v2
 checks for credentials are configured on the service Credentials class (such as
 {::Google::Cloud::Dialogflow::V2::Agents::Credentials}):
 
-1. `DIALOGFLOW_CREDENTIALS` - Path to JSON file, or JSON contents
-2. `DIALOGFLOW_KEYFILE` - Path to JSON file, or JSON contents
-3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
-4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
-5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+* `DIALOGFLOW_CREDENTIALS` - Path to JSON file, or JSON contents
+* `DIALOGFLOW_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
 
 ```ruby
 require "google/cloud/dialogflow/v2"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::Dialogflow::V2::Agents::Client.new
 
 ### Configuration
 
-The **Credentials JSON** can be configured instead of placing them in
-environment variables. Either on an individual client initialization:
+The path to the **Credentials JSON** file can be configured instead of storing
+it in an environment variable. Either on an individual client initialization:
 
 ```ruby
 require "google/cloud/dialogflow/v2"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::Dialogflow::V2::Agents::Client.new do |config|
 end
 ```
 
-Or configured globally for all clients:
+Or globally for all clients:
 
 ```ruby
 require "google/cloud/dialogflow/v2"

data/README.md

@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
 require "google/cloud/dialogflow/v2"
 
 client = ::Google::Cloud::Dialogflow::V2::Agents::Client.new
-request = my_create_request
+request = ::Google::Cloud::Dialogflow::V2::GetAgentRequest.new # (request fields as keyword arguments...)
 response = client.get_agent request
 ```
 

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

@@ -27,8 +27,10 @@ require "google/cloud/dialogflow/v2/answer_records"
 require "google/cloud/dialogflow/v2/conversations"
 require "google/cloud/dialogflow/v2/conversation_profiles"
 require "google/cloud/dialogflow/v2/documents"
+require "google/cloud/dialogflow/v2/fulfillments"
 require "google/cloud/dialogflow/v2/environments"
 require "google/cloud/dialogflow/v2/knowledge_bases"
+require "google/cloud/dialogflow/v2/versions"
 require "google/cloud/dialogflow/v2/version"
 
 module Google

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

@@ -36,6 +36,10 @@ module Google
             # Retrieves the specified agent.
             rpc :GetAgent, ::Google::Cloud::Dialogflow::V2::GetAgentRequest, ::Google::Cloud::Dialogflow::V2::Agent
             # Creates/updates the specified agent.
+            #
+            # Note: You should always train an agent prior to sending it queries. See the
+            # [training
+            # documentation](https://cloud.google.com/dialogflow/es/docs/training).
             rpc :SetAgent, ::Google::Cloud::Dialogflow::V2::SetAgentRequest, ::Google::Cloud::Dialogflow::V2::Agent
             # Deletes the specified agent.
             rpc :DeleteAgent, ::Google::Cloud::Dialogflow::V2::DeleteAgentRequest, ::Google::Protobuf::Empty
@@ -49,11 +53,12 @@ module Google
             rpc :SearchAgents, ::Google::Cloud::Dialogflow::V2::SearchAgentsRequest, ::Google::Cloud::Dialogflow::V2::SearchAgentsResponse
             # Trains the specified agent.
             #
-            # Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>
+            #
+            # Note: You should always train an agent prior to sending it queries. See the
+            # [training
+            # documentation](https://cloud.google.com/dialogflow/es/docs/training).
             rpc :TrainAgent, ::Google::Cloud::Dialogflow::V2::TrainAgentRequest, ::Google::Longrunning::Operation
             # Exports the specified agent to a ZIP file.
-            #
-            # Operation <response: [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]>
             rpc :ExportAgent, ::Google::Cloud::Dialogflow::V2::ExportAgentRequest, ::Google::Longrunning::Operation
             # Imports the specified agent from a ZIP file.
             #
@@ -65,9 +70,12 @@ module Google
             # call [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it returns in order to train
             # explicitly.
             #
-            # Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>
             # An operation which tracks when importing is complete. It only tracks
             # when the draft agent is updated not when it is done training.
+            #
+            # Note: You should always train an agent prior to sending it queries. See the
+            # [training
+            # documentation](https://cloud.google.com/dialogflow/es/docs/training).
             rpc :ImportAgent, ::Google::Cloud::Dialogflow::V2::ImportAgentRequest, ::Google::Longrunning::Operation
             # Restores the specified agent from a ZIP file.
             #
@@ -78,9 +86,12 @@ module Google
             # completed yet. Please call [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
             # returns in order to train explicitly.
             #
-            # Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>
             # An operation which tracks when restoring is complete. It only tracks
             # when the draft agent is updated not when it is done training.
+            #
+            # Note: You should always train an agent prior to sending it queries. See the
+            # [training
+            # documentation](https://cloud.google.com/dialogflow/es/docs/training).
             rpc :RestoreAgent, ::Google::Cloud::Dialogflow::V2::RestoreAgentRequest, ::Google::Longrunning::Operation
             # Gets agent validation result. Agent validation is performed during
             # training time and is updated automatically when training is completed.

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

@@ -67,10 +67,7 @@ module Google
 
                 default_config.timeout = 60.0
                 default_config.retry_policy = {
-                  initial_delay: 0.1,
-                max_delay: 60.0,
-                multiplier: 1.3,
-                retry_codes: [14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
                 }
 
                 default_config
@@ -141,7 +138,7 @@ module Google
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -240,6 +237,10 @@ module Google
             ##
             # Creates/updates the specified agent.
             #
+            # Note: You should always train an agent prior to sending it queries. See the
+            # [training
+            # documentation](https://cloud.google.com/dialogflow/es/docs/training).
+            #
             # @overload set_agent(request, options = nil)
             #   Pass arguments to `set_agent` via a request object, either of type
             #   {::Google::Cloud::Dialogflow::V2::SetAgentRequest} or an equivalent Hash.
@@ -454,7 +455,10 @@ module Google
             ##
             # Trains the specified agent.
             #
-            # Operation <response: {::Google::Protobuf::Empty google.protobuf.Empty}>
+            #
+            # Note: You should always train an agent prior to sending it queries. See the
+            # [training
+            # documentation](https://cloud.google.com/dialogflow/es/docs/training).
             #
             # @overload train_agent(request, options = nil)
             #   Pass arguments to `train_agent` via a request object, either of type
@@ -524,8 +528,6 @@ module Google
             ##
             # Exports the specified agent to a ZIP file.
             #
-            # Operation <response: {::Google::Cloud::Dialogflow::V2::ExportAgentResponse ExportAgentResponse}>
-            #
             # @overload export_agent(request, options = nil)
             #   Pass arguments to `export_agent` via a request object, either of type
             #   {::Google::Cloud::Dialogflow::V2::ExportAgentRequest} or an equivalent Hash.
@@ -607,10 +609,13 @@ module Google
             # call {::Google::Cloud::Dialogflow::V2::Agents::Client#train_agent TrainAgent} and wait for the operation it returns in order to train
             # explicitly.
             #
-            # Operation <response: {::Google::Protobuf::Empty google.protobuf.Empty}>
             # An operation which tracks when importing is complete. It only tracks
             # when the draft agent is updated not when it is done training.
             #
+            # Note: You should always train an agent prior to sending it queries. See the
+            # [training
+            # documentation](https://cloud.google.com/dialogflow/es/docs/training).
+            #
             # @overload import_agent(request, options = nil)
             #   Pass arguments to `import_agent` via a request object, either of type
             #   {::Google::Cloud::Dialogflow::V2::ImportAgentRequest} or an equivalent Hash.
@@ -691,10 +696,13 @@ module Google
             # completed yet. Please call {::Google::Cloud::Dialogflow::V2::Agents::Client#train_agent TrainAgent} and wait for the operation it
             # returns in order to train explicitly.
             #
-            # Operation <response: {::Google::Protobuf::Empty google.protobuf.Empty}>
             # An operation which tracks when restoring is complete. It only tracks
             # when the draft agent is updated not when it is done training.
             #
+            # Note: You should always train an agent prior to sending it queries. See the
+            # [training
+            # documentation](https://cloud.google.com/dialogflow/es/docs/training).
+            #
             # @overload restore_agent(request, options = nil)
             #   Pass arguments to `restore_agent` via a request object, either of type
             #   {::Google::Cloud::Dialogflow::V2::RestoreAgentRequest} or an equivalent Hash.

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

@@ -82,7 +82,7 @@ module Google
               # Create credentials
               credentials = @config.credentials
               credentials ||= Credentials.default scope: @config.scope
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -396,9 +396,9 @@ module Google
             end
 
             ##
-            # Waits for the specified long-running operation until it is done or reaches
-            # at most a specified timeout, returning the latest state.  If the operation
-            # is already done, the latest state is immediately returned.  If the timeout
+            # Waits until the specified long-running operation is done or reaches at most
+            # a specified timeout, returning the latest state.  If the operation is
+            # already done, the latest state is immediately returned.  If the timeout
             # specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
             # timeout is used.  If the server does not support this method, it returns
             # `google.rpc.Code.UNIMPLEMENTED`.

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

@@ -27,15 +27,54 @@ module Google
             ##
             # Create a fully-qualified Agent resource string.
             #
+            # @overload agent_path(project:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/agent`
+            #
+            #   @param project [String]
+            #
+            # @overload agent_path(project:, location:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/locations/{location}/agent`
+            #
+            #   @param project [String]
+            #   @param location [String]
+            #
+            # @return [::String]
+            def agent_path **args
+              resources = {
+                "project" => (proc do |project:|
+                  "projects/#{project}/agent"
+                end),
+                "location:project" => (proc do |project:, location:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+                  "projects/#{project}/locations/#{location}/agent"
+                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 Location resource string.
+            #
             # The resource will be in the following format:
             #
-            # `projects/{project}/agent`
+            # `projects/{project}/locations/{location}`
             #
             # @param project [String]
+            # @param location [String]
             #
             # @return [::String]
-            def agent_path project:
-              "projects/#{project}/agent"
+            def location_path project:, location:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}"
             end
 
             ##

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

@@ -24,8 +24,7 @@ module Google
     module Dialogflow
       module V2
         module AnswerRecords
-          # Service for managing
-          # [AnswerRecords][google.cloud.dialogflow.v2.AnswerRecord].
+          # Service for managing [AnswerRecords][google.cloud.dialogflow.v2.AnswerRecord].
           class Service
 
             include GRPC::GenericService

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

@@ -31,8 +31,7 @@ module Google
     module Dialogflow
       module V2
         ##
-        # Service for managing
-        # {::Google::Cloud::Dialogflow::V2::AnswerRecord AnswerRecords}.
+        # Service for managing {::Google::Cloud::Dialogflow::V2::AnswerRecord AnswerRecords}.
         #
         # To load this service and instantiate a client:
         #

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

@@ -27,8 +27,7 @@ module Google
           ##
           # Client for the AnswerRecords service.
           #
-          # Service for managing
-          # {::Google::Cloud::Dialogflow::V2::AnswerRecord AnswerRecords}.
+          # Service for managing {::Google::Cloud::Dialogflow::V2::AnswerRecord AnswerRecords}.
           #
           class Client
             include Paths
@@ -68,10 +67,7 @@ module Google
 
                 default_config.timeout = 60.0
                 default_config.retry_policy = {
-                  initial_delay: 0.1,
-                max_delay: 60.0,
-                multiplier: 1.3,
-                retry_codes: [14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
                 }
 
                 default_config
@@ -142,7 +138,7 @@ module Google
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project

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

@@ -67,10 +67,7 @@ module Google
 
                 default_config.timeout = 60.0
                 default_config.retry_policy = {
-                  initial_delay: 0.1,
-                max_delay: 60.0,
-                multiplier: 1.3,
-                retry_codes: [14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
                 }
 
                 default_config
@@ -141,7 +138,7 @@ module Google
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project

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

@@ -47,6 +47,28 @@ module Google
             #   @param session [String]
             #   @param context [String]
             #
+            # @overload context_path(project:, location:, session:, context:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/locations/{location}/agent/sessions/{session}/contexts/{context}`
+            #
+            #   @param project [String]
+            #   @param location [String]
+            #   @param session [String]
+            #   @param context [String]
+            #
+            # @overload context_path(project:, location:, environment:, user:, session:, context:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context}`
+            #
+            #   @param project [String]
+            #   @param location [String]
+            #   @param environment [String]
+            #   @param user [String]
+            #   @param session [String]
+            #   @param context [String]
+            #
             # @return [::String]
             def context_path **args
               resources = {
@@ -63,6 +85,22 @@ module Google
                   raise ::ArgumentError, "session cannot contain /" if session.to_s.include? "/"
 
                   "projects/#{project}/agent/environments/#{environment}/users/#{user}/sessions/#{session}/contexts/#{context}"
+                end),
+                "context:location:project:session" => (proc do |project:, location:, session:, context:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+                  raise ::ArgumentError, "session cannot contain /" if session.to_s.include? "/"
+
+                  "projects/#{project}/locations/#{location}/agent/sessions/#{session}/contexts/#{context}"
+                end),
+                "context:environment:location:project:session:user" => (proc do |project:, location:, environment:, user:, session:, context:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+                  raise ::ArgumentError, "environment cannot contain /" if environment.to_s.include? "/"
+                  raise ::ArgumentError, "user cannot contain /" if user.to_s.include? "/"
+                  raise ::ArgumentError, "session cannot contain /" if session.to_s.include? "/"
+
+                  "projects/#{project}/locations/#{location}/agent/environments/#{environment}/users/#{user}/sessions/#{session}/contexts/#{context}"
                 end)
               }
 
@@ -92,6 +130,26 @@ module Google
             #   @param user [String]
             #   @param session [String]
             #
+            # @overload session_path(project:, location:, session:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/locations/{location}/agent/sessions/{session}`
+            #
+            #   @param project [String]
+            #   @param location [String]
+            #   @param session [String]
+            #
+            # @overload session_path(project:, location:, environment:, user:, session:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}`
+            #
+            #   @param project [String]
+            #   @param location [String]
+            #   @param environment [String]
+            #   @param user [String]
+            #   @param session [String]
+            #
             # @return [::String]
             def session_path **args
               resources = {
@@ -106,6 +164,20 @@ module Google
                   raise ::ArgumentError, "user cannot contain /" if user.to_s.include? "/"
 
                   "projects/#{project}/agent/environments/#{environment}/users/#{user}/sessions/#{session}"
+                end),
+                "location:project:session" => (proc do |project:, location:, session:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+                  "projects/#{project}/locations/#{location}/agent/sessions/#{session}"
+                end),
+                "environment:location:project:session:user" => (proc do |project:, location:, environment:, user:, session:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.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}/locations/#{location}/agent/environments/#{environment}/users/#{user}/sessions/#{session}"
                 end)
               }