Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/discoveryengine_v1alpha/classes.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb
Overview
Request message for Recommend method.
Instance Attribute Summary collapse
-
#filter ⇒ String
Filter for restricting recommendation results with a length limit of 5,000 characters.
-
#page_size ⇒ Fixnum
Maximum number of results to return.
-
#params ⇒ Hash<String,Object>
Additional domain specific parameters for the recommendations.
-
#user_event ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent
UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.
-
#user_labels ⇒ Hash<String,String>
The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.
-
#validate_only ⇒ Boolean
(also: #validate_only?)
Use validate only mode for this recommendation query.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaRecommendRequest
constructor
A new instance of GoogleCloudDiscoveryengineV1alphaRecommendRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaRecommendRequest
Returns a new instance of GoogleCloudDiscoveryengineV1alphaRecommendRequest.
2990 2991 2992 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2990 def initialize(**args) update!(**args) end |
Instance Attribute Details
#filter ⇒ String
Filter for restricting recommendation results with a length limit of 5,000
characters. Currently, only filter expressions on the filter_tags
attribute
is supported. Examples: * (filter_tags: ANY("Red", "Blue") OR filter_tags:
ANY("Hot", "Cold"))
* (filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags:
ANY("Green"))
If attributeFilteringSyntax
is set to true under the params
field, then attribute-based expressions are expected instead of the above
described tag-based syntax. Examples: * (launguage: ANY("en", "es")) AND NOT (
categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es"))
OR (categories: ANY("Movie")) If your filter blocks all results, the API will
return generic (unfiltered) popular Documents. If you only want results
strictly matching the filters, set strictFiltering
to True in
RecommendRequest.params to receive empty results instead. Note that the API
will never return Documents with storageStatus
of EXPIRED
or DELETED
regardless of filter choices.
Corresponds to the JSON property filter
2931 2932 2933 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2931 def filter @filter end |
#page_size ⇒ Fixnum
Maximum number of results to return. Set this property to the number of
recommendation results needed. If zero, the service will choose a reasonable
default. The maximum allowed value is 100. Values above 100 will be coerced to
100.
Corresponds to the JSON property pageSize
2939 2940 2941 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2939 def page_size @page_size end |
#params ⇒ Hash<String,Object>
Additional domain specific parameters for the recommendations. Allowed values:
returnDocument
: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document. *returnScore
: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse. RecommendationResult.metadata. The given 'score' indicates the probability of a Document conversion given the user's context and history. *strictFiltering
: Boolean. True by default. If set to false, the service will return generic ( unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. *diversityLevel
: String. Default empty. If set to be non-empty, then it needs to be one of: *no-diversity
*low-diversity
*medium-diversity
*high-diversity
*auto-diversity
This gives request- level control and adjusts recommendation results based on Document category. *attributeFilteringSyntax
: Boolean. False by default. If set to true, thefilter
field is interpreted according to the new, attribute-based syntax. Corresponds to the JSON propertyparams
2958 2959 2960 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2958 def params @params end |
#user_event ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent
UserEvent captures all metadata information Discovery Engine API needs to know
about how end users interact with customers' website.
Corresponds to the JSON property userEvent
2964 2965 2966 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2964 def user_event @user_event end |
#user_labels ⇒ Hash<String,String>
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 Requirements for labels for more details.
Corresponds to the JSON property userLabels
2979 2980 2981 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2979 def user_labels @user_labels end |
#validate_only ⇒ Boolean Also known as: validate_only?
Use validate only mode for this recommendation query. If set to true, a fake
model will be used that returns arbitrary Document IDs. Note that the validate
only mode should only be used for testing the API, or if the model is not
ready.
Corresponds to the JSON property validateOnly
2987 2988 2989 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2987 def validate_only @validate_only end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2995 2996 2997 2998 2999 3000 3001 3002 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2995 def update!(**args) @filter = args[:filter] if args.key?(:filter) @page_size = args[:page_size] if args.key?(:page_size) @params = args[:params] if args.key?(:params) @user_event = args[:user_event] if args.key?(:user_event) @user_labels = args[:user_labels] if args.key?(:user_labels) @validate_only = args[:validate_only] if args.key?(:validate_only) end |