lib/google/cloud/dialogflow/v2/intents_client.rb in google-cloud-dialogflow-0.2.1 vs lib/google/cloud/dialogflow/v2/intents_client.rb in google-cloud-dialogflow-0.2.2
- old
+ new
@@ -38,11 +38,11 @@
# 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
@@ -306,11 +306,11 @@
# Returns the list of all intents in the specified agent.
#
# @param parent [String]
# Required. The agent to list all intents from.
- # Format: +projects/<Project ID>/agent+.
+ # Format: `projects/<Project ID>/agent`.
# @param language_code [String]
# Optional. The language to list training phrases, parameters and rich
# messages for. If not specified, the agent's default language is used.
# [More than a dozen
# languages](https://dialogflow.com/docs/reference/language) are supported.
@@ -373,11 +373,11 @@
# Retrieves the specified intent.
#
# @param name [String]
# Required. The name of the intent.
- # Format: +projects/<Project ID>/agent/intents/<Intent ID>+.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
# @param language_code [String]
# Optional. The language to retrieve training phrases, parameters and rich
# messages for. If not specified, the agent's default language is used.
# [More than a dozen
# languages](https://dialogflow.com/docs/reference/language) are supported.
@@ -416,18 +416,18 @@
# Creates an intent in the specified agent.
#
# @param parent [String]
# Required. The agent to create a intent for.
- # Format: +projects/<Project ID>/agent+.
+ # Format: `projects/<Project ID>/agent`.
# @param intent [Google::Cloud::Dialogflow::V2::Intent | Hash]
# Required. The intent to create.
# A hash of the same form as `Google::Cloud::Dialogflow::V2::Intent`
# can also be provided.
# @param language_code [String]
# Optional. The language of training phrases, parameters and rich messages
- # defined in +intent+. If not specified, the agent's default language is
+ # defined in `intent`. If not specified, the agent's default language is
# used. [More than a dozen
# languages](https://dialogflow.com/docs/reference/language) are supported.
# Note: languages must be enabled in the agent, before they can be used.
# @param intent_view [Google::Cloud::Dialogflow::V2::IntentView]
# Optional. The resource view to apply to the returned intent.
@@ -443,11 +443,11 @@
# require "google/cloud/dialogflow"
#
# intents_client = Google::Cloud::Dialogflow::Intents.new(version: :v2)
# formatted_parent = Google::Cloud::Dialogflow::V2::IntentsClient.project_agent_path("[PROJECT]")
#
- # # TODO: Initialize +intent+:
+ # # TODO: Initialize `intent`:
# intent = {}
# response = intents_client.create_intent(formatted_parent, intent)
def create_intent \
parent,
@@ -468,16 +468,16 @@
# Updates the specified intent.
#
# @param intent [Google::Cloud::Dialogflow::V2::Intent | Hash]
# Required. The intent to update.
- # Format: +projects/<Project ID>/agent/intents/<Intent ID>+.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
# A hash of the same form as `Google::Cloud::Dialogflow::V2::Intent`
# can also be provided.
# @param language_code [String]
# Optional. The language of training phrases, parameters and rich messages
- # defined in +intent+. If not specified, the agent's default language is
+ # defined in `intent`. If not specified, the agent's default language is
# used. [More than a dozen
# languages](https://dialogflow.com/docs/reference/language) are supported.
# Note: languages must be enabled in the agent, before they can be used.
# @param update_mask [Google::Protobuf::FieldMask | Hash]
# Optional. The mask to control which fields get updated.
@@ -496,14 +496,14 @@
# @example
# require "google/cloud/dialogflow"
#
# intents_client = Google::Cloud::Dialogflow::Intents.new(version: :v2)
#
- # # TODO: Initialize +intent+:
+ # # TODO: Initialize `intent`:
# intent = {}
#
- # # TODO: Initialize +language_code+:
+ # # TODO: Initialize `language_code`:
# language_code = ''
# response = intents_client.update_intent(intent, language_code)
def update_intent \
intent,
@@ -524,11 +524,11 @@
# Deletes the specified intent.
#
# @param name [String]
# Required. The name of the intent to delete.
- # Format: +projects/<Project ID>/agent/intents/<Intent ID>+.
+ # Format: `projects/<Project ID>/agent/intents/<Intent ID>`.
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @yield [result, operation] Access the result along with the RPC operation
# @yieldparam result []
@@ -557,14 +557,14 @@
#
# Operation <response: {Google::Cloud::Dialogflow::V2::BatchUpdateIntentsResponse BatchUpdateIntentsResponse}>
#
# @param parent [String]
# Required. The name of the agent to update or create intents in.
- # Format: +projects/<Project ID>/agent+.
+ # Format: `projects/<Project ID>/agent`.
# @param language_code [String]
# Optional. The language of training phrases, parameters and rich messages
- # defined in +intents+. If not specified, the agent's default language is
+ # defined in `intents`. If not specified, the agent's default language is
# used. [More than a dozen
# languages](https://dialogflow.com/docs/reference/language) are supported.
# Note: languages must be enabled in the agent, before they can be used.
# @param intent_batch_uri [String]
# The URI to a Google Cloud Storage file containing intents to update or
@@ -589,11 +589,11 @@
# require "google/cloud/dialogflow"
#
# intents_client = Google::Cloud::Dialogflow::Intents.new(version: :v2)
# formatted_parent = Google::Cloud::Dialogflow::V2::IntentsClient.project_agent_path("[PROJECT]")
#
- # # TODO: Initialize +language_code+:
+ # # TODO: Initialize `language_code`:
# language_code = ''
#
# # Register a callback during the method call.
# operation = intents_client.batch_update_intents(formatted_parent, language_code) do |op|
# raise op.results.message if op.error?
@@ -653,13 +653,13 @@
#
# Operation <response: {Google::Protobuf::Empty}>
#
# @param parent [String]
# Required. The name of the agent to delete all entities types for. Format:
- # +projects/<Project ID>/agent+.
+ # `projects/<Project ID>/agent`.
# @param intents [Array<Google::Cloud::Dialogflow::V2::Intent | Hash>]
- # Required. The collection of intents to delete. Only intent +name+ must be
+ # Required. The collection of intents to delete. Only intent `name` must be
# filled in.
# A hash of the same form as `Google::Cloud::Dialogflow::V2::Intent`
# can also be provided.
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
@@ -670,10 +670,10 @@
# require "google/cloud/dialogflow"
#
# intents_client = Google::Cloud::Dialogflow::Intents.new(version: :v2)
# formatted_parent = Google::Cloud::Dialogflow::V2::IntentsClient.project_agent_path("[PROJECT]")
#
- # # TODO: Initialize +intents+:
+ # # TODO: Initialize `intents`:
# intents = []
#
# # Register a callback during the method call.
# operation = intents_client.batch_delete_intents(formatted_parent, intents) do |op|
# raise op.results.message if op.error?