google-cloud-dialogflow 0.1.0

data/lib/google/cloud/dialogflow/v2/session_entity_types_client_config.json

@@ -0,0 +1,51 @@
+{
+  "interfaces": {
+    "google.cloud.dialogflow.v2.SessionEntityTypes": {
+      "retry_codes": {
+        "idempotent": [
+          "DEADLINE_EXCEEDED",
+          "UNAVAILABLE"
+        ],
+        "non_idempotent": []
+      },
+      "retry_params": {
+        "default": {
+          "initial_retry_delay_millis": 100,
+          "retry_delay_multiplier": 1.3,
+          "max_retry_delay_millis": 60000,
+          "initial_rpc_timeout_millis": 20000,
+          "rpc_timeout_multiplier": 1.0,
+          "max_rpc_timeout_millis": 20000,
+          "total_timeout_millis": 600000
+        }
+      },
+      "methods": {
+        "ListSessionEntityTypes": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "GetSessionEntityType": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "CreateSessionEntityType": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        },
+        "UpdateSessionEntityType": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        },
+        "DeleteSessionEntityType": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,127 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/dialogflow/v2/session.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/cloud/dialogflow/v2/context_pb'
+require 'google/cloud/dialogflow/v2/intent_pb'
+require 'google/cloud/dialogflow/v2/session_entity_type_pb'
+require 'google/protobuf/struct_pb'
+require 'google/rpc/status_pb'
+require 'google/type/latlng_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "google.cloud.dialogflow.v2.DetectIntentRequest" do
+    optional :session, :string, 1
+    optional :query_params, :message, 2, "google.cloud.dialogflow.v2.QueryParameters"
+    optional :query_input, :message, 3, "google.cloud.dialogflow.v2.QueryInput"
+    optional :input_audio, :bytes, 5
+  end
+  add_message "google.cloud.dialogflow.v2.DetectIntentResponse" do
+    optional :response_id, :string, 1
+    optional :query_result, :message, 2, "google.cloud.dialogflow.v2.QueryResult"
+    optional :webhook_status, :message, 3, "google.rpc.Status"
+  end
+  add_message "google.cloud.dialogflow.v2.QueryParameters" do
+    optional :time_zone, :string, 1
+    optional :geo_location, :message, 2, "google.type.LatLng"
+    repeated :contexts, :message, 3, "google.cloud.dialogflow.v2.Context"
+    optional :reset_contexts, :bool, 4
+    repeated :session_entity_types, :message, 5, "google.cloud.dialogflow.v2.SessionEntityType"
+    optional :payload, :message, 6, "google.protobuf.Struct"
+  end
+  add_message "google.cloud.dialogflow.v2.QueryInput" do
+    oneof :input do
+      optional :audio_config, :message, 1, "google.cloud.dialogflow.v2.InputAudioConfig"
+      optional :text, :message, 2, "google.cloud.dialogflow.v2.TextInput"
+      optional :event, :message, 3, "google.cloud.dialogflow.v2.EventInput"
+    end
+  end
+  add_message "google.cloud.dialogflow.v2.QueryResult" do
+    optional :query_text, :string, 1
+    optional :language_code, :string, 15
+    optional :speech_recognition_confidence, :float, 2
+    optional :action, :string, 3
+    optional :parameters, :message, 4, "google.protobuf.Struct"
+    optional :all_required_params_present, :bool, 5
+    optional :fulfillment_text, :string, 6
+    repeated :fulfillment_messages, :message, 7, "google.cloud.dialogflow.v2.Intent.Message"
+    optional :webhook_source, :string, 8
+    optional :webhook_payload, :message, 9, "google.protobuf.Struct"
+    repeated :output_contexts, :message, 10, "google.cloud.dialogflow.v2.Context"
+    optional :intent, :message, 11, "google.cloud.dialogflow.v2.Intent"
+    optional :intent_detection_confidence, :float, 12
+    optional :diagnostic_info, :message, 14, "google.protobuf.Struct"
+  end
+  add_message "google.cloud.dialogflow.v2.StreamingDetectIntentRequest" do
+    optional :session, :string, 1
+    optional :query_params, :message, 2, "google.cloud.dialogflow.v2.QueryParameters"
+    optional :query_input, :message, 3, "google.cloud.dialogflow.v2.QueryInput"
+    optional :single_utterance, :bool, 4
+    optional :input_audio, :bytes, 6
+  end
+  add_message "google.cloud.dialogflow.v2.StreamingDetectIntentResponse" do
+    optional :response_id, :string, 1
+    optional :recognition_result, :message, 2, "google.cloud.dialogflow.v2.StreamingRecognitionResult"
+    optional :query_result, :message, 3, "google.cloud.dialogflow.v2.QueryResult"
+    optional :webhook_status, :message, 4, "google.rpc.Status"
+  end
+  add_message "google.cloud.dialogflow.v2.StreamingRecognitionResult" do
+    optional :message_type, :enum, 1, "google.cloud.dialogflow.v2.StreamingRecognitionResult.MessageType"
+    optional :transcript, :string, 2
+    optional :is_final, :bool, 3
+    optional :confidence, :float, 4
+  end
+  add_enum "google.cloud.dialogflow.v2.StreamingRecognitionResult.MessageType" do
+    value :MESSAGE_TYPE_UNSPECIFIED, 0
+    value :TRANSCRIPT, 1
+    value :END_OF_SINGLE_UTTERANCE, 2
+  end
+  add_message "google.cloud.dialogflow.v2.InputAudioConfig" do
+    optional :audio_encoding, :enum, 1, "google.cloud.dialogflow.v2.AudioEncoding"
+    optional :sample_rate_hertz, :int32, 2
+    optional :language_code, :string, 3
+    repeated :phrase_hints, :string, 4
+  end
+  add_message "google.cloud.dialogflow.v2.TextInput" do
+    optional :text, :string, 1
+    optional :language_code, :string, 2
+  end
+  add_message "google.cloud.dialogflow.v2.EventInput" do
+    optional :name, :string, 1
+    optional :parameters, :message, 2, "google.protobuf.Struct"
+    optional :language_code, :string, 3
+  end
+  add_enum "google.cloud.dialogflow.v2.AudioEncoding" do
+    value :AUDIO_ENCODING_UNSPECIFIED, 0
+    value :AUDIO_ENCODING_LINEAR_16, 1
+    value :AUDIO_ENCODING_FLAC, 2
+    value :AUDIO_ENCODING_MULAW, 3
+    value :AUDIO_ENCODING_AMR, 4
+    value :AUDIO_ENCODING_AMR_WB, 5
+    value :AUDIO_ENCODING_OGG_OPUS, 6
+    value :AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE, 7
+  end
+end
+
+module Google
+  module Cloud
+    module Dialogflow
+      module V2
+        DetectIntentRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.DetectIntentRequest").msgclass
+        DetectIntentResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.DetectIntentResponse").msgclass
+        QueryParameters = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.QueryParameters").msgclass
+        QueryInput = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.QueryInput").msgclass
+        QueryResult = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.QueryResult").msgclass
+        StreamingDetectIntentRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.StreamingDetectIntentRequest").msgclass
+        StreamingDetectIntentResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.StreamingDetectIntentResponse").msgclass
+        StreamingRecognitionResult = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.StreamingRecognitionResult").msgclass
+        StreamingRecognitionResult::MessageType = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.StreamingRecognitionResult.MessageType").enummodule
+        InputAudioConfig = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.InputAudioConfig").msgclass
+        TextInput = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.TextInput").msgclass
+        EventInput = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.EventInput").msgclass
+        AudioEncoding = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dialogflow.v2.AudioEncoding").enummodule
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/dialogflow/v2/session.proto for package 'google.cloud.dialogflow.v2'
+# Original file comments:
+# Copyright 2018 Google Inc.
+#
+# 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
+#
+#     http://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.
+#
+
+require 'grpc'
+require 'google/cloud/dialogflow/v2/session_pb'
+
+module Google
+  module Cloud
+    module Dialogflow
+      module V2
+        module Sessions
+          # A session represents an interaction with a user. You retrieve user input
+          # and pass it to the [DetectIntent][google.cloud.dialogflow.v2.Sessions.DetectIntent] (or
+          # [StreamingDetectIntent][google.cloud.dialogflow.v2.Sessions.StreamingDetectIntent]) method to determine
+          # user intent and respond.
+          class Service
+
+            include GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.cloud.dialogflow.v2.Sessions'
+
+            # 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.
+            rpc :DetectIntent, DetectIntentRequest, DetectIntentResponse
+            # Processes a natural language query in audio format in a streaming fashion
+            # and returns structured, actionable data as a result. This method is only
+            # available via the gRPC API (not REST).
+            rpc :StreamingDetectIntent, stream(StreamingDetectIntentRequest), stream(StreamingDetectIntentResponse)
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,286 @@
+# Copyright 2018 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.
+#
+# EDITING INSTRUCTIONS
+# This file was generated from the file
+# https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/v2/session.proto,
+# and updates to that file get reflected here through a refresh process.
+# For the short term, the refresh process will only be runnable by Google
+# engineers.
+
+require "json"
+require "pathname"
+
+require "google/gax"
+
+require "google/cloud/dialogflow/v2/session_pb"
+require "google/cloud/dialogflow/credentials"
+
+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::DetectIntent DetectIntent} (or
+        # {Google::Cloud::Dialogflow::V2::Sessions::StreamingDetectIntent StreamingDetectIntent}) method to determine
+        # user intent and respond.
+        #
+        # @!attribute [r] sessions_stub
+        #   @return [Google::Cloud::Dialogflow::V2::Sessions::Stub]
+        class SessionsClient
+          attr_reader :sessions_stub
+
+          # The default address of the service.
+          SERVICE_ADDRESS = "dialogflow.googleapis.com".freeze
+
+          # The default port of the service.
+          DEFAULT_SERVICE_PORT = 443
+
+          DEFAULT_TIMEOUT = 30
+
+          # 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"
+          ].freeze
+
+
+          SESSION_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "projects/{project}/agent/sessions/{session}"
+          )
+
+          private_constant :SESSION_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
+
+          # @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.
+          #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
+          #   authenticating requests made by this client.
+          #   A `String` will be treated as the path to the keyfile to be used for the construction of
+          #   credentials for this client.
+          #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
+          #   credentials for this client.
+          #   A `GRPC::Core::Channel` will be used to make calls through.
+          #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
+          #   should already be composed with a `GRPC::Core::CallCredentials` object.
+          #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
+          #   metadata for requests, generally, to give OAuth credentials.
+          # @param scopes [Array<String>]
+          #   The OAuth scopes for this service. This parameter is ignored if
+          #   an updater_proc is supplied.
+          # @param client_config [Hash]
+          #   A Hash for call options for each method. See
+          #   Google::Gax#construct_settings for the structure of
+          #   this data. Falls back to the default config if not specified
+          #   or the specified config is missing data points.
+          # @param timeout [Numeric]
+          #   The default timeout, in seconds, for calls made through this client.
+          def initialize \
+              credentials: nil,
+              scopes: ALL_SCOPES,
+              client_config: {},
+              timeout: DEFAULT_TIMEOUT,
+              lib_name: nil,
+              lib_version: ""
+            # These require statements are intentionally placed here to initialize
+            # the gRPC module only when it's required.
+            # See https://github.com/googleapis/toolkit/issues/446
+            require "google/gax/grpc"
+            require "google/cloud/dialogflow/v2/session_services_pb"
+
+            credentials ||= Google::Cloud::Dialogflow::Credentials.default
+
+            if credentials.is_a?(String) || credentials.is_a?(Hash)
+              updater_proc = Google::Cloud::Dialogflow::Credentials.new(credentials).updater_proc
+            end
+            if credentials.is_a?(GRPC::Core::Channel)
+              channel = credentials
+            end
+            if credentials.is_a?(GRPC::Core::ChannelCredentials)
+              chan_creds = credentials
+            end
+            if credentials.is_a?(Proc)
+              updater_proc = credentials
+            end
+            if credentials.is_a?(Google::Auth::Credentials)
+              updater_proc = credentials.updater_proc
+            end
+
+            package_version = Gem.loaded_specs['google-cloud-dialogflow'].version.version
+
+            google_api_client = "gl-ruby/#{RUBY_VERSION}"
+            google_api_client << " #{lib_name}/#{lib_version}" if lib_name
+            google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
+            google_api_client << " grpc/#{GRPC::VERSION}"
+            google_api_client.freeze
+
+            headers = { :"x-goog-api-client" => google_api_client }
+            client_config_file = Pathname.new(__dir__).join(
+              "sessions_client_config.json"
+            )
+            defaults = client_config_file.open do |f|
+              Google::Gax.construct_settings(
+                "google.cloud.dialogflow.v2.Sessions",
+                JSON.parse(f.read),
+                client_config,
+                Google::Gax::Grpc::STATUS_CODE_NAMES,
+                timeout,
+                errors: Google::Gax::Grpc::API_ERRORS,
+                kwargs: headers
+              )
+            end
+
+            # Allow overriding the service path/port in subclasses.
+            service_path = self.class::SERVICE_ADDRESS
+            port = self.class::DEFAULT_SERVICE_PORT
+            @sessions_stub = Google::Gax::Grpc.create_stub(
+              service_path,
+              port,
+              chan_creds: chan_creds,
+              channel: channel,
+              updater_proc: updater_proc,
+              scopes: scopes,
+              &Google::Cloud::Dialogflow::V2::Sessions::Stub.method(:new)
+            )
+
+            @detect_intent = Google::Gax.create_api_call(
+              @sessions_stub.method(:detect_intent),
+              defaults["detect_intent"]
+            )
+            @streaming_detect_intent = Google::Gax.create_api_call(
+              @sessions_stub.method(:streaming_detect_intent),
+              defaults["streaming_detect_intent"]
+            )
+          end
+
+          # Service calls
+
+          # 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.
+          #
+          # @param session [String]
+          #   Required. The name of the session this query is sent to. Format:
+          #   +projects/<Project ID>/agent/sessions/<Session ID>+. It's up to the API
+          #   caller to choose an appropriate session ID. It can be a random number or
+          #   some type of user identifier (preferably hashed). The length of the session
+          #   ID must not exceed 36 bytes.
+          # @param query_input [Google::Cloud::Dialogflow::V2::QueryInput | Hash]
+          #   Required. The input specification. It can be set to:
+          #
+          #   1.  an audio config
+          #       which instructs the speech recognizer how to process the speech audio,
+          #
+          #   2.  a conversational query in the form of text, or
+          #
+          #   3.  an event that specifies which intent to trigger.
+          #   A hash of the same form as `Google::Cloud::Dialogflow::V2::QueryInput`
+          #   can also be provided.
+          # @param query_params [Google::Cloud::Dialogflow::V2::QueryParameters | Hash]
+          #   Optional. The parameters of this query.
+          #   A hash of the same form as `Google::Cloud::Dialogflow::V2::QueryParameters`
+          #   can also be provided.
+          # @param input_audio [String]
+          #   Optional. The natural language speech audio to be processed. This field
+          #   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.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @return [Google::Cloud::Dialogflow::V2::DetectIntentResponse]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/dialogflow/v2"
+          #
+          #   sessions_client = Google::Cloud::Dialogflow::V2::Sessions.new
+          #   formatted_session = Google::Cloud::Dialogflow::V2::SessionsClient.session_path("[PROJECT]", "[SESSION]")
+          #
+          #   # TODO: Initialize +query_input+:
+          #   query_input = {}
+          #   response = sessions_client.detect_intent(formatted_session, query_input)
+
+          def detect_intent \
+              session,
+              query_input,
+              query_params: nil,
+              input_audio: nil,
+              options: nil
+            req = {
+              session: session,
+              query_input: query_input,
+              query_params: query_params,
+              input_audio: input_audio
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::DetectIntentRequest)
+            @detect_intent.call(req, options)
+          end
+
+          # Processes a natural language query in audio format in a streaming fashion
+          # and returns structured, actionable data as a result. This method is only
+          # available via the gRPC API (not REST).
+          #
+          # @param reqs [Enumerable<Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest>]
+          #   The input requests.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @return [Enumerable<Google::Cloud::Dialogflow::V2::StreamingDetectIntentResponse>]
+          #   An enumerable of Google::Cloud::Dialogflow::V2::StreamingDetectIntentResponse instances.
+          #
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          #
+          # @note
+          #   EXPERIMENTAL:
+          #     Streaming requests are still undergoing review.
+          #     This method interface might change in the future.
+          #
+          # @example
+          #   require "google/cloud/dialogflow/v2"
+          #
+          #   sessions_client = Google::Cloud::Dialogflow::V2::Sessions.new
+          #
+          #   # TODO: Initialize +session+:
+          #   session = ''
+          #
+          #   # TODO: Initialize +query_input+:
+          #   query_input = {}
+          #   request = { session: session, query_input: query_input }
+          #   requests = [request]
+          #   sessions_client.streaming_detect_intent(requests).each do |element|
+          #     # Process element.
+          #   end
+
+          def streaming_detect_intent reqs, options: nil
+            request_protos = reqs.lazy.map do |req|
+              Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest)
+            end
+            @streaming_detect_intent.call(request_protos, options)
+          end
+        end
+      end
+    end
+  end
+end