google-cloud-dialogflow-v2 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16982e0d34ab2e7c8c220e4b5c7767ba03c6826d174df1d524468dd0c249d896
-  data.tar.gz: 9f84552bd02b904418eadb825a813bd94526b9a79690231f76c4eea89ddb8d3b
+  metadata.gz: e7b82709afedacbe0f56ca44aa0672e496501f7f577724b4ecd6f254935712ae
+  data.tar.gz: d2fb17fecc2e54e01e3ab7c0ddc39e298ce4597f088c66e894fec5432230f48b
 SHA512:
-  metadata.gz: 5c1d4aa92c742a29c9ddfd2bd48030487f7d64d38cdd9c7ce8446ec2d6f44ff16c5a4dfe8b4f2cbd41b5750a5bf4bcb2efb9ca489d482ed970c8dc395a56f2b9
-  data.tar.gz: a44f049e7a9e74c22f112a7b1d2e629fba8828e12be5bbd0f6c303b9bc7b004048feef6f6993dcf21de5303d4f854c20d5e25148ab61db5e72c16a01db5716dd
+  metadata.gz: bf6ae2afc93029fdc525c22c5ef785880c2493bfff9edce2370b65a4d6bb8f9ca6043f14006da9a7b35ebf95b8dfca510778eebdf91edef7143745aa1d6e2e2c
+  data.tar.gz: e5227e577dc00c5945c161278e54b09ee8895206bb8abd4b4e8d18afed3a52a9fd37edfae9067b0e7757d2d19f58bfeb172ba0d1dac74474baef3396bb412767

data/README.md

@@ -1,4 +1,4 @@
-# Dialogflow V2
+# Ruby Client for the Dialogflow V2 API
 
 API Client library for the Dialogflow V2 API
 
@@ -12,6 +12,53 @@ https://github.com/googleapis/google-cloud-ruby
 $ gem install google-cloud-dialogflow-v2
 ```
 
+## Before You Begin
+
+In order to use this library, you first need to go through the following steps:
+
+1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+1. {file:AUTHENTICATION.md Set up authentication.}
+
+## Quick Start
+
+```ruby
+require "google/cloud/dialogflow/v2"
+
+client = Google::Cloud::Dialogflow::V2::Agents::Client.new
+request = my_create_request
+response = client.get_agent request
+```
+
+View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-dialogflow-v2/latest)
+for class and method documentation.
+
+## Enabling Logging
+
+To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
+The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
+or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
+that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
+and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
+
+Configuring a Ruby stdlib logger:
+
+```ruby
+require "logger"
+
+module MyLogger
+  LOGGER = Logger.new $stderr, level: Logger::WARN
+  def logger
+    LOGGER
+  end
+end
+
+# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+module GRPC
+  extend MyLogger
+end
+```
+
 ## Supported Ruby Versions
 
 This library is supported on Ruby 2.4+.

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

@@ -1 +1,21 @@
-require "google/cloud/dialogflow/v2/version"
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+# This gem does not autoload during Bundler.require. To load this gem,
+# issue explicit require statements for the packages desired, e.g.:
+# require "google/cloud/dialogflow/v2"

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

@@ -22,3 +22,19 @@ require "google/cloud/dialogflow/v2/entity_types"
 require "google/cloud/dialogflow/v2/intents"
 require "google/cloud/dialogflow/v2/session_entity_types"
 require "google/cloud/dialogflow/v2/sessions"
+require "google/cloud/dialogflow/v2/version"
+
+module Google
+  module Cloud
+    module Dialogflow
+      ##
+      # To load this package, including all its services, and instantiate a client:
+      #
+      #     require "google/cloud/dialogflow/v2"
+      #     client = Google::Cloud::Dialogflow::V2::Agents::Client.new
+      #
+      module V2
+      end
+    end
+  end
+end

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

@@ -16,6 +16,62 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
-require "google/cloud/dialogflow/v2/agents/client"
-require "google/cloud/dialogflow/v2/agents/operations"
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/dialogflow/v2/version"
+
 require "google/cloud/dialogflow/v2/agents/credentials"
+require "google/cloud/dialogflow/v2/agents/paths"
+require "google/cloud/dialogflow/v2/agents/operations"
+require "google/cloud/dialogflow/v2/agents/client"
+
+module Google
+  module Cloud
+    module Dialogflow
+      module V2
+        ##
+        # Agents are best described as Natural Language Understanding (NLU) modules
+        # that transform user requests into actionable data. You can include agents
+        # in your app, product, or service to determine user intent and respond to the
+        # user in a natural way.
+        #
+        # After you create an agent, you can add {Google::Cloud::Dialogflow::V2::Intents::Client Intents}, {Google::Cloud::Dialogflow::V2::Contexts::Client Contexts},
+        # [Entity Types][google.cloud.dialogflow.v2.EntityTypes], {Google::Cloud::Dialogflow::V2::WebhookRequest Webhooks}, and so on to
+        # manage the flow of a conversation and match user input to predefined intents
+        # and actions.
+        #
+        # You can create an agent using both Dialogflow Standard Edition and
+        # Dialogflow Enterprise Edition. For details, see
+        # [Dialogflow
+        # Editions](https://cloud.google.com/dialogflow/docs/editions).
+        #
+        # You can save your agent for backup or versioning by exporting the agent by
+        # using the {Google::Cloud::Dialogflow::V2::Agents::Client#export_agent ExportAgent} method. You can import a saved
+        # agent by using the {Google::Cloud::Dialogflow::V2::Agents::Client#import_agent ImportAgent} method.
+        #
+        # Dialogflow provides several
+        # [prebuilt
+        # agents](https://cloud.google.com/dialogflow/docs/agents-prebuilt)
+        # for common conversation scenarios such as determining a date and time,
+        # converting currency, and so on.
+        #
+        # For more information about agents, see the
+        # [Dialogflow
+        # documentation](https://cloud.google.com/dialogflow/docs/agents-overview).
+        #
+        # To load this service and instantiate a client:
+        #
+        #     require "google/cloud/dialogflow/v2/agents"
+        #     client = Google::Cloud::Dialogflow::V2::Agents::Client.new
+        #
+        module Agents
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "agents", "helpers.rb"
+require "google/cloud/dialogflow/v2/agents/helpers" if ::File.file? helper_path

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

@@ -16,16 +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/agent_pb"
-require "google/cloud/dialogflow/v2/agents/credentials"
-require "google/cloud/dialogflow/v2/agents/paths"
-require "google/cloud/dialogflow/v2/agents/operations"
 
 module Google
   module Cloud
@@ -244,17 +236,24 @@ module Google
             # Retrieves the specified agent.
             #
             # @overload get_agent(request, options = nil)
-            #   @param request [Google::Cloud::Dialogflow::V2::GetAgentRequest | Hash]
-            #     Retrieves the specified agent.
+            #   Pass arguments to `get_agent` via a request object, either of type
+            #   {Google::Cloud::Dialogflow::V2::GetAgentRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Cloud::Dialogflow::V2::GetAgentRequest, 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_agent(parent: nil)
+            #   Pass arguments to `get_agent` 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 project that the agent to fetch is associated with.
             #     Format: `projects/<Project ID>`.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Cloud::Dialogflow::V2::Agent]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -304,18 +303,25 @@ module Google
             # Creates/updates the specified agent.
             #
             # @overload set_agent(request, options = nil)
-            #   @param request [Google::Cloud::Dialogflow::V2::SetAgentRequest | Hash]
-            #     Creates/updates the specified agent.
+            #   Pass arguments to `set_agent` via a request object, either of type
+            #   {Google::Cloud::Dialogflow::V2::SetAgentRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Cloud::Dialogflow::V2::SetAgentRequest, 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 set_agent(agent: nil, update_mask: nil)
-            #   @param agent [Google::Cloud::Dialogflow::V2::Agent | Hash]
+            #   Pass arguments to `set_agent` 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 agent [Google::Cloud::Dialogflow::V2::Agent, Hash]
             #     Required. The agent 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::Agent]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -365,17 +371,24 @@ module Google
             # Deletes the specified agent.
             #
             # @overload delete_agent(request, options = nil)
-            #   @param request [Google::Cloud::Dialogflow::V2::DeleteAgentRequest | Hash]
-            #     Deletes the specified agent.
+            #   Pass arguments to `delete_agent` via a request object, either of type
+            #   {Google::Cloud::Dialogflow::V2::DeleteAgentRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Cloud::Dialogflow::V2::DeleteAgentRequest, 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_agent(parent: nil)
+            #   Pass arguments to `delete_agent` 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 project that the agent to delete is associated with.
             #     Format: `projects/<Project ID>`.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Protobuf::Empty]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -431,18 +444,20 @@ module Google
             # Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).
             #
             # @overload search_agents(request, options = nil)
-            #   @param request [Google::Cloud::Dialogflow::V2::SearchAgentsRequest | Hash]
-            #     Returns the list of agents.
-            #
-            #     Since there is at most one conversational agent per project, this method is
-            #     useful primarily for listing all agents across projects the caller has
-            #     access to. One can achieve that with a wildcard project collection id "-".
-            #     Refer to [List
-            #     Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).
+            #   Pass arguments to `search_agents` via a request object, either of type
+            #   {Google::Cloud::Dialogflow::V2::SearchAgentsRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Cloud::Dialogflow::V2::SearchAgentsRequest, 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 search_agents(parent: nil, page_size: nil, page_token: nil)
+            #   Pass arguments to `search_agents` 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 project to list agents from.
             #     Format: `projects/<Project ID or '-'>`.
@@ -452,7 +467,6 @@ module Google
             #   @param page_token [String]
             #     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::Agent>]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -505,19 +519,24 @@ module Google
             # Operation <response: {Google::Protobuf::Empty google.protobuf.Empty}>
             #
             # @overload train_agent(request, options = nil)
-            #   @param request [Google::Cloud::Dialogflow::V2::TrainAgentRequest | Hash]
-            #     Trains the specified agent.
+            #   Pass arguments to `train_agent` via a request object, either of type
+            #   {Google::Cloud::Dialogflow::V2::TrainAgentRequest} or an equivalent Hash.
             #
-            #     Operation <response: {Google::Protobuf::Empty google.protobuf.Empty}>
+            #   @param request [Google::Cloud::Dialogflow::V2::TrainAgentRequest, 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 train_agent(parent: nil)
+            #   Pass arguments to `train_agent` 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 project that the agent to train is associated with.
             #     Format: `projects/<Project ID>`.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Gapic::Operation]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -570,14 +589,20 @@ module Google
             # Operation <response: {Google::Cloud::Dialogflow::V2::ExportAgentResponse ExportAgentResponse}>
             #
             # @overload export_agent(request, options = nil)
-            #   @param request [Google::Cloud::Dialogflow::V2::ExportAgentRequest | Hash]
-            #     Exports the specified agent to a ZIP file.
+            #   Pass arguments to `export_agent` via a request object, either of type
+            #   {Google::Cloud::Dialogflow::V2::ExportAgentRequest} or an equivalent Hash.
             #
-            #     Operation <response: {Google::Cloud::Dialogflow::V2::ExportAgentResponse ExportAgentResponse}>
+            #   @param request [Google::Cloud::Dialogflow::V2::ExportAgentRequest, 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 export_agent(parent: nil, agent_uri: nil)
+            #   Pass arguments to `export_agent` 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 project that the agent to export is associated with.
             #     Format: `projects/<Project ID>`.
@@ -587,7 +612,6 @@ module Google
             #     The format of this URI must be `gs://<bucket-name>/<object-name>`.
             #     If left unspecified, the serialized agent is returned inline.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Gapic::Operation]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -644,18 +668,20 @@ module Google
             # Operation <response: {Google::Protobuf::Empty google.protobuf.Empty}>
             #
             # @overload import_agent(request, options = nil)
-            #   @param request [Google::Cloud::Dialogflow::V2::ImportAgentRequest | Hash]
-            #     Imports the specified agent from a ZIP file.
+            #   Pass arguments to `import_agent` via a request object, either of type
+            #   {Google::Cloud::Dialogflow::V2::ImportAgentRequest} or an equivalent Hash.
             #
-            #     Uploads new intents and entity types without deleting the existing ones.
-            #     Intents and entity types with the same name are replaced with the new
-            #     versions from ImportAgentRequest.
-            #
-            #     Operation <response: {Google::Protobuf::Empty google.protobuf.Empty}>
+            #   @param request [Google::Cloud::Dialogflow::V2::ImportAgentRequest, 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 import_agent(parent: nil, agent_uri: nil, agent_content: nil)
+            #   Pass arguments to `import_agent` 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 project that the agent to import is associated with.
             #     Format: `projects/<Project ID>`.
@@ -665,7 +691,6 @@ module Google
             #   @param agent_content [String]
             #     Zip compressed raw byte content for agent.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Gapic::Operation]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -721,17 +746,20 @@ module Google
             # Operation <response: {Google::Protobuf::Empty google.protobuf.Empty}>
             #
             # @overload restore_agent(request, options = nil)
-            #   @param request [Google::Cloud::Dialogflow::V2::RestoreAgentRequest | Hash]
-            #     Restores the specified agent from a ZIP file.
-            #
-            #     Replaces the current agent version with a new one. All the intents and
-            #     entity types in the older version are deleted.
+            #   Pass arguments to `restore_agent` via a request object, either of type
+            #   {Google::Cloud::Dialogflow::V2::RestoreAgentRequest} or an equivalent Hash.
             #
-            #     Operation <response: {Google::Protobuf::Empty google.protobuf.Empty}>
+            #   @param request [Google::Cloud::Dialogflow::V2::RestoreAgentRequest, 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 restore_agent(parent: nil, agent_uri: nil, agent_content: nil)
+            #   Pass arguments to `restore_agent` 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 project that the agent to restore is associated with.
             #     Format: `projects/<Project ID>`.
@@ -741,7 +769,6 @@ module Google
             #   @param agent_content [String]
             #     Zip compressed raw byte content for agent.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Gapic::Operation]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -793,13 +820,20 @@ module Google
             # training time and is updated automatically when training is completed.
             #
             # @overload get_validation_result(request, options = nil)
-            #   @param request [Google::Cloud::Dialogflow::V2::GetValidationResultRequest | Hash]
-            #     Gets agent validation result. Agent validation is performed during
-            #     training time and is updated automatically when training is completed.
+            #   Pass arguments to `get_validation_result` via a request object, either of type
+            #   {Google::Cloud::Dialogflow::V2::GetValidationResultRequest} or an equivalent Hash.
+            #
+            #   @param request [Google::Cloud::Dialogflow::V2::GetValidationResultRequest, 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_validation_result(parent: nil, language_code: nil)
+            #   Pass arguments to `get_validation_result` 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 project that the agent is associated with.
             #     Format: `projects/<Project ID>`.
@@ -810,7 +844,6 @@ module Google
             #     are supported. Note: languages must be enabled in the agent before they can
             #     be used.
             #
-            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [Google::Cloud::Dialogflow::V2::ValidationResult]
             # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1065,13 +1098,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/agents/helpers"
-rescue LoadError
-end
-
-# rubocop:enable Lint/HandleExceptions