boostFieldName
Boost Field
|
The field name to boost the values on.
type: string
default value: 'id '
|
boostingMethod
Boost Method
required
|
The boost method to use. query-parser should be chosen if defType!=edismax for main query.
type: string
default value: 'query-param '
enum: {
query-param
query-parser
}
|
boostingParam
Boost Param
required
|
’Boost' multiplies scores by the boost values whereas 'bq' adds optional clauses to main query.
type: string
default value: 'boost '
enum: {
boost
bq
}
|
collection
Recommendation Collection
|
If left blank, the default recommendation collection for the collection being queried will be used.
type: string
|
foldInUpdates
Estimate Recent Results
|
Update recommendations based on user activity that has happened since the last recommendation job run
type: boolean
|
itemIdField
Item ID Field
|
the name of the field in the recommendation collection where item ID is stored
type: string
default value: 'itemId '
|
modelCollection
Model Collection ID
|
The name of the collection where models are stored. By default this is {app_name}_recommender_models
type: string
|
modelID
Model ID
|
type: string
default value: '* '
|
modelIdField
Model ID Field
|
the name of the field in the recommendation collection where model ID is stored
type: string
default value: 'modelId '
|
numRecommendations
Number of Recommendations
|
type: integer
default value: '10 '
|
rawSignalsCollection
Signals Collection
|
The collection to use to fetch recent user interactions, if 'Estimate Recent Results' is true.
type: string
|
resultsLocation
Results Location
|
If As Response is chosen, then the result of the RPC call will be the one and only response. In all other cases, the stage will put the response from the REST/RPC call into the target location using the resultsKey.
type: string
default value: 'As Boosts '
enum: {
As Boosts
As Response
}
|
routingParams
Additional query params for routing
|
Add routing parameter keys (e.g. lw.nodeFilter) and values here for routing recommender searches
type: array of object
object attributes: {
key
(required)
: {
display name: Parameter Name
type: string
}
value
: {
display name: Parameter Value
type: string
}
}
|
scaleRange
Scale Boosts
|
Scale the boost values to a [min,max] range
type: object
object attributes: {
scaleMax
: {
display name: Maximum value of the scale range
type: number
}
scaleMin
: {
display name: Minimum value of the scale range
type: number
}
}
|
userIdField
User ID Field
|
the name of the field in the recommendation collection where user ID is stored
type: string
default value: 'userId '
|
userIdParam
User ID Request Parameter
|
The name of the request parameter containing the user ID
type: string
default value: 'user_id '
|
weightField
Weight Field
|
the name of the field in the recommendation collection where weight of the recommendation is stored
type: string
default value: 'weight '
|