Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::Sessions::Client (v1.1.1)

Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::Sessions::Client.

Client for the Sessions service.

A service used for session interactions.

For more information, see the API interactions guide.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the Sessions Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all Sessions clients
::Google::Cloud::Dialogflow::V2::Sessions::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the Sessions Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#detect_intent

def detect_intent(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::DetectIntentResponse
def detect_intent(session: nil, query_params: nil, query_input: nil, output_audio_config: nil, output_audio_config_mask: nil, input_audio: nil) -> ::Google::Cloud::Dialogflow::V2::DetectIntentResponse

Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries.

If you might use Agent Assist or other CCAI products now or in the future, consider using AnalyzeContent instead of DetectIntent. AnalyzeContent has additional functionality for Agent Assist and other CCAI products.

Note: Always use agent versions for production traffic. See Versions and environments.

Overloads 
def detect_intent(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::DetectIntentResponse
Pass arguments to detect_intent via a request object, either of type DetectIntentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dialogflow::V2::DetectIntentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def detect_intent(session: nil, query_params: nil, query_input: nil, output_audio_config: nil, output_audio_config_mask: nil, input_audio: nil) -> ::Google::Cloud::Dialogflow::V2::DetectIntentResponse
Pass arguments to detect_intent via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • session (::String) — Required. The name of the session this query is sent to. 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 (Environment ID might be referred to as environment name at some places). 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.

    For more information, see the API interactions guide.

    Note: Always use agent versions for production traffic. See Versions and environments.

  • query_params (::Google::Cloud::Dialogflow::V2::QueryParameters, ::Hash) — The parameters of this query.
  • query_input (::Google::Cloud::Dialogflow::V2::QueryInput, ::Hash) —

    Required. The input specification. It can be set to:

    1. an audio config which instructs the speech recognizer how to process the speech audio,

    2. a conversational query in the form of text, or

    3. an event that specifies which intent to trigger.

  • output_audio_config (::Google::Cloud::Dialogflow::V2::OutputAudioConfig, ::Hash) — Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated.
  • output_audio_config_mask (::Google::Protobuf::FieldMask, ::Hash) — Mask for output_audio_config indicating which settings in this request-level config should override speech synthesizer settings defined at agent-level.

    If unspecified or empty, output_audio_config replaces the agent-level config in its entirety.

  • input_audio (::String) — The natural language speech audio to be processed. This field should be populated iff query_input is set to an input audio config. A single request can contain up to 1 minute of speech audio data.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dialogflow/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dialogflow::V2::Sessions::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::V2::DetectIntentRequest.new

# Call the detect_intent method.
result = client.detect_intent request

# The returned object is of type Google::Cloud::Dialogflow::V2::DetectIntentResponse.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new Sessions client object.

Yields
  • (config) — Configure the Sessions client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Dialogflow::V2::Sessions::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Dialogflow::V2::Sessions::Client.new do |config|
  config.timeout = 10.0
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Client)

#streaming_detect_intent

def streaming_detect_intent(request, options = nil) { |response, operation| ... } -> ::Enumerable<::Google::Cloud::Dialogflow::V2::StreamingDetectIntentResponse>

Processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result. This method is only available via the gRPC API (not REST).

If you might use Agent Assist or other CCAI products now or in the future, consider using StreamingAnalyzeContent instead of StreamingDetectIntent. StreamingAnalyzeContent has additional functionality for Agent Assist and other CCAI products.

Note: Always use agent versions for production traffic. See Versions and environments.

Parameters
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/dialogflow/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dialogflow::V2::Sessions::Client.new

# Create an input stream.
input = Gapic::StreamInput.new

# Call the streaming_detect_intent method to start streaming.
output = client.streaming_detect_intent input

# Send requests on the stream. For each request object, set fields by
# passing keyword arguments. Be sure to close the stream when done.
input << Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest.new
input << Google::Cloud::Dialogflow::V2::StreamingDetectIntentRequest.new
input.close

# The returned object is a streamed enumerable yielding elements of type
# ::Google::Cloud::Dialogflow::V2::StreamingDetectIntentResponse
output.each do |current_response|
  p current_response
end

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)