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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-28 UTC."],[],[]]
