google-cloud-dialogflow 0.2.3 → 0.3.0

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

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -46,19 +46,22 @@ module Google
         #
         # You can create an agent using both Dialogflow Standard Edition and
         # Dialogflow Enterprise Edition. For details, see
-        # [Dialogflow Editions](https://cloud.google.com/dialogflow-enterprise/docs/editions).
+        # [Dialogflow
+        # Editions](https://cloud.google.com/dialogflow-enterprise/docs/editions).
         #
         # You can save your agent for backup or versioning by exporting the agent by
         # using the {Google::Cloud::Dialogflow::V2::Agents::ExportAgent ExportAgent} method. You can import a saved
         # agent by using the {Google::Cloud::Dialogflow::V2::Agents::ImportAgent ImportAgent} method.
         #
         # Dialogflow provides several
-        # [prebuilt agents](https://dialogflow.com/docs/prebuilt-agents) for common
-        # conversation scenarios such as determining a date and time, converting
-        # currency, and so on.
+        # [prebuilt
+        # agents](https://cloud.google.com/dialogflow-enterprise/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://dialogflow.com/docs/agents).
+        # [Dialogflow
+        # documentation](https://cloud.google.com/dialogflow-enterprise/docs/agents-overview).
         #
         # @!attribute [r] agents_stub
         #   @return [Google::Cloud::Dialogflow::V2::Agents::Stub]
@@ -89,7 +92,8 @@ module Google
           # The scopes needed to make gRPC calls to all of the methods defined in
           # this service.
           ALL_SCOPES = [
-            "https://www.googleapis.com/auth/cloud-platform"
+            "https://www.googleapis.com/auth/cloud-platform",
+            "https://www.googleapis.com/auth/dialogflow"
           ].freeze
 
           # @private
@@ -228,32 +232,50 @@ module Google
             @get_agent = Google::Gax.create_api_call(
               @agents_stub.method(:get_agent),
               defaults["get_agent"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'parent' => request.parent}
+              end
             )
             @search_agents = Google::Gax.create_api_call(
               @agents_stub.method(:search_agents),
               defaults["search_agents"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'parent' => request.parent}
+              end
             )
             @train_agent = Google::Gax.create_api_call(
               @agents_stub.method(:train_agent),
               defaults["train_agent"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'parent' => request.parent}
+              end
             )
             @export_agent = Google::Gax.create_api_call(
               @agents_stub.method(:export_agent),
               defaults["export_agent"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'parent' => request.parent}
+              end
             )
             @import_agent = Google::Gax.create_api_call(
               @agents_stub.method(:import_agent),
               defaults["import_agent"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'parent' => request.parent}
+              end
             )
             @restore_agent = Google::Gax.create_api_call(
               @agents_stub.method(:restore_agent),
               defaults["restore_agent"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'parent' => request.parent}
+              end
             )
           end
 
@@ -353,8 +375,7 @@ module Google
 
           # Trains the specified agent.
           #
-          # Operation <response: {Google::Protobuf::Empty},
-          #            metadata: {Google::Protobuf::Struct}>
+          # Operation <response: {Google::Protobuf::Empty}>
           #
           # @param parent [String]
           #   Required. The project that the agent to train is associated with.
@@ -417,16 +438,17 @@ module Google
 
           # Exports the specified agent to a ZIP file.
           #
-          # Operation <response: {Google::Cloud::Dialogflow::V2::ExportAgentResponse ExportAgentResponse},
-          #            metadata: {Google::Protobuf::Struct}>
+          # Operation <response: {Google::Cloud::Dialogflow::V2::ExportAgentResponse ExportAgentResponse}>
           #
           # @param parent [String]
           #   Required. The project that the agent to export is associated with.
           #   Format: `projects/<Project ID>`.
           # @param agent_uri [String]
-          #   Optional. The Google Cloud Storage URI to export the agent to.
-          #   Note: The URI must start with
-          #   "gs://". If left unspecified, the serialized agent is returned inline.
+          #   Optional. The
+          #   [Google Cloud Storage](https://cloud.google.com/storage/docs/)
+          #   URI to export the agent to.
+          #   The format of this URI must be `gs://<bucket-name>/<object-name>`.
+          #   If left unspecified, the serialized agent is returned inline.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
@@ -491,8 +513,7 @@ module Google
           # Intents and entity types with the same name are replaced with the new
           # versions from ImportAgentRequest.
           #
-          # Operation <response: {Google::Protobuf::Empty},
-          #            metadata: {Google::Protobuf::Struct}>
+          # Operation <response: {Google::Protobuf::Empty}>
           #
           # @param parent [String]
           #   Required. The project that the agent to import is associated with.
@@ -504,17 +525,17 @@ module Google
           #   The agent to import.
           #
           #   Example for how to import an agent via the command line:
-          #
-          #   curl \
-          #     'https://dialogflow.googleapis.com/v2/projects/<project_name>/agent:import\
+          #   <pre>curl \
+          #     'https://dialogflow.googleapis.com/v2/projects/&lt;project_name&gt;/agent:import\
           #      -X POST \
-          #      -H 'Authorization: Bearer '$(gcloud auth print-access-token) \
+          #      -H 'Authorization: Bearer '$(gcloud auth application-default
+          #      print-access-token) \
           #      -H 'Accept: application/json' \
           #      -H 'Content-Type: application/json' \
           #      --compressed \
           #      --data-binary "{
-          #         'agentContent': '$(cat <agent zip file> | base64 -w 0)'
-          #      }"
+          #         'agentContent': '$(cat &lt;agent zip file&gt; | base64 -w 0)'
+          #      }"</pre>
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
@@ -580,8 +601,7 @@ module Google
           # Replaces the current agent version with a new one. All the intents and
           # entity types in the older version are deleted.
           #
-          # Operation <response: {Google::Protobuf::Empty},
-          #            metadata: {Google::Protobuf::Struct}>
+          # Operation <response: {Google::Protobuf::Empty}>
           #
           # @param parent [String]
           #   Required. The project that the agent to restore is associated with.
@@ -593,17 +613,17 @@ module Google
           #   The agent to restore.
           #
           #   Example for how to restore an agent via the command line:
-          #
-          #   curl \
-          #     'https://dialogflow.googleapis.com/v2/projects/<project_name>/agent:restore\
+          #   <pre>curl \
+          #     'https://dialogflow.googleapis.com/v2/projects/&lt;project_name&gt;/agent:restore\
           #      -X POST \
-          #      -H 'Authorization: Bearer '$(gcloud auth print-access-token) \
+          #      -H 'Authorization: Bearer '$(gcloud auth application-default
+          #      print-access-token) \
           #      -H 'Accept: application/json' \
           #      -H 'Content-Type: application/json' \
           #      --compressed \
           #      --data-binary "{
-          #          'agentContent': '$(cat <agent zip file> | base64 -w 0)'
-          #      }" \
+          #          'agentContent': '$(cat &lt;agent zip file&gt; | base64 -w 0)'
+          #      }"</pre>
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.

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

@@ -0,0 +1,51 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/dialogflow/v2/audio_config.proto
+
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "google.cloud.dialogflow.v2.VoiceSelectionParams" do
+    optional :name, :string, 1
+    optional :ssml_gender, :enum, 2, "google.cloud.dialogflow.v2.SsmlVoiceGender"
+  end
+  add_message "google.cloud.dialogflow.v2.SynthesizeSpeechConfig" do
+    optional :speaking_rate, :double, 1
+    optional :pitch, :double, 2
+    optional :volume_gain_db, :double, 3
+    repeated :effects_profile_id, :string, 5
+    optional :voice, :message, 4, "google.cloud.dialogflow.v2.VoiceSelectionParams"
+  end
+  add_message "google.cloud.dialogflow.v2.OutputAudioConfig" do
+    optional :audio_encoding, :enum, 1, "google.cloud.dialogflow.v2.OutputAudioEncoding"
+    optional :sample_rate_hertz, :int32, 2
+    optional :synthesize_speech_config, :message, 3, "google.cloud.dialogflow.v2.SynthesizeSpeechConfig"
+  end
+  add_enum "google.cloud.dialogflow.v2.SsmlVoiceGender" do
+    value :SSML_VOICE_GENDER_UNSPECIFIED, 0
+    value :SSML_VOICE_GENDER_MALE, 1
+    value :SSML_VOICE_GENDER_FEMALE, 2
+    value :SSML_VOICE_GENDER_NEUTRAL, 3
+  end
+  add_enum "google.cloud.dialogflow.v2.OutputAudioEncoding" do
+    value :OUTPUT_AUDIO_ENCODING_UNSPECIFIED, 0
+    value :OUTPUT_AUDIO_ENCODING_LINEAR_16, 1
+    value :OUTPUT_AUDIO_ENCODING_MP3, 2
+    value :OUTPUT_AUDIO_ENCODING_OGG_OPUS, 3
+  end
+end
+
+module Google
+  module Cloud
+    module Dialogflow
+      module V2
+        VoiceSelectionParams = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.VoiceSelectionParams").msgclass
+        SynthesizeSpeechConfig = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.SynthesizeSpeechConfig").msgclass
+        OutputAudioConfig = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.OutputAudioConfig").msgclass
+        SsmlVoiceGender = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.SsmlVoiceGender").enummodule
+        OutputAudioEncoding = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.OutputAudioEncoding").enummodule
+      end
+    end
+  end
+end

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

@@ -5,6 +5,7 @@
 require 'google/protobuf'
 
 require 'google/api/annotations_pb'
+require 'google/api/resource_pb'
 require 'google/protobuf/empty_pb'
 require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/struct_pb'

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

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/cloud/dialogflow/v2/context.proto for package 'google.cloud.dialogflow.v2'
 # Original file comments:
-# Copyright 2018 Google Inc.
+# Copyright 2019 Google LLC.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,6 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+#
 
 
 require 'grpc'
@@ -37,11 +38,12 @@ module Google
           # [StreamingDetectIntent][google.cloud.dialogflow.v2.Sessions.StreamingDetectIntent]) request,
           # or as output contexts included in the returned intent.
           # Contexts expire when an intent is matched, after the number of `DetectIntent`
-          # requests specified by the `lifespan_count` parameter, or after 10 minutes
+          # requests specified by the `lifespan_count` parameter, or after 20 minutes
           # if no intents are matched for a `DetectIntent` request.
           #
           # For more information about contexts, see the
-          # [Dialogflow documentation](https://dialogflow.com/docs/contexts).
+          # [Dialogflow
+          # documentation](https://cloud.google.com/dialogflow-enterprise/docs/contexts-overview).
           class Service
 
             include GRPC::GenericService
@@ -55,6 +57,8 @@ module Google
             # Retrieves the specified context.
             rpc :GetContext, GetContextRequest, Context
             # Creates a context.
+            #
+            # If the specified context already exists, overrides the context.
             rpc :CreateContext, CreateContextRequest, Context
             # Updates the specified context.
             rpc :UpdateContext, UpdateContextRequest, Context

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

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -44,11 +44,12 @@ module Google
         # {Google::Cloud::Dialogflow::V2::Sessions::StreamingDetectIntent StreamingDetectIntent}) request,
         # or as output contexts included in the returned intent.
         # Contexts expire when an intent is matched, after the number of `DetectIntent`
-        # requests specified by the `lifespan_count` parameter, or after 10 minutes
+        # requests specified by the `lifespan_count` parameter, or after 20 minutes
         # if no intents are matched for a `DetectIntent` request.
         #
         # For more information about contexts, see the
-        # [Dialogflow documentation](https://dialogflow.com/docs/contexts).
+        # [Dialogflow
+        # documentation](https://cloud.google.com/dialogflow-enterprise/docs/contexts-overview).
         #
         # @!attribute [r] contexts_stub
         #   @return [Google::Cloud::Dialogflow::V2::Contexts::Stub]
@@ -79,32 +80,22 @@ module Google
           # The scopes needed to make gRPC calls to all of the methods defined in
           # this service.
           ALL_SCOPES = [
-            "https://www.googleapis.com/auth/cloud-platform"
+            "https://www.googleapis.com/auth/cloud-platform",
+            "https://www.googleapis.com/auth/dialogflow"
           ].freeze
 
 
-          SESSION_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
-            "projects/{project}/agent/sessions/{session}"
-          )
-
-          private_constant :SESSION_PATH_TEMPLATE
-
           CONTEXT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
             "projects/{project}/agent/sessions/{session}/contexts/{context}"
           )
 
           private_constant :CONTEXT_PATH_TEMPLATE
 
-          # Returns a fully-qualified session resource name string.
-          # @param project [String]
-          # @param session [String]
-          # @return [String]
-          def self.session_path project, session
-            SESSION_PATH_TEMPLATE.render(
-              :"project" => project,
-              :"session" => session
-            )
-          end
+          SESSION_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "projects/{project}/agent/sessions/{session}"
+          )
+
+          private_constant :SESSION_PATH_TEMPLATE
 
           # Returns a fully-qualified context resource name string.
           # @param project [String]
@@ -119,6 +110,17 @@ module Google
             )
           end
 
+          # Returns a fully-qualified session resource name string.
+          # @param project [String]
+          # @param session [String]
+          # @return [String]
+          def self.session_path project, session
+            SESSION_PATH_TEMPLATE.render(
+              :"project" => project,
+              :"session" => session
+            )
+          end
+
           # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
           #   Provides the means for authenticating requests made by the client. This parameter can
           #   be many types.
@@ -225,32 +227,50 @@ module Google
             @list_contexts = Google::Gax.create_api_call(
               @contexts_stub.method(:list_contexts),
               defaults["list_contexts"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'parent' => request.parent}
+              end
             )
             @get_context = Google::Gax.create_api_call(
               @contexts_stub.method(:get_context),
               defaults["get_context"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'name' => request.name}
+              end
             )
             @create_context = Google::Gax.create_api_call(
               @contexts_stub.method(:create_context),
               defaults["create_context"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'parent' => request.parent}
+              end
             )
             @update_context = Google::Gax.create_api_call(
               @contexts_stub.method(:update_context),
               defaults["update_context"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'context.name' => request.context.name}
+              end
             )
             @delete_context = Google::Gax.create_api_call(
               @contexts_stub.method(:delete_context),
               defaults["delete_context"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'name' => request.name}
+              end
             )
             @delete_all_contexts = Google::Gax.create_api_call(
               @contexts_stub.method(:delete_all_contexts),
               defaults["delete_all_contexts"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'parent' => request.parent}
+              end
             )
           end
 
@@ -344,6 +364,8 @@ module Google
 
           # Creates a context.
           #
+          # If the specified context already exists, overrides the context.
+          #
           # @param parent [String]
           #   Required. The session to create a context for.
           #   Format: `projects/<Project ID>/agent/sessions/<Session ID>`.

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

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -21,7 +21,8 @@ module Google
       module V2
         class Credentials < Google::Auth::Credentials
           SCOPE = [
-            "https://www.googleapis.com/auth/cloud-platform"
+            "https://www.googleapis.com/auth/cloud-platform",
+            "https://www.googleapis.com/auth/dialogflow"
           ].freeze
           PATH_ENV_VARS = %w(DIALOGFLOW_CREDENTIALS
                              DIALOGFLOW_KEYFILE