public interface RecommendRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsParams(String key)
public abstract boolean containsParams(String key)Additional domain specific parameters for the recommendations. Allowed values:
returnDocument: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.results.document.returnScore: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.results.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.
map<string, .google.protobuf.Value> params = 6;
| Name | Description |
| key | String |
| Type | Description |
| boolean |
getFilter()
public abstract String getFilter() 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
strictFilteringto 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.
string filter = 4;
| Type | Description |
| String | The filter. |
getFilterBytes()
public abstract ByteString getFilterBytes() 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
strictFilteringto 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.
string filter = 4;
| Type | Description |
| ByteString | The bytes for filter. |
getPageSize()
public abstract int getPageSize()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.
int32 page_size = 3;
| Type | Description |
| int | The pageSize. |
getParams()
public abstract Map<String,Value> getParams()Use #getParamsMap() instead.
| Type | Description |
| Map<String,Value> |
getParamsCount()
public abstract int getParamsCount()Additional domain specific parameters for the recommendations. Allowed values:
returnDocument: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.results.document.returnScore: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.results.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.
map<string, .google.protobuf.Value> params = 6;
| Type | Description |
| int |
getParamsMap()
public abstract Map<String,Value> getParamsMap()Additional domain specific parameters for the recommendations. Allowed values:
returnDocument: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.results.document.returnScore: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.results.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.
map<string, .google.protobuf.Value> params = 6;
| Type | Description |
| Map<String,Value> |
getParamsOrDefault(String key, Value defaultValue)
public abstract Value getParamsOrDefault(String key, Value defaultValue)Additional domain specific parameters for the recommendations. Allowed values:
returnDocument: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.results.document.returnScore: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.results.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.
map<string, .google.protobuf.Value> params = 6;
| Name | Description |
| key | String |
| defaultValue | Value |
| Type | Description |
| Value |
getParamsOrThrow(String key)
public abstract Value getParamsOrThrow(String key)Additional domain specific parameters for the recommendations. Allowed values:
returnDocument: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.results.document.returnScore: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.results.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.
map<string, .google.protobuf.Value> params = 6;
| Name | Description |
| key | String |
| Type | Description |
| Value |
getServingConfig()
public abstract String getServingConfig()Required. Full resource name of the format: projects/*/locations/global/dataStores/*/servingConfigs/* Before you can request recommendations from your model, you must create at least one serving config for it.
string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Type | Description |
| String | The servingConfig. |
getServingConfigBytes()
public abstract ByteString getServingConfigBytes()Required. Full resource name of the format: projects/*/locations/global/dataStores/*/servingConfigs/* Before you can request recommendations from your model, you must create at least one serving config for it.
string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Type | Description |
| ByteString | The bytes for servingConfig. |
getUserEvent()
public abstract UserEvent getUserEvent()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.
.google.cloud.discoveryengine.v1beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| UserEvent | The userEvent. |
getUserEventOrBuilder()
public abstract UserEventOrBuilder getUserEventOrBuilder()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.
.google.cloud.discoveryengine.v1beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| UserEventOrBuilder |
getValidateOnly()
public abstract boolean getValidateOnly()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.
bool validate_only = 5;
| Type | Description |
| boolean | The validateOnly. |
hasUserEvent()
public abstract boolean hasUserEvent()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.
.google.cloud.discoveryengine.v1beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| boolean | Whether the userEvent field is set. |