Class: Google::Cloud::Dialogflow::V2::Participants::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/dialogflow/v2/participants/client.rb

Overview

Client for the Participants service.

Service for managing Participants.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#context_path, #conversation_path, #message_path, #participant_path, #phrase_set_path, #session_entity_type_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new Participants client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Dialogflow::V2::Participants::Client.new

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

Yields:

  • (config) —

    Configure the Participants client.

Yield Parameters:



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/google/cloud/dialogflow/v2/participants/client.rb', line 137

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/dialogflow/v2/participant_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @participants_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Dialogflow::V2::Participants::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @participants_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end

  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @participants_stub.endpoint
    config.universe_domain = @participants_stub.universe_domain
    config.logger = @participants_stub.logger if config.respond_to? :logger=
  end
end

Instance Attribute Details

#location_client ⇒ Google::Cloud::Location::Locations::Client (readonly)

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

Returns:

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


201
202
203
 
# File 'lib/google/cloud/dialogflow/v2/participants/client.rb', line 201

def location_client
  @location_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the Participants Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all Participants clients
::Google::Cloud::Dialogflow::V2::Participants::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/google/cloud/dialogflow/v2/participants/client.rb', line 63

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Dialogflow", "V2"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 60.0
    default_config.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.analyze_content.timeout = 220.0
    default_config.rpcs.analyze_content.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.streaming_analyze_content.timeout = 220.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#analyze_content(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::AnalyzeContentResponse #analyze_content(participant: nil, text_input: nil, event_input: nil, suggestion_input: nil, reply_audio_config: nil, query_params: nil, assist_query_params: nil, cx_parameters: nil, request_id: nil) ⇒ ::Google::Cloud::Dialogflow::V2::AnalyzeContentResponse

Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation.

Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments.

Examples:

Basic example

require "google/cloud/dialogflow/v2"

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

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

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

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

Overloads:

  • #analyze_content(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::AnalyzeContentResponse

    Pass arguments to analyze_content via a request object, either of type AnalyzeContentRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dialogflow::V2::AnalyzeContentRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #analyze_content(participant: nil, text_input: nil, event_input: nil, suggestion_input: nil, reply_audio_config: nil, query_params: nil, assist_query_params: nil, cx_parameters: nil, request_id: nil) ⇒ ::Google::Cloud::Dialogflow::V2::AnalyzeContentResponse

    Pass arguments to analyze_content 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:

    • participant (::String) (defaults to: nil) —

      Required. The name of the participant this text comes from. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

    • text_input (::Google::Cloud::Dialogflow::V2::TextInput, ::Hash) (defaults to: nil) —

      The natural language text to be processed.

    • event_input (::Google::Cloud::Dialogflow::V2::EventInput, ::Hash) (defaults to: nil) —

      An input event to send to Dialogflow.

    • suggestion_input (::Google::Cloud::Dialogflow::V2::SuggestionInput, ::Hash) (defaults to: nil) —

      An input representing the selection of a suggestion.

    • reply_audio_config (::Google::Cloud::Dialogflow::V2::OutputAudioConfig, ::Hash) (defaults to: nil) —

      Speech synthesis configuration. The speech synthesis settings for a virtual agent that may be configured for the associated conversation profile are not used when calling AnalyzeContent. If this configuration is not supplied, speech synthesis is disabled.

    • query_params (::Google::Cloud::Dialogflow::V2::QueryParameters, ::Hash) (defaults to: nil) —

      Parameters for a Dialogflow virtual-agent query.

    • assist_query_params (::Google::Cloud::Dialogflow::V2::AssistQueryParameters, ::Hash) (defaults to: nil) —

      Parameters for a human assist query.

    • cx_parameters (::Google::Protobuf::Struct, ::Hash) (defaults to: nil) —

      Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

      Note: this field should only be used if you are connecting to a Dialogflow CX agent.

    • request_id (::String) (defaults to: nil) —

      A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a request_id is provided.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'lib/google/cloud/dialogflow/v2/participants/client.rb', line 653

def analyze_content request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::AnalyzeContentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.analyze_content.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.participant
    header_params["participant"] = request.participant
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.analyze_content.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.analyze_content.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @participants_stub.call_rpc :analyze_content, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#configure {|config| ... } ⇒ Client::Configuration

Configure the Participants 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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



107
108
109
110
 
# File 'lib/google/cloud/dialogflow/v2/participants/client.rb', line 107

def configure
  yield @config if block_given?
  @config
end

#create_participant(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::Participant #create_participant(parent: nil, participant: nil) ⇒ ::Google::Cloud::Dialogflow::V2::Participant

Creates a new participant in a conversation.

Examples:

Basic example

require "google/cloud/dialogflow/v2"

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

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

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

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

Overloads:

  • #create_participant(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::Participant

    Pass arguments to create_participant via a request object, either of type CreateParticipantRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dialogflow::V2::CreateParticipantRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_participant(parent: nil, participant: nil) ⇒ ::Google::Cloud::Dialogflow::V2::Participant

    Pass arguments to create_participant 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:

    • parent (::String) (defaults to: nil) —

      Required. Resource identifier of the conversation adding the participant. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>.

    • participant (::Google::Cloud::Dialogflow::V2::Participant, ::Hash) (defaults to: nil) —

      Required. The participant to create.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/google/cloud/dialogflow/v2/participants/client.rb', line 262

def create_participant request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::CreateParticipantRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_participant.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_participant.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_participant.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @participants_stub.call_rpc :create_participant, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_participant(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::Participant #get_participant(name: nil) ⇒ ::Google::Cloud::Dialogflow::V2::Participant

Retrieves a conversation participant.

Examples:

Basic example

require "google/cloud/dialogflow/v2"

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

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

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

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

Overloads:

  • #get_participant(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::Participant

    Pass arguments to get_participant via a request object, either of type GetParticipantRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dialogflow::V2::GetParticipantRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_participant(name: nil) ⇒ ::Google::Cloud::Dialogflow::V2::Participant

    Pass arguments to get_participant 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:

    • name (::String) (defaults to: nil) —

      Required. The name of the participant. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/google/cloud/dialogflow/v2/participants/client.rb', line 349

def get_participant request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::GetParticipantRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_participant.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_participant.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_participant.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @participants_stub.call_rpc :get_participant, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_participants(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::Participant> #list_participants(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::Participant>

Returns the list of all participants in the specified conversation.

Examples:

Basic example

require "google/cloud/dialogflow/v2"

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

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dialogflow::V2::Participant.
  p item
end

Overloads:

  • #list_participants(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::Participant>

    Pass arguments to list_participants via a request object, either of type ListParticipantsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dialogflow::V2::ListParticipantsRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_participants(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::Participant>

    Pass arguments to list_participants 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:

    • parent (::String) (defaults to: nil) —

      Required. The conversation to list all participants from. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>.

    • page_size (::Integer) (defaults to: nil) —

      Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

    • page_token (::String) (defaults to: nil) —

      Optional. The next_page_token value returned from a previous list request.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/google/cloud/dialogflow/v2/participants/client.rb', line 445

def list_participants request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::ListParticipantsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_participants.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_participants.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_participants.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @participants_stub.call_rpc :list_participants, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @participants_stub, :list_participants, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


208
209
210
 
# File 'lib/google/cloud/dialogflow/v2/participants/client.rb', line 208

def logger
  @participants_stub.logger
end

#streaming_analyze_content(request, options = nil) {|response, operation| ... } ⇒ ::Enumerable<::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentResponse>

Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation. Note: This method is only available through the gRPC API (not REST).

The top-level message sent to the client by the server is StreamingAnalyzeContentResponse. Multiple response messages can be returned in order. The first one or more messages contain the recognition_result field. Each result represents a more complete transcript of what the user said. The next message contains the reply_text field and potentially the reply_audio field. The message can also contain the automated_agent_reply field.

Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments.

Examples:

Basic example

require "google/cloud/dialogflow/v2"

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

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

# Call the streaming_analyze_content method to start streaming.
output = client.streaming_analyze_content 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::StreamingAnalyzeContentRequest.new
input << Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest.new
input.close

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

Parameters:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
 
# File 'lib/google/cloud/dialogflow/v2/participants/client.rb', line 748

def streaming_analyze_content request, options = nil
  unless request.is_a? ::Enumerable
    raise ::ArgumentError, "request must be an Enumerable" unless request.respond_to? :to_enum
    request = request.to_enum
  end

  request = request.lazy.map do |req|
    ::Gapic::Protobuf.coerce req, to: ::Google::Cloud::Dialogflow::V2::StreamingAnalyzeContentRequest
  end

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.streaming_analyze_content.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.streaming_analyze_content.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.streaming_analyze_content.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @participants_stub.call_rpc :streaming_analyze_content, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#suggest_articles(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::SuggestArticlesResponse #suggest_articles(parent: nil, latest_message: nil, context_size: nil, assist_query_params: nil) ⇒ ::Google::Cloud::Dialogflow::V2::SuggestArticlesResponse

Gets suggested articles for a participant based on specific historical messages.

Examples:

Basic example

require "google/cloud/dialogflow/v2"

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

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

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

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

Overloads:

  • #suggest_articles(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::SuggestArticlesResponse

    Pass arguments to suggest_articles via a request object, either of type SuggestArticlesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dialogflow::V2::SuggestArticlesRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #suggest_articles(parent: nil, latest_message: nil, context_size: nil, assist_query_params: nil) ⇒ ::Google::Cloud::Dialogflow::V2::SuggestArticlesResponse

    Pass arguments to suggest_articles 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:

    • parent (::String) (defaults to: nil) —

      Required. The name of the participant to fetch suggestion for. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

    • latest_message (::String) (defaults to: nil) —

      Optional. The name of the latest conversation message to compile suggestion for. If empty, it will be the latest message of the conversation.

      Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>.

    • context_size (::Integer) (defaults to: nil) —

      Optional. Max number of messages prior to and including latest_message to use as context when compiling the suggestion. By default 20 and at most 50.

    • assist_query_params (::Google::Cloud::Dialogflow::V2::AssistQueryParameters, ::Hash) (defaults to: nil) —

      Parameters for a human assist query.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
 
# File 'lib/google/cloud/dialogflow/v2/participants/client.rb', line 846

def suggest_articles request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::SuggestArticlesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.suggest_articles.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.suggest_articles.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.suggest_articles.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @participants_stub.call_rpc :suggest_articles, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#suggest_faq_answers(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::SuggestFaqAnswersResponse #suggest_faq_answers(parent: nil, latest_message: nil, context_size: nil, assist_query_params: nil) ⇒ ::Google::Cloud::Dialogflow::V2::SuggestFaqAnswersResponse

Gets suggested faq answers for a participant based on specific historical messages.

Examples:

Basic example

require "google/cloud/dialogflow/v2"

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

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

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

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

Overloads:

  • #suggest_faq_answers(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::SuggestFaqAnswersResponse

    Pass arguments to suggest_faq_answers via a request object, either of type SuggestFaqAnswersRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dialogflow::V2::SuggestFaqAnswersRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #suggest_faq_answers(parent: nil, latest_message: nil, context_size: nil, assist_query_params: nil) ⇒ ::Google::Cloud::Dialogflow::V2::SuggestFaqAnswersResponse

    Pass arguments to suggest_faq_answers 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:

    • parent (::String) (defaults to: nil) —

      Required. The name of the participant to fetch suggestion for. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

    • latest_message (::String) (defaults to: nil) —

      Optional. The name of the latest conversation message to compile suggestion for. If empty, it will be the latest message of the conversation.

      Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>.

    • context_size (::Integer) (defaults to: nil) —

      Optional. Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. By default 20 and at most 50.

    • assist_query_params (::Google::Cloud::Dialogflow::V2::AssistQueryParameters, ::Hash) (defaults to: nil) —

      Parameters for a human assist query.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
 
# File 'lib/google/cloud/dialogflow/v2/participants/client.rb', line 946

def suggest_faq_answers request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::SuggestFaqAnswersRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.suggest_faq_answers.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.suggest_faq_answers.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.suggest_faq_answers.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @participants_stub.call_rpc :suggest_faq_answers, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#suggest_knowledge_assist(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistResponse #suggest_knowledge_assist(parent: nil, latest_message: nil, context_size: nil, previous_suggested_query: nil) ⇒ ::Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistResponse

Gets knowledge assist suggestions based on historical messages.

Examples:

Basic example

require "google/cloud/dialogflow/v2"

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

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

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

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

Overloads:

  • #suggest_knowledge_assist(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistResponse

    Pass arguments to suggest_knowledge_assist via a request object, either of type SuggestKnowledgeAssistRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #suggest_knowledge_assist(parent: nil, latest_message: nil, context_size: nil, previous_suggested_query: nil) ⇒ ::Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistResponse

    Pass arguments to suggest_knowledge_assist 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:

    • parent (::String) (defaults to: nil) —

      Required. The name of the participant to fetch suggestions for. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

    • latest_message (::String) (defaults to: nil) —

      Optional. The name of the latest conversation message to compile suggestions for. If empty, it will be the latest message of the conversation. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>.

    • context_size (::Integer) (defaults to: nil) —

      Optional. Max number of messages prior to and including latest_message to use as context when compiling the suggestion. The context size is by default 100 and at most 100.

    • previous_suggested_query (::String) (defaults to: nil) —

      Optional. The previously suggested query for the given conversation. This helps identify whether the next suggestion we generate is resonably different from the previous one. This is useful to avoid similar suggestions within the conversation.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
 
# File 'lib/google/cloud/dialogflow/v2/participants/client.rb', line 1150

def suggest_knowledge_assist request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::SuggestKnowledgeAssistRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.suggest_knowledge_assist.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.suggest_knowledge_assist.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.suggest_knowledge_assist.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @participants_stub.call_rpc :suggest_knowledge_assist, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#suggest_smart_replies(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::SuggestSmartRepliesResponse #suggest_smart_replies(parent: nil, current_text_input: nil, latest_message: nil, context_size: nil) ⇒ ::Google::Cloud::Dialogflow::V2::SuggestSmartRepliesResponse

Gets smart replies for a participant based on specific historical messages.

Examples:

Basic example

require "google/cloud/dialogflow/v2"

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

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

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

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

Overloads:

  • #suggest_smart_replies(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::SuggestSmartRepliesResponse

    Pass arguments to suggest_smart_replies via a request object, either of type SuggestSmartRepliesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dialogflow::V2::SuggestSmartRepliesRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #suggest_smart_replies(parent: nil, current_text_input: nil, latest_message: nil, context_size: nil) ⇒ ::Google::Cloud::Dialogflow::V2::SuggestSmartRepliesResponse

    Pass arguments to suggest_smart_replies 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:

    • parent (::String) (defaults to: nil) —

      Required. The name of the participant to fetch suggestion for. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

    • current_text_input (::Google::Cloud::Dialogflow::V2::TextInput, ::Hash) (defaults to: nil) —

      The current natural language text segment to compile suggestion for. This provides a way for user to get follow up smart reply suggestion after a smart reply selection, without sending a text message.

    • latest_message (::String) (defaults to: nil) —

      The name of the latest conversation message to compile suggestion for. If empty, it will be the latest message of the conversation.

      Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>.

    • context_size (::Integer) (defaults to: nil) —

      Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. By default 20 and at most 50.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
 
# File 'lib/google/cloud/dialogflow/v2/participants/client.rb', line 1048

def suggest_smart_replies request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::SuggestSmartRepliesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.suggest_smart_replies.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.suggest_smart_replies.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.suggest_smart_replies.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @participants_stub.call_rpc :suggest_smart_replies, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


117
118
119
 
# File 'lib/google/cloud/dialogflow/v2/participants/client.rb', line 117

def universe_domain
  @participants_stub.universe_domain
end

#update_participant(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::Participant #update_participant(participant: nil, update_mask: nil) ⇒ ::Google::Cloud::Dialogflow::V2::Participant

Updates the specified participant.

Examples:

Basic example

require "google/cloud/dialogflow/v2"

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

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

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

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

Overloads:

  • #update_participant(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::Participant

    Pass arguments to update_participant via a request object, either of type UpdateParticipantRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dialogflow::V2::UpdateParticipantRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_participant(participant: nil, update_mask: nil) ⇒ ::Google::Cloud::Dialogflow::V2::Participant

    Pass arguments to update_participant 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:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
 
# File 'lib/google/cloud/dialogflow/v2/participants/client.rb', line 534

def update_participant request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::UpdateParticipantRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_participant.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.participant&.name
    header_params["participant.name"] = request.participant.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_participant.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_participant.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @participants_stub.call_rpc :update_participant, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end