lib/google/cloud/dialogflow/v2/contexts_client.rb in google-cloud-dialogflow-0.2.1 vs lib/google/cloud/dialogflow/v2/contexts_client.rb in google-cloud-dialogflow-0.2.2
- old
+ new
@@ -41,13 +41,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).
#
# @!attribute [r] contexts_stub
@@ -258,11 +258,11 @@
# Returns the list of all contexts in the specified session.
#
# @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>`.
# @param page_size [Integer]
# The maximum number of resources contained in the underlying API
# response. If page streaming is performed per-resource, this
# parameter does not affect the return value. If page streaming is
# performed per-page, this determines the maximum number of
@@ -313,11 +313,11 @@
# Retrieves the specified context.
#
# @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>`.
# @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 [Google::Cloud::Dialogflow::V2::Context]
@@ -344,11 +344,11 @@
# Creates a context.
#
# @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>`.
# @param context [Google::Cloud::Dialogflow::V2::Context | Hash]
# Required. The context to create.
# A hash of the same form as `Google::Cloud::Dialogflow::V2::Context`
# can also be provided.
# @param options [Google::Gax::CallOptions]
@@ -363,11 +363,11 @@
# require "google/cloud/dialogflow"
#
# contexts_client = Google::Cloud::Dialogflow::Contexts.new(version: :v2)
# formatted_parent = Google::Cloud::Dialogflow::V2::ContextsClient.session_path("[PROJECT]", "[SESSION]")
#
- # # TODO: Initialize +context+:
+ # # TODO: Initialize `context`:
# context = {}
# response = contexts_client.create_context(formatted_parent, context)
def create_context \
parent,
@@ -403,11 +403,11 @@
# @example
# require "google/cloud/dialogflow"
#
# contexts_client = Google::Cloud::Dialogflow::Contexts.new(version: :v2)
#
- # # TODO: Initialize +context+:
+ # # TODO: Initialize `context`:
# context = {}
# response = contexts_client.update_context(context)
def update_context \
context,
@@ -424,11 +424,11 @@
# Deletes the specified context.
#
# @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>`.
# @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 []
@@ -455,10 +455,10 @@
# Deletes all active contexts in the specified session.
#
# @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>`.
# @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 []