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.
1158 1159 1160 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1158 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 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
1101 1102 1103 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1101 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
1109 1110 1111 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1109 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. Corresponds to the JSON propertyparams
1126 1127 1128 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1126 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
1132 1133 1134 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1132 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
1147 1148 1149 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1147 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
1155 1156 1157 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1155 def validate_only @validate_only end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1163 1164 1165 1166 1167 1168 1169 1170 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1163 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 |