Class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResult

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/retail_v2alpha/classes.rb,
lib/google/apis/retail_v2alpha/representations.rb,
lib/google/apis/retail_v2alpha/representations.rb

Overview

Resource that represents completion results.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResult

Returns a new instance of GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResult.



2376
2377
2378
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2376

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#attributesHash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>

Custom attributes for the suggestion term. * For "user-data", the attributes are additional custom attributes ingested through BigQuery. * For "cloud- retail", the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly. Corresponds to the JSON property attributes



2354
2355
2356
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2354

def attributes
  @attributes
end

#facetsArray<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseFacet>

Facet information for the suggestion term. Gives the number of items resulting from a search with this suggestion term for each facet. This is an experimental feature for limited customers. If you want to receive this facet information, reach out to the Retail support team. Corresponds to the JSON property facets



2362
2363
2364
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2362

def facets
  @facets
end

#suggestionString

The suggestion for the query. Corresponds to the JSON property suggestion

Returns:

  • (String)


2367
2368
2369
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2367

def suggestion
  @suggestion
end

#total_product_countFixnum

Total number of products associated with a search with this suggestion. This is an experimental feature for limited customers. If you want to receive this product count information, reach out to the Retail support team. Corresponds to the JSON property totalProductCount

Returns:

  • (Fixnum)


2374
2375
2376
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2374

def total_product_count
  @total_product_count
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2381
2382
2383
2384
2385
2386
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2381

def update!(**args)
  @attributes = args[:attributes] if args.key?(:attributes)
  @facets = args[:facets] if args.key?(:facets)
  @suggestion = args[:suggestion] if args.key?(:suggestion)
  @total_product_count = args[:total_product_count] if args.key?(:total_product_count)
end