Google Cloud Discovery Engine V1beta Client - Class RecommendRequest (0.4.0)

Version 0.4.0

• 1.3.1 (latest)
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.11.3
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class RecommendRequest.

Request message for Recommend method.

Generated from protobuf message google.cloud.discoveryengine.v1beta.RecommendRequest

Namespace

Google \ Cloud \ DiscoveryEngine \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ serving_config	string 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.
↳ user_event	Google\Cloud\DiscoveryEngine\V1beta\UserEvent 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.
↳ page_size	int 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.
↳ 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.
↳ validate_only	bool 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.
↳ params	array|Google\Protobuf\Internal\MapField 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.
↳ user_labels	array|Google\Protobuf\Internal\MapField 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.

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.

Returns
Type	Description
string

setServingConfig

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

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.

Returns
Type	Description
Google\Cloud\DiscoveryEngine\V1beta\UserEvent|null

hasUserEvent

clearUserEvent

setUserEvent

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.

Parameter
Name	Description
var	Google\Cloud\DiscoveryEngine\V1beta\UserEvent

Returns
Type	Description
$this

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.

Returns
Type	Description
int

setPageSize

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.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

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.

Returns
Type	Description
string

setFilter

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

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.

Returns
Type	Description
bool

setValidateOnly

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.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getParams

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.

Returns
Type	Description
Google\Protobuf\Internal\MapField

setParams

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.

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

getUserLabels

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.

Returns
Type	Description
Google\Protobuf\Internal\MapField

setUserLabels

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.

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this