Class: Google::Cloud::Retail::V2::GenerativeQuestionService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/retail/v2/generative_question_service/rest/client.rb

Overview

REST client for the GenerativeQuestionService service.

Service for managing LLM generated questions in search serving.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#catalog_path

Constructor Details

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

Create a new GenerativeQuestionService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Retail::V2::GenerativeQuestionService::Rest::Client.new

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

Yields:

  • (config) —

    Configure the GenerativeQuestionService client.

Yield Parameters:



127
128
129
130
131
132
133
134
135
136
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
 
# File 'lib/google/cloud/retail/v2/generative_question_service/rest/client.rb', line 127

def initialize
  # 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

  @generative_question_service_stub = ::Google::Cloud::Retail::V2::GenerativeQuestionService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @generative_question_service_stub.logger(stub: true)&.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::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @generative_question_service_stub.endpoint
    config.universe_domain = @generative_question_service_stub.universe_domain
    config.logger = @generative_question_service_stub.logger if config.respond_to? :logger=
  end
end

Instance Attribute Details

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

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

Returns:

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


182
183
184
 
# File 'lib/google/cloud/retail/v2/generative_question_service/rest/client.rb', line 182

def location_client
  @location_client
end

Class Method Details

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

Configure the GenerativeQuestionService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/google/cloud/retail/v2/generative_question_service/rest/client.rb', line 65

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Retail", "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
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#batch_update_generative_question_configs(request, options = nil) ⇒ ::Google::Cloud::Retail::V2::BatchUpdateGenerativeQuestionConfigsResponse #batch_update_generative_question_configs(parent: nil, requests: nil) ⇒ ::Google::Cloud::Retail::V2::BatchUpdateGenerativeQuestionConfigsResponse

Allows management of multiple questions.

Examples:

Basic example

require "google/cloud/retail/v2"

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

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

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

# The returned object is of type Google::Cloud::Retail::V2::BatchUpdateGenerativeQuestionConfigsResponse.
p result

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
 
# File 'lib/google/cloud/retail/v2/generative_question_service/rest/client.rb', line 569

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Retail::V2::BatchUpdateGenerativeQuestionConfigsRequest

  # 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
  call_metadata = @config.rpcs.batch_update_generative_question_configs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Retail::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.batch_update_generative_question_configs.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.batch_update_generative_question_configs.retry_policy

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

  @generative_question_service_stub.batch_update_generative_question_configs request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

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



97
98
99
100
 
# File 'lib/google/cloud/retail/v2/generative_question_service/rest/client.rb', line 97

def configure
  yield @config if block_given?
  @config
end

#get_generative_questions_feature_config(request, options = nil) ⇒ ::Google::Cloud::Retail::V2::GenerativeQuestionsFeatureConfig #get_generative_questions_feature_config(catalog: nil) ⇒ ::Google::Cloud::Retail::V2::GenerativeQuestionsFeatureConfig

Manages overal generative question feature state -- enables toggling feature on and off.

Examples:

Basic example

require "google/cloud/retail/v2"

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

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

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

# The returned object is of type Google::Cloud::Retail::V2::GenerativeQuestionsFeatureConfig.
p result

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
 
# File 'lib/google/cloud/retail/v2/generative_question_service/rest/client.rb', line 323

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Retail::V2::GetGenerativeQuestionsFeatureConfigRequest

  # 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
  call_metadata = @config.rpcs.get_generative_questions_feature_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Retail::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_generative_questions_feature_config.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_generative_questions_feature_config.retry_policy

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

  @generative_question_service_stub.get_generative_questions_feature_config request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_generative_question_configs(request, options = nil) ⇒ ::Google::Cloud::Retail::V2::ListGenerativeQuestionConfigsResponse #list_generative_question_configs(parent: nil) ⇒ ::Google::Cloud::Retail::V2::ListGenerativeQuestionConfigsResponse

Returns all questions for a given catalog.

Examples:

Basic example

require "google/cloud/retail/v2"

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

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

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

# The returned object is of type Google::Cloud::Retail::V2::ListGenerativeQuestionConfigsResponse.
p result

Overloads:

  • #list_generative_question_configs(request, options = nil) ⇒ ::Google::Cloud::Retail::V2::ListGenerativeQuestionConfigsResponse

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

    Parameters:

    • request (::Google::Cloud::Retail::V2::ListGenerativeQuestionConfigsRequest, ::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_generative_question_configs(parent: nil) ⇒ ::Google::Cloud::Retail::V2::ListGenerativeQuestionConfigsResponse

    Pass arguments to list_generative_question_configs 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 name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



402
403
404
405
406
407
408
409
410
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
 
# File 'lib/google/cloud/retail/v2/generative_question_service/rest/client.rb', line 402

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Retail::V2::ListGenerativeQuestionConfigsRequest

  # 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
  call_metadata = @config.rpcs.list_generative_question_configs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Retail::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_generative_question_configs.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_generative_question_configs.retry_policy

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

  @generative_question_service_stub.list_generative_question_configs request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


189
190
191
 
# File 'lib/google/cloud/retail/v2/generative_question_service/rest/client.rb', line 189

def logger
  @generative_question_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


107
108
109
 
# File 'lib/google/cloud/retail/v2/generative_question_service/rest/client.rb', line 107

def universe_domain
  @generative_question_service_stub.universe_domain
end

#update_generative_question_config(request, options = nil) ⇒ ::Google::Cloud::Retail::V2::GenerativeQuestionConfig #update_generative_question_config(generative_question_config: nil, update_mask: nil) ⇒ ::Google::Cloud::Retail::V2::GenerativeQuestionConfig

Allows management of individual questions.

Examples:

Basic example

require "google/cloud/retail/v2"

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

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

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

# The returned object is of type Google::Cloud::Retail::V2::GenerativeQuestionConfig.
p result

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call 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
 
# File 'lib/google/cloud/retail/v2/generative_question_service/rest/client.rb', line 488

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Retail::V2::UpdateGenerativeQuestionConfigRequest

  # 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
  call_metadata = @config.rpcs.update_generative_question_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Retail::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_generative_question_config.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_generative_question_config.retry_policy

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

  @generative_question_service_stub.update_generative_question_config request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_generative_questions_feature_config(request, options = nil) ⇒ ::Google::Cloud::Retail::V2::GenerativeQuestionsFeatureConfig #update_generative_questions_feature_config(generative_questions_feature_config: nil, update_mask: nil) ⇒ ::Google::Cloud::Retail::V2::GenerativeQuestionsFeatureConfig

Manages overal generative question feature state -- enables toggling feature on and off.

Examples:

Basic example

require "google/cloud/retail/v2"

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

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

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

# The returned object is of type Google::Cloud::Retail::V2::GenerativeQuestionsFeatureConfig.
p result

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
275
276
 
# File 'lib/google/cloud/retail/v2/generative_question_service/rest/client.rb', line 243

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Retail::V2::UpdateGenerativeQuestionsFeatureConfigRequest

  # 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
  call_metadata = @config.rpcs.update_generative_questions_feature_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Retail::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_generative_questions_feature_config.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_generative_questions_feature_config.retry_policy

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

  @generative_question_service_stub.update_generative_questions_feature_config request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end