Class: Google::Cloud::DataQnA::V1alpha::QuestionService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/dataqna/v1alpha/question_service/client.rb

Overview

Client for the QuestionService service.

Service to interpret natural language queries. The service allows to create Question resources that are interpreted and are filled with one or more interpretations if the question could be interpreted. Once a Question resource is created and has at least one interpretation, an interpretation can be chosen for execution, which triggers a query to the backend (for BigQuery, it will create a job). Upon successful execution of that interpretation, backend specific information will be returned so that the client can retrieve the results from the backend.

The Question resources are named projects/*/locations/*/questions/*.

The Question resource has a singletion sub-resource UserFeedback named projects/*/locations/*/questions/*/userFeedback, which allows access to user feedback.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#location_path, #question_path, #user_feedback_path

Constructor Details

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

Create a new QuestionService client object.

Examples

To create a new QuestionService client with the default configuration:

client = ::Google::Cloud::DataQnA::V1alpha::QuestionService::Client.new

To create a new QuestionService client with a custom configuration:

client = ::Google::Cloud::DataQnA::V1alpha::QuestionService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the QuestionService client.

Yield Parameters:



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
 
# File 'lib/google/cloud/dataqna/v1alpha/question_service/client.rb', line 139

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/dataqna/v1alpha/question_service_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 scope and endpoint are unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.scope == Client.configure.scope &&
                           @config.endpoint == Client.configure.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

  @question_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::DataQnA::V1alpha::QuestionService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Class Method Details

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

Configure the QuestionService Client class.

See Configuration for a description of the configuration fields.

Example

To modify the configuration for all QuestionService clients:

::Google::Cloud::DataQnA::V1alpha::QuestionService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/google/cloud/dataqna/v1alpha/question_service/client.rb', line 71

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "DataQnA", "V1alpha"]
    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: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_question.timeout = 60.0

    default_config.rpcs.execute_question.timeout = 60.0

    default_config.rpcs.update_user_feedback.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

Configure the QuestionService 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:



114
115
116
117
 
# File 'lib/google/cloud/dataqna/v1alpha/question_service/client.rb', line 114

def configure
  yield @config if block_given?
  @config
end

#create_question(request, options = nil) ⇒ ::Google::Cloud::DataQnA::V1alpha::Question #create_question(parent: nil, question: nil) ⇒ ::Google::Cloud::DataQnA::V1alpha::Question

Creates a question.

Overloads:

  • #create_question(request, options = nil) ⇒ ::Google::Cloud::DataQnA::V1alpha::Question

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

    Parameters:

    • request (::Google::Cloud::DataQnA::V1alpha::CreateQuestionRequest, ::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_question(parent: nil, question: nil) ⇒ ::Google::Cloud::DataQnA::V1alpha::Question

    Pass arguments to create_question 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 project this data source reference belongs to. Example: projects/foo/locations/bar

    • question (::Google::Cloud::DataQnA::V1alpha::Question, ::Hash) (defaults to: nil) —

      Required. The question 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.



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/google/cloud/dataqna/v1alpha/question_service/client.rb', line 279

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataQnA::V1alpha::CreateQuestionRequest

  # 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_question.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::DataQnA::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  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_question.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_question.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

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

#execute_question(request, options = nil) ⇒ ::Google::Cloud::DataQnA::V1alpha::Question #execute_question(name: nil, interpretation_index: nil) ⇒ ::Google::Cloud::DataQnA::V1alpha::Question

Executes an interpretation.

Overloads:

  • #execute_question(request, options = nil) ⇒ ::Google::Cloud::DataQnA::V1alpha::Question

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

    Parameters:

    • request (::Google::Cloud::DataQnA::V1alpha::ExecuteQuestionRequest, ::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.

  • #execute_question(name: nil, interpretation_index: nil) ⇒ ::Google::Cloud::DataQnA::V1alpha::Question

    Pass arguments to execute_question 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 unique identifier for the question. Example: projects/foo/locations/bar/questions/1234

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

      Required. Index of the interpretation to execute.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



348
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
 
# File 'lib/google/cloud/dataqna/v1alpha/question_service/client.rb', line 348

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataQnA::V1alpha::ExecuteQuestionRequest

  # 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.execute_question.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::DataQnA::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  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.execute_question.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.execute_question.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

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

#get_question(request, options = nil) ⇒ ::Google::Cloud::DataQnA::V1alpha::Question #get_question(name: nil, read_mask: nil) ⇒ ::Google::Cloud::DataQnA::V1alpha::Question

Gets a previously created question.

Overloads:

  • #get_question(request, options = nil) ⇒ ::Google::Cloud::DataQnA::V1alpha::Question

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

    Parameters:

    • request (::Google::Cloud::DataQnA::V1alpha::GetQuestionRequest, ::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_question(name: nil, read_mask: nil) ⇒ ::Google::Cloud::DataQnA::V1alpha::Question

    Pass arguments to get_question 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 unique identifier for the question. Example: projects/foo/locations/bar/questions/1234

    • read_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      The list of fields to be retrieved.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/google/cloud/dataqna/v1alpha/question_service/client.rb', line 210

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataQnA::V1alpha::GetQuestionRequest

  # 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_question.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::DataQnA::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  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_question.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_question.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

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

#get_user_feedback(request, options = nil) ⇒ ::Google::Cloud::DataQnA::V1alpha::UserFeedback #get_user_feedback(name: nil) ⇒ ::Google::Cloud::DataQnA::V1alpha::UserFeedback

Gets previously created user feedback.

Overloads:

  • #get_user_feedback(request, options = nil) ⇒ ::Google::Cloud::DataQnA::V1alpha::UserFeedback

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

    Parameters:

    • request (::Google::Cloud::DataQnA::V1alpha::GetUserFeedbackRequest, ::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_user_feedback(name: nil) ⇒ ::Google::Cloud::DataQnA::V1alpha::UserFeedback

    Pass arguments to get_user_feedback 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 unique identifier for the user feedback. User feedback is a singleton resource on a Question. Example: projects/foo/locations/bar/questions/1234/userFeedback

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/google/cloud/dataqna/v1alpha/question_service/client.rb', line 416

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataQnA::V1alpha::GetUserFeedbackRequest

  # 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_user_feedback.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::DataQnA::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  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_user_feedback.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_user_feedback.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

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

#update_user_feedback(request, options = nil) ⇒ ::Google::Cloud::DataQnA::V1alpha::UserFeedback #update_user_feedback(user_feedback: nil, update_mask: nil) ⇒ ::Google::Cloud::DataQnA::V1alpha::UserFeedback

Updates user feedback. This creates user feedback if there was none before (upsert).

Overloads:

  • #update_user_feedback(request, options = nil) ⇒ ::Google::Cloud::DataQnA::V1alpha::UserFeedback

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

    Parameters:

    • request (::Google::Cloud::DataQnA::V1alpha::UpdateUserFeedbackRequest, ::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_user_feedback(user_feedback: nil, update_mask: nil) ⇒ ::Google::Cloud::DataQnA::V1alpha::UserFeedback

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

    • user_feedback (::Google::Cloud::DataQnA::V1alpha::UserFeedback, ::Hash) (defaults to: nil) —

      Required. The user feedback to update. This can be called even if there is no user feedback so far. The feedback's name field is used to identify the user feedback (and the corresponding question) to update.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      The list of fields to be updated.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/google/cloud/dataqna/v1alpha/question_service/client.rb', line 488

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataQnA::V1alpha::UpdateUserFeedbackRequest

  # 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_user_feedback.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::DataQnA::V1alpha::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "user_feedback.name" => request.user_feedback.name
  }
  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_user_feedback.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_user_feedback.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

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