lib/google/cloud/dialogflow.rb in google-cloud-dialogflow-1.1.1 vs lib/google/cloud/dialogflow.rb in google-cloud-dialogflow-1.1.2

- old
+ new

@@ -55,39 +55,12 @@ # supported by that API version, and the corresponding gem is available, the # appropriate versioned client will be returned. # # ## About Agents # - # 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. + # Service for managing Agents. # - # After you create an agent, you can add Intents, Contexts, - # Entity Types, 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 ExportAgent method. You can import a saved - # agent by using the 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). - # # @param version [::String, ::Symbol] The API version to connect to. Optional. # Defaults to `:v2`. # @return [Agents::Client] A client object for the specified version. # def self.agents version: :v2, &block @@ -112,29 +85,12 @@ # supported by that API version, and the corresponding gem is available, the # appropriate versioned client will be returned. # # ## About Contexts # - # 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. + # Service for managing Contexts. # - # You can include contexts as input parameters of a - # DetectIntent (or - # 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). - # # @param version [::String, ::Symbol] The API version to connect to. Optional. # Defaults to `:v2`. # @return [Contexts::Client] A client object for the specified version. # def self.contexts version: :v2, &block @@ -159,39 +115,12 @@ # supported by that API version, and the corresponding gem is available, the # appropriate versioned client will be returned. # # ## About EntityTypes # - # 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. + # Service for managing EntityTypes. # - # 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 SessionEntityType type. - # - # For more information about entity types, see the - # [Dialogflow - # documentation](https://cloud.google.com/dialogflow/docs/entities-overview). - # # @param version [::String, ::Symbol] The API version to connect to. Optional. # Defaults to `:v2`. # @return [EntityTypes::Client] A client object for the specified version. # def self.entity_types version: :v2, &block @@ -216,11 +145,11 @@ # supported by that API version, and the corresponding gem is available, the # appropriate versioned client will be returned. # # ## About Environments # - # Manages agent environments. + # Service for managing Environments. # # @param version [::String, ::Symbol] The API version to connect to. Optional. # Defaults to `:v2`. # @return [Environments::Client] A client object for the specified version. # @@ -246,43 +175,12 @@ # supported by that API version, and the corresponding gem is available, the # appropriate versioned client will be returned. # # ## About Intents # - # 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 - # DetectIntent (or - # 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). + # Service for managing Intents. # - # 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). - # # @param version [::String, ::Symbol] The API version to connect to. Optional. # Defaults to `:v2`. # @return [Intents::Client] A client object for the specified version. # def self.intents version: :v2, &block @@ -307,28 +205,12 @@ # supported by that API version, and the corresponding gem is available, the # appropriate versioned client will be returned. # # ## About SessionEntityTypes # - # 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. + # Service for managing SessionEntityTypes. # - # 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). - # # @param version [::String, ::Symbol] The API version to connect to. Optional. # Defaults to `:v2`. # @return [SessionEntityTypes::Client] A client object for the specified version. # def self.session_entity_types version: :v2, &block @@ -353,15 +235,15 @@ # supported by that API version, and the corresponding gem is available, the # appropriate versioned client will be returned. # # ## About Sessions # - # A session represents an interaction with a user. You retrieve user input - # and pass it to the DetectIntent (or - # StreamingDetectIntent) method to determine - # user intent and respond. + # A service used for session interactions. # + # For more information, see the [API interactions + # guide](https://cloud.google.com/dialogflow/docs/api-overview). + # # @param version [::String, ::Symbol] The API version to connect to. Optional. # Defaults to `:v2`. # @return [Sessions::Client] A client object for the specified version. # def self.sessions version: :v2, &block @@ -387,11 +269,11 @@ # The library name as recorded in instrumentation and logging. # * `lib_version` (*type:* `String`) - # The library version as recorded in instrumentation and logging. # * `interceptors` (*type:* `Array<GRPC::ClientInterceptor>`) - # An array of interceptors that are run before calls are executed. - # * `timeout` (*type:* `Integer`) - - # Default timeout in milliseconds. + # * `timeout` (*type:* `Numeric`) - + # Default timeout in seconds. # * `metadata` (*type:* `Hash{Symbol=>String}`) - # Additional gRPC headers to be sent with the call. # * `retry_policy` (*type:* `Hash`) - # The retry policy. The value is a hash with the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.