Recombee API Client
Public Member Functions | Properties | List of all members
Recombee.ApiClient.ApiRequests.SearchItems Class Reference

Search items More...

Inheritance diagram for Recombee.ApiClient.ApiRequests.SearchItems:
Inheritance graph
[legend]
Collaboration diagram for Recombee.ApiClient.ApiRequests.SearchItems:
Collaboration graph
[legend]

Public Member Functions

 SearchItems (string userId, string searchQuery, long count, string scenario=null, bool? cascadeCreate=null, bool? returnProperties=null, string[] includedProperties=null, string filter=null, string booster=null, Logic logic=null, Dictionary< string, object > expertSettings=null, bool? returnAbGroup=null)
 Construct the request More...
 
override string Path ()
 
Returns
URI to the endpoint including path parameters
More...
 
override Dictionary< string, object > QueryParameters ()
 Get query parameters More...
 
override Dictionary< string, object > BodyParameters ()
 Get body parameters More...
 
- Public Member Functions inherited from Recombee.ApiClient.ApiRequests.Request
 Request (HttpMethod httpMethod, int timeoutMilliseconds, bool ensureHttps=false)
 Construct the request More...
 

Properties

string UserId [get]
 ID of the user for whom personalized search will be performed. More...
 
string SearchQuery [get]
 Search query provided by the user. It is used for the full-text search. More...
 
long Count [get]
 Number of items to be returned (N for the top-N results). More...
 
string Scenario [get]
 Scenario defines a particular search field in your user interface. You can set various settings to the scenario in the Admin UI. You can also see performance of each scenario in the Admin UI separately, so you can check how well each field 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. More...
 
bool? CascadeCreate [get]
 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. More...
 
bool? ReturnProperties [get]
 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 for easy displaying of the recommended items to the user. Example response: More...
 
string[] IncludedProperties [get]
 Allows to specify, 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: More...
 
string Filter [get]
 Boolean-returning ReQL expression which allows you to filter recommended items based on the values of their attributes. Filters can be also assigned to a scenario in the Admin UI. More...
 
string Booster [get]
 Number-returning ReQL expression which allows you to boost recommendation rate of some items based on the values of their attributes. Boosters can be also assigned to a scenario in the Admin UI. More...
 
Logic Logic [get]
 Logic specifies particular behavior of the recommendation models. You can pick tailored logic for your domain and use case. See this section 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. Logic can be also set to a scenario in the Admin UI. More...
 
Dictionary< string, object > ExpertSettings [get]
 Dictionary of custom options. More...
 
bool? ReturnAbGroup [get]
 If there is a custom AB-testing running, return name of group to which the request belongs. More...
 
- Properties inherited from Recombee.ApiClient.ApiRequests.Request
TimeSpan Timeout [get, set]
 Timeout for the request in milliseconds More...
 
bool EnsureHttps [get]
 If true, HTTPS must be chosen over HTTP for this request More...
 
HttpMethod RequestHttpMehod [get]
 Used HTTP method More...
 

Additional Inherited Members

- Protected Member Functions inherited from Recombee.ApiClient.ApiRequests.Request
double ConvertToUnixTimestamp (DateTime date)
 
Returns
Converts DateTime to UNIX timestamp (epoch)
More...
 

Detailed Description

Search items

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 at 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 current state of the query, or once after submitting the whole query. The returned items are sorted by relevance (first item being the most relevant). Besides the recommended items, also a unique recommId is returned in the response. It can be used to:

Constructor & Destructor Documentation

◆ SearchItems()

Recombee.ApiClient.ApiRequests.SearchItems.SearchItems ( string  userId,
string  searchQuery,
long  count,
string  scenario = null,
bool?  cascadeCreate = null,
bool?  returnProperties = null,
string[]  includedProperties = null,
string  filter = null,
string  booster = null,
Logic  logic = null,
Dictionary< string, object >  expertSettings = null,
bool?  returnAbGroup = null 
)
inline

Construct the request

Parameters
userIdID of the user for whom personalized search will be performed.
searchQuerySearch query provided by the user. It is used for the full-text search.
countNumber of items to be returned (N for the top-N results).
scenarioScenario defines a particular search field in your user interface. You can set various settings to the scenario in the Admin UI. You can also see performance of each scenario in the Admin UI separately, so you can check how well each field 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.
cascadeCreateIf 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.
returnPropertiesWith 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 for easy displaying of 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
}
Parameters
includedPropertiesAllows to specify, 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
}
Parameters
filterBoolean-returning ReQL expression which allows you to filter recommended items based on the values of their attributes. Filters can be also assigned to a scenario in the Admin UI.
boosterNumber-returning ReQL expression which allows you to boost recommendation rate of some items based on the values of their attributes. Boosters can be also assigned to a scenario in the Admin UI.
logicLogic specifies particular behavior of the recommendation models. You can pick tailored logic for your domain and use case. See this section 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. Logic can be also set to a scenario in the Admin UI.
expertSettingsDictionary of custom options.
returnAbGroupIf there is a custom AB-testing running, return name of group to which the request belongs.

Member Function Documentation

◆ BodyParameters()

override Dictionary<string, object> Recombee.ApiClient.ApiRequests.SearchItems.BodyParameters ( )
inlinevirtual

Get body parameters

Returns
Dictionary containing values of body parameters (name of parameter: value of the parameter)

Implements Recombee.ApiClient.ApiRequests.Request.

◆ Path()

override string Recombee.ApiClient.ApiRequests.SearchItems.Path ( )
inlinevirtual

Returns
URI to the endpoint including path parameters

Implements Recombee.ApiClient.ApiRequests.Request.

◆ QueryParameters()

override Dictionary<string, object> Recombee.ApiClient.ApiRequests.SearchItems.QueryParameters ( )
inlinevirtual

Get query parameters

Returns
Dictionary containing values of query parameters (name of parameter: value of the parameter)

Implements Recombee.ApiClient.ApiRequests.Request.

Property Documentation

◆ Booster

string Recombee.ApiClient.ApiRequests.SearchItems.Booster
get

Number-returning ReQL expression which allows you to boost recommendation rate of some items based on the values of their attributes. Boosters can be also assigned to a scenario in the Admin UI.

◆ CascadeCreate

bool? Recombee.ApiClient.ApiRequests.SearchItems.CascadeCreate
get

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.

◆ Count

long Recombee.ApiClient.ApiRequests.SearchItems.Count
get

Number of items to be returned (N for the top-N results).

◆ ExpertSettings

Dictionary<string, object> Recombee.ApiClient.ApiRequests.SearchItems.ExpertSettings
get

Dictionary of custom options.

◆ Filter

string Recombee.ApiClient.ApiRequests.SearchItems.Filter
get

Boolean-returning ReQL expression which allows you to filter recommended items based on the values of their attributes. Filters can be also assigned to a scenario in the Admin UI.

◆ IncludedProperties

string [] Recombee.ApiClient.ApiRequests.SearchItems.IncludedProperties
get

Allows to specify, 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
}

◆ Logic

Logic Recombee.ApiClient.ApiRequests.SearchItems.Logic
get

Logic specifies particular behavior of the recommendation models. You can pick tailored logic for your domain and use case. See this section 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. Logic can be also set to a scenario in the Admin UI.

◆ ReturnAbGroup

bool? Recombee.ApiClient.ApiRequests.SearchItems.ReturnAbGroup
get

If there is a custom AB-testing running, return name of group to which the request belongs.

◆ ReturnProperties

bool? Recombee.ApiClient.ApiRequests.SearchItems.ReturnProperties
get

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 for easy displaying of 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
}

◆ Scenario

string Recombee.ApiClient.ApiRequests.SearchItems.Scenario
get

Scenario defines a particular search field in your user interface. You can set various settings to the scenario in the Admin UI. You can also see performance of each scenario in the Admin UI separately, so you can check how well each field 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.

◆ SearchQuery

string Recombee.ApiClient.ApiRequests.SearchItems.SearchQuery
get

Search query provided by the user. It is used for the full-text search.

◆ UserId

string Recombee.ApiClient.ApiRequests.SearchItems.UserId
get

ID of the user for whom personalized search will be performed.


The documentation for this class was generated from the following file: