google-cloud-dialogflow-v2 0.1.0 → 0.2.0

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

@@ -18,7 +18,6 @@
 
 require "googleauth"
 
-
 module Google
   module Cloud
     module Dialogflow

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

@@ -23,7 +23,6 @@ require "google/cloud/dialogflow/v2/version"
 require "google/cloud/dialogflow/v2/agents/client"
 require "google/longrunning/operations_pb"
 
-
 module Google
   module Cloud
     module Dialogflow

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

@@ -51,6 +51,8 @@ module Google
             def project_path project:
               "projects/#{project}"
             end
+
+            extend self
           end
         end
       end

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

@@ -26,13 +26,33 @@ require "google/cloud/dialogflow/v2/context_pb"
 require "google/cloud/dialogflow/v2/contexts/credentials"
 require "google/cloud/dialogflow/v2/contexts/paths"
 
-
 module Google
   module Cloud
     module Dialogflow
       module V2
         module Contexts
-          # Service that implements Contexts API.
+          ##
+          # Client for the Contexts service.
+          #
+          # A context represents additional information included with user input or with
+          # an intent returned by the Dialogflow API. Contexts are helpful for
+          # differentiating user input which may be vague or have a different meaning
+          # depending on additional details from your application such as user setting
+          # and preferences, previous user input, where the user is in your application,
+          # geographic location, and so on.
+          #
+          # You can include contexts as input parameters of a
+          # {Google::Cloud::Dialogflow::V2::Sessions::Client#detect_intent DetectIntent} (or
+          # {Google::Cloud::Dialogflow::V2::Sessions::Client#streaming_detect_intent 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 20 minutes
+          # if no intents are matched for a `DetectIntent` request.
+          #
+          # For more information about contexts, see the
+          # [Dialogflow
+          # documentation](https://cloud.google.com/dialogflow/docs/contexts-overview).
+          #
           class Client
             include Paths
 
@@ -195,7 +215,11 @@ module Google
             # @overload list_contexts(parent: nil, page_size: nil, page_token: nil)
             #   @param parent [String]
             #     Required. The session to list all contexts from.
-            #     Format: `projects/<Project ID>/agent/sessions/<Session ID>`.
+            #     Format: `projects/<Project ID>/agent/sessions/<Session ID>` or
+            #     `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
+            #     ID>/sessions/<Session ID>`.
+            #     If `Environment ID` is not specified, we assume default 'draft'
+            #     environment. If `User ID` is not specified, we assume default '-' user.
             #   @param page_size [Integer]
             #     Optional. The maximum number of items to return in a single page. By
             #     default 100 and at most 1000.
@@ -261,7 +285,11 @@ module Google
             # @overload get_context(name: nil)
             #   @param name [String]
             #     Required. The name of the context. Format:
-            #     `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`.
+            #     `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`
+            #     or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
+            #     ID>/sessions/<Session ID>/contexts/<Context ID>`.
+            #     If `Environment ID` is not specified, we assume default 'draft'
+            #     environment. If `User ID` is not specified, we assume default '-' user.
             #
             #
             # @yield [response, operation] Access the result along with the RPC operation
@@ -325,7 +353,11 @@ module Google
             # @overload create_context(parent: nil, context: nil)
             #   @param parent [String]
             #     Required. The session to create a context for.
-            #     Format: `projects/<Project ID>/agent/sessions/<Session ID>`.
+            #     Format: `projects/<Project ID>/agent/sessions/<Session ID>` or
+            #     `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
+            #     ID>/sessions/<Session ID>`.
+            #     If `Environment ID` is not specified, we assume default 'draft'
+            #     environment. If `User ID` is not specified, we assume default '-' user.
             #   @param context [Google::Cloud::Dialogflow::V2::Context | Hash]
             #     Required. The context to create.
             #
@@ -448,7 +480,11 @@ module Google
             # @overload delete_context(name: nil)
             #   @param name [String]
             #     Required. The name of the context to delete. Format:
-            #     `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`.
+            #     `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`
+            #     or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
+            #     ID>/sessions/<Session ID>/contexts/<Context ID>`.
+            #     If `Environment ID` is not specified, we assume default 'draft'
+            #     environment. If `User ID` is not specified, we assume default '-' user.
             #
             #
             # @yield [response, operation] Access the result along with the RPC operation
@@ -508,7 +544,11 @@ module Google
             # @overload delete_all_contexts(parent: nil)
             #   @param parent [String]
             #     Required. The name of the session to delete all contexts from. Format:
-            #     `projects/<Project ID>/agent/sessions/<Session ID>`.
+            #     `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project
+            #     ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session
+            #     ID>`.
+            #     If `Environment ID` is not specified we assume default 'draft' environment.
+            #     If `User ID` is not specified, we assume default '-' user.
             #
             #
             # @yield [response, operation] Access the result along with the RPC operation

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

@@ -18,7 +18,6 @@
 
 require "googleauth"
 
-
 module Google
   module Cloud
     module Dialogflow

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

@@ -42,6 +42,8 @@ module Google
 
               "projects/#{project}/agent/sessions/#{session}/contexts/#{context}"
             end
+
+            extend self
           end
         end
       end

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

@@ -27,13 +27,43 @@ require "google/cloud/dialogflow/v2/entity_types/credentials"
 require "google/cloud/dialogflow/v2/entity_types/paths"
 require "google/cloud/dialogflow/v2/entity_types/operations"
 
-
 module Google
   module Cloud
     module Dialogflow
       module V2
         module EntityTypes
-          # Service that implements EntityTypes API.
+          ##
+          # Client for the EntityTypes service.
+          #
+          # Entities are extracted from user input and represent parameters that are
+          # meaningful to your application. For example, a date range, a proper name
+          # such as a geographic location or landmark, and so on. Entities represent
+          # actionable data for your application.
+          #
+          # When you define an entity, you can also include synonyms that all map to
+          # that entity. For example, "soft drink", "soda", "pop", and so on.
+          #
+          # There are three types of entities:
+          #
+          # *   **System** - entities that are defined by the Dialogflow API for common
+          #     data types such as date, time, currency, and so on. A system entity is
+          #     represented by the `EntityType` type.
+          #
+          # *   **Custom** - entities that are defined by you that represent
+          #     actionable data that is meaningful to your application. For example,
+          #     you could define a `pizza.sauce` entity for red or white pizza sauce,
+          #     a `pizza.cheese` entity for the different types of cheese on a pizza,
+          #     a `pizza.topping` entity for different toppings, and so on. A custom
+          #     entity is represented by the `EntityType` type.
+          #
+          # *   **User** - entities that are built for an individual user such as
+          #     favorites, preferences, playlists, and so on. A user entity is
+          #     represented by the {Google::Cloud::Dialogflow::V2::SessionEntityType SessionEntityType} type.
+          #
+          # For more information about entity types, see the
+          # [Dialogflow
+          # documentation](https://cloud.google.com/dialogflow/docs/entities-overview).
+          #
           class Client
             include Paths
 

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

@@ -18,7 +18,6 @@
 
 require "googleauth"
 
-
 module Google
   module Cloud
     module Dialogflow

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

@@ -23,7 +23,6 @@ require "google/cloud/dialogflow/v2/version"
 require "google/cloud/dialogflow/v2/entity_types/client"
 require "google/longrunning/operations_pb"
 
-
 module Google
   module Cloud
     module Dialogflow

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

@@ -54,6 +54,8 @@ module Google
 
               "projects/#{project}/agent/entityTypes/#{entity_type}"
             end
+
+            extend self
           end
         end
       end

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

@@ -27,13 +27,47 @@ require "google/cloud/dialogflow/v2/intents/credentials"
 require "google/cloud/dialogflow/v2/intents/paths"
 require "google/cloud/dialogflow/v2/intents/operations"
 
-
 module Google
   module Cloud
     module Dialogflow
       module V2
         module Intents
-          # Service that implements Intents API.
+          ##
+          # Client for the Intents service.
+          #
+          # An intent represents a mapping between input from a user and an action to
+          # be taken by your application. When you pass user input to the
+          # {Google::Cloud::Dialogflow::V2::Sessions::Client#detect_intent DetectIntent} (or
+          # {Google::Cloud::Dialogflow::V2::Sessions::Client#streaming_detect_intent StreamingDetectIntent}) method, the
+          # Dialogflow API analyzes the input and searches
+          # for a matching intent. If no match is found, the Dialogflow API returns a
+          # fallback intent (`is_fallback` = true).
+          #
+          # You can provide additional information for the Dialogflow API to use to
+          # match user input to an intent by adding the following to your intent.
+          #
+          # *   **Contexts** - provide additional context for intent analysis. For
+          #     example, if an intent is related to an object in your application that
+          #     plays music, you can provide a context to determine when to match the
+          #     intent if the user input is "turn it off". You can include a context
+          #     that matches the intent when there is previous user input of
+          #     "play music", and not when there is previous user input of
+          #     "turn on the light".
+          #
+          # *   **Events** - allow for matching an intent by using an event name
+          #     instead of user input. Your application can provide an event name and
+          #     related parameters to the Dialogflow API to match an intent. For
+          #     example, when your application starts, you can send a welcome event
+          #     with a user name parameter to the Dialogflow API to match an intent with
+          #     a personalized welcome message for the user.
+          #
+          # *   **Training phrases** - provide examples of user input to train the
+          #     Dialogflow API agent to better match intents.
+          #
+          # For more information about intents, see the
+          # [Dialogflow
+          # documentation](https://cloud.google.com/dialogflow/docs/intents-overview).
+          #
           class Client
             include Paths
 

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

@@ -18,7 +18,6 @@
 
 require "googleauth"
 
-
 module Google
   module Cloud
     module Dialogflow

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

@@ -23,7 +23,6 @@ require "google/cloud/dialogflow/v2/version"
 require "google/cloud/dialogflow/v2/intents/client"
 require "google/longrunning/operations_pb"
 
-
 module Google
   module Cloud
     module Dialogflow

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

@@ -73,6 +73,8 @@ module Google
 
               "projects/#{project}/agent/intents/#{intent}"
             end
+
+            extend self
           end
         end
       end

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

@@ -26,13 +26,32 @@ require "google/cloud/dialogflow/v2/session_entity_type_pb"
 require "google/cloud/dialogflow/v2/session_entity_types/credentials"
 require "google/cloud/dialogflow/v2/session_entity_types/paths"
 
-
 module Google
   module Cloud
     module Dialogflow
       module V2
         module SessionEntityTypes
-          # Service that implements SessionEntityTypes API.
+          ##
+          # Client for the SessionEntityTypes service.
+          #
+          # Entities are extracted from user input and represent parameters that are
+          # meaningful to your application. For example, a date range, a proper name
+          # such as a geographic location or landmark, and so on. Entities represent
+          # actionable data for your application.
+          #
+          # Session entity types are referred to as **User** entity types and are
+          # entities that are built for an individual user such as
+          # favorites, preferences, playlists, and so on. You can redefine a session
+          # entity type at the session level.
+          #
+          # Session entity methods do not work with Google Assistant integration.
+          # Contact Dialogflow support if you need to use session entities
+          # with Google Assistant integration.
+          #
+          # For more information about entity types, see the
+          # [Dialogflow
+          # documentation](https://cloud.google.com/dialogflow/docs/entities-overview).
+          #
           class Client
             include Paths
 
@@ -195,7 +214,11 @@ module Google
             # @overload list_session_entity_types(parent: nil, page_size: nil, page_token: nil)
             #   @param parent [String]
             #     Required. The session to list all session entity types from.
-            #     Format: `projects/<Project ID>/agent/sessions/<Session ID>`.
+            #     Format: `projects/<Project ID>/agent/sessions/<Session ID>` or
+            #     `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/
+            #     sessions/<Session ID>`.
+            #     If `Environment ID` is not specified, we assume default 'draft'
+            #     environment. If `User ID` is not specified, we assume default '-' user.
             #   @param page_size [Integer]
             #     Optional. The maximum number of items to return in a single page. By
             #     default 100 and at most 1000.
@@ -270,7 +293,11 @@ module Google
             #   @param name [String]
             #     Required. The name of the session entity type. Format:
             #     `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
-            #     Display Name>`.
+            #     Display Name>` or `projects/<Project ID>/agent/environments/<Environment
+            #     ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display
+            #     Name>`.
+            #     If `Environment ID` is not specified, we assume default 'draft'
+            #     environment. If `User ID` is not specified, we assume default '-' user.
             #
             #
             # @yield [response, operation] Access the result along with the RPC operation
@@ -344,7 +371,11 @@ module Google
             # @overload create_session_entity_type(parent: nil, session_entity_type: nil)
             #   @param parent [String]
             #     Required. The session to create a session entity type for.
-            #     Format: `projects/<Project ID>/agent/sessions/<Session ID>`.
+            #     Format: `projects/<Project ID>/agent/sessions/<Session ID>` or
+            #     `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/
+            #     sessions/<Session ID>`.
+            #     If `Environment ID` is not specified, we assume default 'draft'
+            #     environment. If `User ID` is not specified, we assume default '-' user.
             #   @param session_entity_type [Google::Cloud::Dialogflow::V2::SessionEntityType | Hash]
             #     Required. The session entity type to create.
             #
@@ -413,9 +444,7 @@ module Google
             #
             # @overload update_session_entity_type(session_entity_type: nil, update_mask: nil)
             #   @param session_entity_type [Google::Cloud::Dialogflow::V2::SessionEntityType | Hash]
-            #     Required. The entity type to update. Format:
-            #     `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
-            #     Display Name>`.
+            #     Required. The session entity type to update.
             #   @param update_mask [Google::Protobuf::FieldMask | Hash]
             #     Optional. The mask to control which fields get updated.
             #
@@ -486,7 +515,11 @@ module Google
             #   @param name [String]
             #     Required. The name of the entity type to delete. Format:
             #     `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
-            #     Display Name>`.
+            #     Display Name>` or `projects/<Project ID>/agent/environments/<Environment
+            #     ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display
+            #     Name>`.
+            #     If `Environment ID` is not specified, we assume default 'draft'
+            #     environment. If `User ID` is not specified, we assume default '-' user.
             #
             #
             # @yield [response, operation] Access the result along with the RPC operation

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

@@ -18,7 +18,6 @@
 
 require "googleauth"
 
-
 module Google
   module Cloud
     module Dialogflow

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

@@ -61,6 +61,8 @@ module Google
 
               "projects/#{project}/agent/sessions/#{session}/entityTypes/#{entity_type}"
             end
+
+            extend self
           end
         end
       end

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

@@ -26,13 +26,19 @@ require "google/cloud/dialogflow/v2/session_pb"
 require "google/cloud/dialogflow/v2/sessions/credentials"
 require "google/cloud/dialogflow/v2/sessions/paths"
 
-
 module Google
   module Cloud
     module Dialogflow
       module V2
         module Sessions
-          # Service that implements Sessions API.
+          ##
+          # Client for the Sessions service.
+          #
+          # A session represents an interaction with a user. You retrieve user input
+          # and pass it to the {Google::Cloud::Dialogflow::V2::Sessions::Client#detect_intent DetectIntent} (or
+          # {Google::Cloud::Dialogflow::V2::Sessions::Client#streaming_detect_intent StreamingDetectIntent}) method to determine
+          # user intent and respond.
+          #
           class Client
             include Paths
 
@@ -169,10 +175,14 @@ module Google
             # @overload detect_intent(session: nil, query_params: nil, query_input: nil, output_audio_config: nil, output_audio_config_mask: nil, input_audio: nil)
             #   @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.
+            #     `projects/<Project ID>/agent/sessions/<Session ID>`, or
+            #     `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
+            #     ID>/sessions/<Session ID>`. If `Environment ID` is not specified, we assume
+            #     default 'draft' environment. If `User ID` is not specified, we are using
+            #     "-". It's up to the API caller to choose an appropriate `Session ID` and
+            #     `User Id`. They can be a random number or some type of user and session
+            #     identifiers (preferably hashed). The length of the `Session ID` and
+            #     `User ID` must not exceed 36 characters.
             #   @param query_params [Google::Cloud::Dialogflow::V2::QueryParameters | Hash]
             #     The parameters of this query.
             #   @param query_input [Google::Cloud::Dialogflow::V2::QueryInput | Hash]