recombee-api-client
Advanced tools
Comparing version 2.3.0 to 2.4.0
@@ -20,3 +20,3 @@ 'use strict'; | ||
* @param {string} secretToken - Corresponding secret token | ||
* @param {boolean} alwaysUseHttps - If true, all requests are sent using HTTPS (default: false) | ||
* @param {boolean} alwaysUseHttps - If true, all requests are sent using HTTPS (default: true) | ||
* @param {Object} options - Other custom options | ||
@@ -27,3 +27,3 @@ */ | ||
this.token = token; | ||
this.alwaysUseHttps = alwaysUseHttps; | ||
this.alwaysUseHttps = (alwaysUseHttps === undefined) ? true : alwaysUseHttps; | ||
this.baseUri = process.env.RAPI_URI || 'rapi.recombee.com'; | ||
@@ -49,3 +49,3 @@ this.options = options || {}; | ||
'Content-Type': 'application/json', | ||
'User-Agent': 'recombee-node-api-client/2.3.0'}, | ||
'User-Agent': 'recombee-node-api-client/2.4.0'}, | ||
timeout: request.timeout, | ||
@@ -52,0 +52,0 @@ resolveWithFullResponse: true, |
@@ -34,5 +34,2 @@ /* | ||
* - Allowed parameters: | ||
* - *userImpact* | ||
* - Type: number | ||
* - Description: If *targetUserId* parameter is present, the recommendations are biased towards the user given. Using *userImpact*, you may control this bias. For an extreme case of `userImpact=0.0`, the interactions made by the user are not taken into account at all (with the exception of history-based blacklisting), for `userImpact=1.0`, you'll get user-based recommendation. The default value is `0`. | ||
* - *filter* | ||
@@ -50,2 +47,7 @@ * - Type: string | ||
* - Description: Scenario defines a particular application of recommendations. It can be for example "homepage", "cart" or "emailing". You can see each scenario in the UI separately, so you can check how well each application performs. The AI which optimizes models in order to get the best results may optimize different scenarios separately, or even use different models in each of the scenarios. | ||
* - *logic* | ||
* - Type: string| | ||
* - Description: Logic specifies particular behavior of the recommendation models. You can pick tailored logic for your domain (e-commerce, multimedia, fashion ...) and use case. | ||
* See [this section](https://docs.recombee.com/recommendation_logic.html) for list of available logics and other details. | ||
* The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users. | ||
* - *returnProperties* | ||
@@ -107,2 +109,5 @@ * - Type: boolean | ||
* ``` | ||
* - *userImpact* | ||
* - Type: number | ||
* - Description: **Expert option** If *targetUserId* parameter is present, the recommendations are biased towards the given user. Using *userImpact*, you may control this bias. For an extreme case of `userImpact=0.0`, the interactions made by the user are not taken into account at all (with the exception of history-based blacklisting), for `userImpact=1.0`, you'll get user-based recommendation. The default value is `0`. | ||
* - *diversity* | ||
@@ -133,3 +138,2 @@ * - Type: number | ||
optional = optional || {}; | ||
this.userImpact = optional.userImpact; | ||
this.filter = optional.filter; | ||
@@ -139,4 +143,6 @@ this.booster = optional.booster; | ||
this.scenario = optional.scenario; | ||
this.logic = optional.logic; | ||
this.returnProperties = optional.returnProperties; | ||
this.includedProperties = optional.includedProperties; | ||
this.userImpact = optional.userImpact; | ||
this.diversity = optional.diversity; | ||
@@ -159,5 +165,2 @@ this.minRelevance = optional.minRelevance; | ||
if(this.userImpact !== undefined) | ||
params.userImpact = this.userImpact; | ||
if(this.filter !== undefined) | ||
@@ -175,2 +178,5 @@ params.filter = this.filter; | ||
if(this.logic !== undefined) | ||
params.logic = this.logic; | ||
if(this.returnProperties !== undefined) | ||
@@ -182,2 +188,5 @@ params.returnProperties = this.returnProperties; | ||
if(this.userImpact !== undefined) | ||
params.userImpact = this.userImpact; | ||
if(this.diversity !== undefined) | ||
@@ -184,0 +193,0 @@ params.diversity = this.diversity; |
@@ -33,2 +33,7 @@ /* | ||
* - Description: Scenario defines a particular application of recommendations. It can be for example "homepage", "cart" or "emailing". You can see each scenario in the UI separately, so you can check how well each application performs. The AI which optimizes models in order to get the best results may optimize different scenarios separately, or even use different models in each of the scenarios. | ||
* - *logic* | ||
* - Type: string| | ||
* - Description: Logic specifies particular behavior of the recommendation models. You can pick tailored logic for your domain (e-commerce, multimedia, fashion ...) and use case. | ||
* See [this section](https://docs.recombee.com/recommendation_logic.html) for list of available logics and other details. | ||
* The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users. | ||
* - *returnProperties* | ||
@@ -118,2 +123,3 @@ * - Type: boolean | ||
this.scenario = optional.scenario; | ||
this.logic = optional.logic; | ||
this.returnProperties = optional.returnProperties; | ||
@@ -149,2 +155,5 @@ this.includedProperties = optional.includedProperties; | ||
if(this.logic !== undefined) | ||
params.logic = this.logic; | ||
if(this.returnProperties !== undefined) | ||
@@ -151,0 +160,0 @@ params.returnProperties = this.returnProperties; |
@@ -33,2 +33,7 @@ /* | ||
* - Description: Scenario defines a particular application of recommendations. It can be for example "homepage", "cart" or "emailing". You can see each scenario in the UI separately, so you can check how well each application performs. The AI which optimizes models in order to get the best results may optimize different scenarios separately, or even use different models in each of the scenarios. | ||
* - *logic* | ||
* - Type: string| | ||
* - Description: Logic specifies particular behavior of the recommendation models. You can pick tailored logic for your domain (e-commerce, multimedia, fashion ...) and use case. | ||
* See [this section](https://docs.recombee.com/recommendation_logic.html) for list of available logics and other details. | ||
* The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users. | ||
* - *returnProperties* | ||
@@ -103,2 +108,3 @@ * - Type: boolean | ||
this.scenario = optional.scenario; | ||
this.logic = optional.logic; | ||
this.returnProperties = optional.returnProperties; | ||
@@ -131,2 +137,5 @@ this.includedProperties = optional.includedProperties; | ||
if(this.logic !== undefined) | ||
params.logic = this.logic; | ||
if(this.returnProperties !== undefined) | ||
@@ -133,0 +142,0 @@ params.returnProperties = this.returnProperties; |
@@ -33,2 +33,7 @@ /* | ||
* - Description: Scenario defines a particular application of recommendations. It can be for example "homepage", "cart" or "emailing". You can see each scenario in the UI separately, so you can check how well each application performs. The AI which optimizes models in order to get the best results may optimize different scenarios separately, or even use different models in each of the scenarios. | ||
* - *logic* | ||
* - Type: string| | ||
* - Description: Logic specifies particular behavior of the recommendation models. You can pick tailored logic for your domain (e-commerce, multimedia, fashion ...) and use case. | ||
* See [this section](https://docs.recombee.com/recommendation_logic.html) for list of available logics and other details. | ||
* The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users. | ||
* - *returnProperties* | ||
@@ -112,2 +117,3 @@ * - Type: boolean | ||
this.scenario = optional.scenario; | ||
this.logic = optional.logic; | ||
this.returnProperties = optional.returnProperties; | ||
@@ -143,2 +149,5 @@ this.includedProperties = optional.includedProperties; | ||
if(this.logic !== undefined) | ||
params.logic = this.logic; | ||
if(this.returnProperties !== undefined) | ||
@@ -145,0 +154,0 @@ params.returnProperties = this.returnProperties; |
{ | ||
"name": "recombee-api-client", | ||
"version": "2.3.0", | ||
"version": "2.4.0", | ||
"description": "Node.js client (SDK) for easy use of the Recombee recommendation API", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
372930
12068