public final class RecommendRequest extends GeneratedMessageV3 implements RecommendRequestOrBuilder
Request message for Recommend method.
Protobuf type google.cloud.discoveryengine.v1beta.RecommendRequest
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PARAMS_FIELD_NUMBER
public static final int PARAMS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SERVING_CONFIG_FIELD_NUMBER
public static final int SERVING_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
USER_EVENT_FIELD_NUMBER
public static final int USER_EVENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
USER_LABELS_FIELD_NUMBER
public static final int USER_LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
VALIDATE_ONLY_FIELD_NUMBER
public static final int VALIDATE_ONLY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static RecommendRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static RecommendRequest.Builder newBuilder()
newBuilder(RecommendRequest prototype)
public static RecommendRequest.Builder newBuilder(RecommendRequest prototype)
public static RecommendRequest parseDelimitedFrom(InputStream input)
public static RecommendRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static RecommendRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RecommendRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static RecommendRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RecommendRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RecommendRequest parseFrom(CodedInputStream input)
public static RecommendRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RecommendRequest parseFrom(InputStream input)
public static RecommendRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static RecommendRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RecommendRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<RecommendRequest> parser()
Methods
containsParams(String key)
public 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.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-diversitylow-diversitymedium-diversityhigh-diversityauto-diversity
This gives request-level control and adjusts recommendation results
based on Document category.
map<string, .google.protobuf.Value> params = 6;
| Parameter |
|---|
| Name | Description |
key | String
|
containsUserLabels(String key)
public boolean containsUserLabels(String key)
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.
map<string, string> user_labels = 8;
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public RecommendRequest getDefaultInstanceForType()
getFilter()
public 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 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.
string filter = 4;
| Returns |
|---|
| Type | Description |
String | The filter.
|
getFilterBytes()
public 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 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.
string filter = 4;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for filter.
|
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;
| Returns |
|---|
| Type | Description |
int | The pageSize.
|
getParams()
public Map<String,Value> getParams()
getParamsCount()
public 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.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-diversitylow-diversitymedium-diversityhigh-diversityauto-diversity
This gives request-level control and adjusts recommendation results
based on Document category.
map<string, .google.protobuf.Value> params = 6;
| Returns |
|---|
| Type | Description |
int | |
getParamsMap()
public 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.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-diversitylow-diversitymedium-diversityhigh-diversityauto-diversity
This gives request-level control and adjusts recommendation results
based on Document category.
map<string, .google.protobuf.Value> params = 6;
getParamsOrDefault(String key, Value defaultValue)
public 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.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-diversitylow-diversitymedium-diversityhigh-diversityauto-diversity
This gives request-level control and adjusts recommendation results
based on Document category.
map<string, .google.protobuf.Value> params = 6;
| Returns |
|---|
| Type | Description |
Value | |
getParamsOrThrow(String key)
public 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.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-diversitylow-diversitymedium-diversityhigh-diversityauto-diversity
This gives request-level control and adjusts recommendation results
based on Document category.
map<string, .google.protobuf.Value> params = 6;
| Parameter |
|---|
| Name | Description |
key | String
|
| Returns |
|---|
| Type | Description |
Value | |
getParserForType()
public Parser<RecommendRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getServingConfig()
public String getServingConfig()
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.
string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
String | The servingConfig.
|
getServingConfigBytes()
public ByteString getServingConfigBytes()
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.
string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
ByteString | The bytes for servingConfig.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getUserEvent()
public 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];
| Returns |
|---|
| Type | Description |
UserEvent | The userEvent.
|
getUserEventOrBuilder()
public 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];
getUserLabels()
public Map<String,String> getUserLabels()
getUserLabelsCount()
public int getUserLabelsCount()
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.
map<string, string> user_labels = 8;
| Returns |
|---|
| Type | Description |
int | |
getUserLabelsMap()
public Map<String,String> getUserLabelsMap()
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.
map<string, string> user_labels = 8;
getUserLabelsOrDefault(String key, String defaultValue)
public String getUserLabelsOrDefault(String key, String defaultValue)
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.
map<string, string> user_labels = 8;
getUserLabelsOrThrow(String key)
public String getUserLabelsOrThrow(String key)
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.
map<string, string> user_labels = 8;
| Parameter |
|---|
| Name | Description |
key | String
|
getValidateOnly()
public 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;
| Returns |
|---|
| Type | Description |
boolean | The validateOnly.
|
hasUserEvent()
public 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];
| Returns |
|---|
| Type | Description |
boolean | Whether the userEvent field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public RecommendRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RecommendRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public RecommendRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
