Class: Google::Cloud::DataQnA::V1alpha::QuestionService::Client
- Inherits:
-
Object
- Object
- Google::Cloud::DataQnA::V1alpha::QuestionService::Client
- 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
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the QuestionService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the QuestionService Client instance.
-
#create_question(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::DataQnA::V1alpha::Question
Creates a question.
-
#execute_question(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::DataQnA::V1alpha::Question
Executes an interpretation.
-
#get_question(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::DataQnA::V1alpha::Question
Gets a previously created question.
-
#get_user_feedback(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::DataQnA::V1alpha::UserFeedback
Gets previously created user feedback.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new QuestionService client object.
-
#universe_domain ⇒ String
The effective universe domain.
-
#update_user_feedback(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::DataQnA::V1alpha::UserFeedback
Updates user feedback.
Methods included from Paths
#location_path, #question_path, #user_feedback_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new QuestionService client object.
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 |
# File 'lib/google/cloud/dataqna/v1alpha/question_service/client.rb', line 146 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 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 @question_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::DataQnA::V1alpha::QuestionService::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 ) end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the QuestionService Client class.
See Configuration for a description of the configuration fields.
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 98 99 |
# File 'lib/google/cloud/dataqna/v1alpha/question_service/client.rb', line 73 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.
116 117 118 119 |
# File 'lib/google/cloud/dataqna/v1alpha/question_service/client.rb', line 116 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.
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 |
# File 'lib/google/cloud/dataqna/v1alpha/question_service/client.rb', line 323 def create_question request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.create_question..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.create_question.timeout, metadata: , retry_policy: @config.rpcs.create_question.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @question_service_stub.call_rpc :create_question, request, 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.
411 412 413 414 415 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 |
# File 'lib/google/cloud/dataqna/v1alpha/question_service/client.rb', line 411 def execute_question request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.execute_question..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.execute_question.timeout, metadata: , retry_policy: @config.rpcs.execute_question.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @question_service_stub.call_rpc :execute_question, request, 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.
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 |
# File 'lib/google/cloud/dataqna/v1alpha/question_service/client.rb', line 235 def get_question request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_question..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_question.timeout, metadata: , retry_policy: @config.rpcs.get_question.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @question_service_stub.call_rpc :get_question, request, 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.
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 524 525 526 527 528 529 530 531 532 533 534 535 536 537 |
# File 'lib/google/cloud/dataqna/v1alpha/question_service/client.rb', line 498 def get_user_feedback request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_user_feedback..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_user_feedback.timeout, metadata: , retry_policy: @config.rpcs.get_user_feedback.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @question_service_stub.call_rpc :get_user_feedback, request, 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 |
#universe_domain ⇒ String
The effective universe domain
126 127 128 |
# File 'lib/google/cloud/dataqna/v1alpha/question_service/client.rb', line 126 def universe_domain @question_service_stub.universe_domain 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).
589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 |
# File 'lib/google/cloud/dataqna/v1alpha/question_service/client.rb', line 589 def update_user_feedback request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.update_user_feedback..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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 [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.user_feedback&.name header_params["user_feedback.name"] = request.user_feedback.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.update_user_feedback.timeout, metadata: , retry_policy: @config.rpcs.update_user_feedback.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @question_service_stub.call_rpc :update_user_feedback, request, 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 |