Interface RecommendRequestOrBuilder (0.39.0)

public interface RecommendRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

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.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, the filter field is interpreted according to the new, attribute-based syntax.

map<string, .google.protobuf.Value> params = 6;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

containsUserLabels(String key)

public abstract 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`

Returns
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 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.

string filter = 4;

Returns
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 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.

string filter = 4;

Returns
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;

Returns
Type	Description
`int`	The pageSize.

getParams() (deprecated)

public abstract Map<String,Value> getParams()

Use #getParamsMap() instead.

Returns
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.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, the filter field is interpreted according to the new, attribute-based syntax.

map<string, .google.protobuf.Value> params = 6;

Returns
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.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, the filter field is interpreted according to the new, attribute-based syntax.

map<string, .google.protobuf.Value> params = 6;

Returns
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.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, the filter field is interpreted according to the new, attribute-based syntax.

map<string, .google.protobuf.Value> params = 6;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`Value`

Returns
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.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, the filter field is interpreted according to the new, attribute-based syntax.

map<string, .google.protobuf.Value> params = 6;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`Value`

getServingConfig()

public abstract String getServingConfig()

Required. Full resource name of a ServingConfig: projects/*/locations/global/collections/*/engines/*/servingConfigs/*, or projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*

One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine projects/*/locations/global/collections/*/engines/my-engine, you can use projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine for your RecommendationService.Recommend requests.

string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The servingConfig.

getServingConfigBytes()

public abstract ByteString getServingConfigBytes()

Required. Full resource name of a ServingConfig: projects/*/locations/global/collections/*/engines/*/servingConfigs/*, or projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*

string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
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];

Returns
Type	Description
`UserEvent`	The userEvent.

getUserEventOrBuilder()

public abstract UserEventOrBuilder getUserEventOrBuilder()

.google.cloud.discoveryengine.v1beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`UserEventOrBuilder`

getUserLabels() (deprecated)

public abstract Map<String,String> getUserLabels()

Use #getUserLabelsMap() instead.

Returns
Type	Description
`Map<String,String>`

getUserLabelsCount()

public abstract 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 abstract 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;

Returns
Type	Description
`Map<String,String>`

getUserLabelsOrDefault(String key, String defaultValue)

public abstract 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;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getUserLabelsOrThrow(String key)

public abstract 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`

Returns
Type	Description
`String`

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;

Returns
Type	Description
`boolean`	The validateOnly.

hasUserEvent()

public abstract boolean hasUserEvent()

.google.cloud.discoveryengine.v1beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`boolean`	Whether the userEvent field is set.