com.recombee.api_client.api_requests.SearchItems Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of api-client Show documentation
Show all versions of api-client Show documentation
A client library for easy use of the Recombee recommendation API
The newest version!
package com.recombee.api_client.api_requests;
/*
This file is auto-generated, do not edit
*/
import java.util.Date;
import java.util.Map;
import java.util.HashMap;
import com.recombee.api_client.bindings.Logic;
import com.recombee.api_client.util.HTTPMethod;
/**
* Full-text personalized search. The results are based on the provided `searchQuery` and also on the user's past interactions (purchases, ratings, etc.) with the items (items more suitable for the user are preferred in the results).
* All the string and set item properties are indexed by the search engine.
* This endpoint should be used in a search box on your website/app. It can be called multiple times as the user is typing the query in order to get the most viable suggestions based on the current state of the query, or once after submitting the whole query.
* The returned items are sorted by relevance (the first item being the most relevant).
* Besides the recommended items, also a unique `recommId` is returned in the response. It can be used to:
* - Let Recombee know that this search was successful (e.g., user clicked one of the recommended items). See [Reported metrics](https://docs.recombee.com/admin_ui.html#reported-metrics).
* - Get subsequent search results when the user scrolls down or goes to the next page. See [Recommend Next Items](https://docs.recombee.com/api.html#recommend-next-items).
* It is also possible to use POST HTTP method (for example in the case of a very long ReQL filter) - query parameters then become body parameters.
*/
public class SearchItems extends Request {
/**
* ID of the user for whom personalized search will be performed.
*/
protected String userId;
/**
* Search query provided by the user. It is used for the full-text search.
*/
protected String searchQuery;
/**
* Number of items to be returned (N for the top-N results).
*/
protected Long count;
/**
* Scenario defines a particular search field in your user interface.
* You can set various settings to the [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com). You can also see the performance of each scenario in the Admin UI separately, so you can check how well each field performs.
* The AI that optimizes models to get the best results may optimize different scenarios separately, or even use different models in each of the scenarios.
*/
protected String scenario;
/**
* If the user does not exist in the database, returns a list of non-personalized search results and creates the user in the database. This allows, for example, rotations in the following recommendations for that user, as the user will be already known to the system.
*/
protected Boolean cascadeCreate;
/**
* With `returnProperties=true`, property values of the recommended items are returned along with their IDs in a JSON dictionary. The acquired property values can be used to easily display the recommended items to the user.
* Example response:
* ```
* {
* "recommId": "ce52ada4-e4d9-4885-943c-407db2dee837",
* "recomms":
* [
* {
* "id": "tv-178",
* "values": {
* "description": "4K TV with 3D feature",
* "categories": ["Electronics", "Televisions"],
* "price": 342,
* "url": "myshop.com/tv-178"
* }
* },
* {
* "id": "mixer-42",
* "values": {
* "description": "Stainless Steel Mixer",
* "categories": ["Home & Kitchen"],
* "price": 39,
* "url": "myshop.com/mixer-42"
* }
* }
* ],
* "numberNextRecommsCalls": 0
* }
* ```
*/
protected Boolean returnProperties;
/**
* Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
* Example response for `includedProperties=description,price`:
* ```
* {
* "recommId": "a86ee8d5-cd8e-46d1-886c-8b3771d0520b",
* "recomms":
* [
* {
* "id": "tv-178",
* "values": {
* "description": "4K TV with 3D feature",
* "price": 342
* }
* },
* {
* "id": "mixer-42",
* "values": {
* "description": "Stainless Steel Mixer",
* "price": 39
* }
* }
* ],
* "numberNextRecommsCalls": 0
* }
* ```
*/
protected String[] includedProperties;
/**
* Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to filter recommended items based on the values of their attributes.
* Filters can also be assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
*/
protected String filter;
/**
* Number-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to boost the recommendation rate of some items based on the values of their attributes.
* Boosters can also be assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
*/
protected String booster;
/**
* Logic specifies the particular behavior of the recommendation models. You can pick tailored logic for your domain and use case.
* See [this section](https://docs.recombee.com/recommendation_logics.html) for a 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.
* Logic can also be set to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
*/
protected Logic logic;
/**
* Dictionary of custom options.
*/
protected Map expertSettings;
/**
* If there is a custom AB-testing running, return the name of the group to which the request belongs.
*/
protected Boolean returnAbGroup;
/**
* Construct the request
* @param userId ID of the user for whom personalized search will be performed.
* @param searchQuery Search query provided by the user. It is used for the full-text search.
* @param count Number of items to be returned (N for the top-N results).
*/
public SearchItems (String userId,String searchQuery,long count) {
this.userId = userId;
this.searchQuery = searchQuery;
this.count = count;
this.timeout = 3000;
}
/**
* @param scenario Scenario defines a particular search field in your user interface.
* You can set various settings to the [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com). You can also see the performance of each scenario in the Admin UI separately, so you can check how well each field performs.
* The AI that optimizes models to get the best results may optimize different scenarios separately, or even use different models in each of the scenarios.
*/
public SearchItems setScenario(String scenario) {
this.scenario = scenario;
return this;
}
/**
* @param cascadeCreate If the user does not exist in the database, returns a list of non-personalized search results and creates the user in the database. This allows, for example, rotations in the following recommendations for that user, as the user will be already known to the system.
*/
public SearchItems setCascadeCreate(boolean cascadeCreate) {
this.cascadeCreate = cascadeCreate;
return this;
}
/**
* @param returnProperties With `returnProperties=true`, property values of the recommended items are returned along with their IDs in a JSON dictionary. The acquired property values can be used to easily display the recommended items to the user.
* Example response:
* ```
* {
* "recommId": "ce52ada4-e4d9-4885-943c-407db2dee837",
* "recomms":
* [
* {
* "id": "tv-178",
* "values": {
* "description": "4K TV with 3D feature",
* "categories": ["Electronics", "Televisions"],
* "price": 342,
* "url": "myshop.com/tv-178"
* }
* },
* {
* "id": "mixer-42",
* "values": {
* "description": "Stainless Steel Mixer",
* "categories": ["Home & Kitchen"],
* "price": 39,
* "url": "myshop.com/mixer-42"
* }
* }
* ],
* "numberNextRecommsCalls": 0
* }
* ```
*/
public SearchItems setReturnProperties(boolean returnProperties) {
this.returnProperties = returnProperties;
return this;
}
/**
* @param includedProperties Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
* Example response for `includedProperties=description,price`:
* ```
* {
* "recommId": "a86ee8d5-cd8e-46d1-886c-8b3771d0520b",
* "recomms":
* [
* {
* "id": "tv-178",
* "values": {
* "description": "4K TV with 3D feature",
* "price": 342
* }
* },
* {
* "id": "mixer-42",
* "values": {
* "description": "Stainless Steel Mixer",
* "price": 39
* }
* }
* ],
* "numberNextRecommsCalls": 0
* }
* ```
*/
public SearchItems setIncludedProperties(String[] includedProperties) {
this.includedProperties = includedProperties;
return this;
}
/**
* @param filter Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to filter recommended items based on the values of their attributes.
* Filters can also be assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
*/
public SearchItems setFilter(String filter) {
this.filter = filter;
return this;
}
/**
* @param booster Number-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to boost the recommendation rate of some items based on the values of their attributes.
* Boosters can also be assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
*/
public SearchItems setBooster(String booster) {
this.booster = booster;
return this;
}
/**
* @param logic Logic specifies the particular behavior of the recommendation models. You can pick tailored logic for your domain and use case.
* See [this section](https://docs.recombee.com/recommendation_logics.html) for a 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.
* Logic can also be set to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
*/
public SearchItems setLogic(Logic logic) {
this.logic = logic;
return this;
}
/**
* @param expertSettings Dictionary of custom options.
*/
public SearchItems setExpertSettings(Map expertSettings) {
this.expertSettings = expertSettings;
return this;
}
/**
* @param returnAbGroup If there is a custom AB-testing running, return the name of the group to which the request belongs.
*/
public SearchItems setReturnAbGroup(boolean returnAbGroup) {
this.returnAbGroup = returnAbGroup;
return this;
}
public String getUserId() {
return this.userId;
}
public String getSearchQuery() {
return this.searchQuery;
}
public long getCount() {
return this.count;
}
public String getScenario() {
return this.scenario;
}
public boolean getCascadeCreate() {
if (this.cascadeCreate==null) return false;
return this.cascadeCreate;
}
public boolean getReturnProperties() {
if (this.returnProperties==null) return false;
return this.returnProperties;
}
public String[] getIncludedProperties() {
return this.includedProperties;
}
public String getFilter() {
return this.filter;
}
public String getBooster() {
return this.booster;
}
public Logic getLogic() {
return this.logic;
}
public Map getExpertSettings() {
return this.expertSettings;
}
public boolean getReturnAbGroup() {
if (this.returnAbGroup==null) return false;
return this.returnAbGroup;
}
/**
* @return Used HTTP method
*/
@Override
public HTTPMethod getHTTPMethod() {
return HTTPMethod.POST;
}
/**
* @return URI to the endpoint including path parameters
*/
@Override
public String getPath() {
return String.format("/search/users/%s/items/", this.userId);
}
/**
* Get query parameters
* @return Values of query parameters (name of parameter: value of the parameter)
*/
@Override
public Map getQueryParameters() {
HashMap params = new HashMap();
return params;
}
/**
* Get body parameters
* @return Values of body parameters (name of parameter: value of the parameter)
*/
@Override
public Map getBodyParameters() {
HashMap params = new HashMap();
params.put("searchQuery", this.searchQuery);
params.put("count", this.count);
if (this.scenario!=null) {
params.put("scenario", this.scenario);
}
if (this.cascadeCreate!=null) {
params.put("cascadeCreate", this.cascadeCreate);
}
if (this.returnProperties!=null) {
params.put("returnProperties", this.returnProperties);
}
if (this.includedProperties!=null) {
params.put("includedProperties", this.includedProperties);
}
if (this.filter!=null) {
params.put("filter", this.filter);
}
if (this.booster!=null) {
params.put("booster", this.booster);
}
if (this.logic!=null) {
params.put("logic", this.logic);
}
if (this.expertSettings!=null) {
params.put("expertSettings", this.expertSettings);
}
if (this.returnAbGroup!=null) {
params.put("returnAbGroup", this.returnAbGroup);
}
return params;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy