class Google::Cloud::DataQnA::V1alpha::QuestionService::Client

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.

Attributes

question_service_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the QuestionService Client class.

See {::Google::Cloud::DataQnA::V1alpha::QuestionService::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all QuestionService clients
::Google::Cloud::DataQnA::V1alpha::QuestionService::Client.configure do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/dataqna/v1alpha/question_service/client.rb, line 70
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
new() { |config| ... } click to toggle source

Create a new QuestionService client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::DataQnA::V1alpha::QuestionService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::DataQnA::V1alpha::QuestionService::Client.new do |config|
  config.timeout = 10.0
end

@yield [config] Configure the QuestionService client. @yieldparam config [Client::Configuration]

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

Public Instance Methods

configure() { |config| ... } click to toggle source

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 {Client.configure}.

See {::Google::Cloud::DataQnA::V1alpha::QuestionService::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/dataqna/v1alpha/question_service/client.rb, line 113
def configure
  yield @config if block_given?
  @config
end
create_question(request, options = nil) { |response, operation| ... } click to toggle source

Creates a question.

@overload create_question(request, options = nil)

Pass arguments to `create_question` via a request object, either of type
{::Google::Cloud::DataQnA::V1alpha::CreateQuestionRequest} or an equivalent Hash.

@param 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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload create_question(parent: nil, question: nil)

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).

@param parent [::String]
  Required. The name of the project this data source reference belongs to.
  Example: `projects/foo/locations/bar`
@param question [::Google::Cloud::DataQnA::V1alpha::Question, ::Hash]
  Required. The question to create.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::DataQnA::V1alpha::Question] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::DataQnA::V1alpha::Question]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dataqna/v1alpha/question_service/client.rb, line 275
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 timeout:      @config.timeout,
                         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) { |response, operation| ... } click to toggle source

Executes an interpretation.

@overload execute_question(request, options = nil)

Pass arguments to `execute_question` via a request object, either of type
{::Google::Cloud::DataQnA::V1alpha::ExecuteQuestionRequest} or an equivalent Hash.

@param 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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload execute_question(name: nil, interpretation_index: nil)

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).

@param name [::String]
  Required. The unique identifier for the question.
  Example: `projects/foo/locations/bar/questions/1234`
@param interpretation_index [::Integer]
  Required. Index of the interpretation to execute.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::DataQnA::V1alpha::Question] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::DataQnA::V1alpha::Question]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dataqna/v1alpha/question_service/client.rb, line 346
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 timeout:      @config.timeout,
                         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) { |response, operation| ... } click to toggle source

Gets a previously created question.

@overload get_question(request, options = nil)

Pass arguments to `get_question` via a request object, either of type
{::Google::Cloud::DataQnA::V1alpha::GetQuestionRequest} or an equivalent Hash.

@param 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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload get_question(name: nil, read_mask: nil)

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).

@param name [::String]
  Required. The unique identifier for the question.
  Example: `projects/foo/locations/bar/questions/1234`
@param read_mask [::Google::Protobuf::FieldMask, ::Hash]
  The list of fields to be retrieved.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::DataQnA::V1alpha::Question] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::DataQnA::V1alpha::Question]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dataqna/v1alpha/question_service/client.rb, line 204
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 timeout:      @config.timeout,
                         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) { |response, operation| ... } click to toggle source

Gets previously created user feedback.

@overload get_user_feedback(request, options = nil)

Pass arguments to `get_user_feedback` via a request object, either of type
{::Google::Cloud::DataQnA::V1alpha::GetUserFeedbackRequest} or an equivalent Hash.

@param 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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload get_user_feedback(name: nil)

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).

@param name [::String]
  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`

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::DataQnA::V1alpha::UserFeedback] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::DataQnA::V1alpha::UserFeedback]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# 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 timeout:      @config.timeout,
                         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) { |response, operation| ... } click to toggle source

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

@overload update_user_feedback(request, options = nil)

Pass arguments to `update_user_feedback` via a request object, either of type
{::Google::Cloud::DataQnA::V1alpha::UpdateUserFeedbackRequest} or an equivalent Hash.

@param 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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload update_user_feedback(user_feedback: nil, update_mask: nil)

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).

@param user_feedback [::Google::Cloud::DataQnA::V1alpha::UserFeedback, ::Hash]
  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.
@param update_mask [::Google::Protobuf::FieldMask, ::Hash]
  The list of fields to be updated.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::DataQnA::V1alpha::UserFeedback] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::DataQnA::V1alpha::UserFeedback]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dataqna/v1alpha/question_service/client.rb, line 490
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 timeout:      @config.timeout,
                         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