Class: Google::Cloud::DiscoveryEngine::V1beta::RecommendRequest
- Inherits:
-
Object
- Object
- Google::Cloud::DiscoveryEngine::V1beta::RecommendRequest
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb
Overview
Request message for Recommend method.
Defined Under Namespace
Classes: ParamsEntry, UserLabelsEntry
Instance Attribute Summary collapse
-
#filter ⇒ ::String
Filter for restricting recommendation results with a length limit of 5,000 characters.
-
#page_size ⇒ ::Integer
Maximum number of results to return.
-
#params ⇒ ::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}
Additional domain specific parameters for the recommendations.
-
#serving_config ⇒ ::String
Required.
-
#user_event ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::UserEvent
Required.
-
#user_labels ⇒ ::Google::Protobuf::Map{::String => ::String}
The user labels applied to a resource must meet the following requirements:.
-
#validate_only ⇒ ::Boolean
Use validate only mode for this recommendation query.
Instance Attribute Details
#filter ⇒ ::String
Returns 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.
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 |
# File 'proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb', line 128 class RecommendRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Protobuf::Value] class ParamsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class UserLabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#page_size ⇒ ::Integer
Returns 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.
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 |
# File 'proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb', line 128 class RecommendRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Protobuf::Value] class ParamsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class UserLabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#params ⇒ ::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}
Returns 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.
-
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 |
# File 'proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb', line 128 class RecommendRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Protobuf::Value] class ParamsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class UserLabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#serving_config ⇒ ::String
Returns Required. Full resource name of the format:
projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*
Before you can request recommendations from your model, you must create at least one serving config for it.
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 |
# File 'proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb', line 128 class RecommendRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Protobuf::Value] class ParamsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class UserLabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#user_event ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::UserEvent
Returns Required. Context about the user, what they are looking at and what action they took to trigger the Recommend request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging.
Don't set UserEvent.user_pseudo_id or UserEvent.user_info.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.user_pseudo_id to a random unique ID and leave UserEvent.user_info.user_id unset.
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 |
# File 'proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb', line 128 class RecommendRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Protobuf::Value] class ParamsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class UserLabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#user_labels ⇒ ::Google::Protobuf::Map{::String => ::String}
Returns 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.
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 |
# File 'proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb', line 128 class RecommendRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Protobuf::Value] class ParamsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class UserLabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#validate_only ⇒ ::Boolean
Returns 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.
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 |
# File 'proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb', line 128 class RecommendRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Protobuf::Value] class ParamsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class UserLabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |