lib/google/cloud/dialogflow.rb in google-cloud-dialogflow-0.2.1 vs lib/google/cloud/dialogflow.rb in google-cloud-dialogflow-0.2.2
- old
+ new
@@ -19,11 +19,11 @@
module Google
module Cloud
# rubocop:disable LineLength
##
- # # Ruby Client for Dialogflow API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
+ # # Ruby Client for Dialogflow API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
#
# [Dialogflow API][Product Documentation]:
# An end-to-end development suite for conversational interfaces (e.g.,
# chatbots, voice-powered apps and devices).
# - [Product Documentation][]
@@ -33,30 +33,30 @@
# steps:
#
# 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
# 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
# 3. [Enable the Dialogflow API.](https://console.cloud.google.com/apis/library/dialogflow.googleapis.com)
- # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+ # 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
#
# ### Installation
# ```
# $ gem install google-cloud-dialogflow
# ```
#
# ### Next Steps
# - Read the [Dialogflow API Product documentation][Product Documentation]
# to learn more about the product and see How-to Guides.
- # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
+ # - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
# to see the full list of Cloud APIs that we cover.
#
# [Product Documentation]: https://cloud.google.com/dialogflow
#
# ## 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-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
- # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
+ # or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
# that will write logs to [Stackdriver 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:
#
@@ -174,13 +174,13 @@
#
# You can include contexts as input parameters of a
# {Google::Cloud::Dialogflow::V2::Sessions::DetectIntent DetectIntent} (or
# {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
- # if no intents are matched for a +DetectIntent+ request.
+ # Contexts expire when an intent is matched, after the number of `DetectIntent`
+ # requests specified by the `lifespan_count` parameter, or after 10 minutes
+ # if no intents are matched for a `DetectIntent` request.
#
# For more information about contexts, see the
# [Dialogflow documentation](https://dialogflow.com/docs/contexts).
#
# @param version [Symbol, String]
@@ -243,18 +243,18 @@
#
# 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.
+ # represented by the `EntityType` type.
#
# * **Developer** - 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 developer
- # entity is represented by the +EntityType+ type.
+ # 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 developer
+ # 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.
#
@@ -315,10 +315,10 @@
# be taken by your application. When you pass user input to the
# {Google::Cloud::Dialogflow::V2::Sessions::DetectIntent DetectIntent} (or
# {Google::Cloud::Dialogflow::V2::Sessions::StreamingDetectIntent 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).
+ # 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