Class: Google::Cloud::Retail::V2::ConversationalSearchService::Client

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

Overview

Client for the ConversationalSearchService service.

Service for retail conversational search.

This feature is only available for users who have Retail Conversational Search enabled. Enable Retail Conversational Search on Cloud Console before using this feature.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#branch_path

Constructor Details

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

Create a new ConversationalSearchService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the ConversationalSearchService client.

Yield Parameters:



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
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/google/cloud/retail/v2/conversational_search_service/client.rb', line 129

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/retail/v2/conversational_search_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

  @conversational_search_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Retail::V2::ConversationalSearchService::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
  )

  @conversational_search_service_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 = @conversational_search_service_stub.endpoint
    config.universe_domain = @conversational_search_service_stub.universe_domain
    config.logger = @conversational_search_service_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) 


193
194
195
 
# File 'lib/google/cloud/retail/v2/conversational_search_service/client.rb', line 193

def location_client
  @location_client
end

Class Method Details

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

Configure the ConversationalSearchService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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

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

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

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



99
100
101
102
 
# File 'lib/google/cloud/retail/v2/conversational_search_service/client.rb', line 99

def configure
  yield @config if block_given?
  @config
end

#conversational_search(request, options = nil) ⇒ ::Enumerable<::Google::Cloud::Retail::V2::ConversationalSearchResponse> #conversational_search(placement: nil, branch: nil, query: nil, page_categories: nil, conversation_id: nil, search_params: nil, visitor_id: nil, user_info: nil, conversational_filtering_spec: nil, user_labels: nil, safety_settings: nil) ⇒ ::Enumerable<::Google::Cloud::Retail::V2::ConversationalSearchResponse>

Performs a conversational search.

This feature is only available for users who have Conversational Search enabled.

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::ConversationalSearchService::Client.new

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

# Call the conversational_search method to start streaming.
output = client.conversational_search request

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

Overloads:

  • #conversational_search(request, options = nil) ⇒ ::Enumerable<::Google::Cloud::Retail::V2::ConversationalSearchResponse>

    Pass arguments to conversational_search via a request object, either of type Google::Cloud::Retail::V2::ConversationalSearchRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Retail::V2::ConversationalSearchRequest, ::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.

  • #conversational_search(placement: nil, branch: nil, query: nil, page_categories: nil, conversation_id: nil, search_params: nil, visitor_id: nil, user_info: nil, conversational_filtering_spec: nil, user_labels: nil, safety_settings: nil) ⇒ ::Enumerable<::Google::Cloud::Retail::V2::ConversationalSearchResponse>

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

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

      Required. The resource name of the search engine placement, such as projects/*/locations/global/catalogs/default_catalog/placements/default_search or projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config This field is used to identify the serving config name and the set of models that will be used to make the search.

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

      Required. The branch resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/0.

      Use "default_branch" as the branch ID or leave this field empty, to search products under the default branch.

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

      Optional. Raw search query to be searched for.

      If this field is empty, the request is considered a category browsing request.

    • page_categories (::Array<::String>) (defaults to: nil) —

      Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories;

      To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s).

      Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].

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

      Optional. This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResponse.conversation_id. For the initial request, this should be empty.

    • search_params (::Google::Cloud::Retail::V2::ConversationalSearchRequest::SearchParams, ::Hash) (defaults to: nil) —

      Optional. Search parameters.

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

      Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website.

      This should be the same identifier as UserEvent.visitor_id.

      The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

    • user_info (::Google::Cloud::Retail::V2::UserInfo, ::Hash) (defaults to: nil) —

      Optional. User information.

    • conversational_filtering_spec (::Google::Cloud::Retail::V2::ConversationalSearchRequest::ConversationalFilteringSpec, ::Hash) (defaults to: nil) —

      Optional. This field specifies all conversational filtering related parameters.

    • user_labels (::Hash{::String => ::String}) (defaults to: nil) —

      Optional. The user labels applied to a resource must meet the following requirements:

      • Each resource can have multiple labels, up to a maximum of 64.
      • Each label must be a key-value pair.
      • Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
      • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
      • The key portion of a label must be unique. However, you can use the same key with multiple resources.
      • Keys must start with a lowercase letter or international character.

      See Google Cloud Document for more details.

    • safety_settings (::Array<::Google::Cloud::Retail::V2::SafetySetting, ::Hash>) (defaults to: nil) —

      Optional. The safety settings to be applied to the generated content.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
363
364
365
366
367
368
369
 
# File 'lib/google/cloud/retail/v2/conversational_search_service/client.rb', line 330

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

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

  # 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.conversational_search.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::Retail::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.placement
    header_params["placement"] = request.placement
  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.conversational_search.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.conversational_search.retry_policy

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

  @conversational_search_service_stub.call_rpc :conversational_search, 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

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


200
201
202
 
# File 'lib/google/cloud/retail/v2/conversational_search_service/client.rb', line 200

def logger
  @conversational_search_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


109
110
111
 
# File 'lib/google/cloud/retail/v2/conversational_search_service/client.rb', line 109

def universe_domain
  @conversational_search_service_stub.universe_domain
end