class RecombeeApiClient::SearchItems

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:

It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.

Attributes

booster[R]
cascade_create[R]
count[R]
ensure_https[RW]
expert_settings[R]
filter[R]
included_properties[R]
logic[R]
return_ab_group[R]
return_properties[R]
scenario[R]
search_query[R]
timeout[RW]
user_id[R]

Public Class Methods

new(user_id, search_query, count, optional = {}) click to toggle source
* *Required arguments*
  - +user_id+ -> ID of the user for whom personalized search will be performed.
  - +search_query+ -> Search query provided by the user. It is used for the full-text search.
  - +count+ -> Number of items to be returned (N for the top-N results).

* *Optional arguments (given as hash optional)*
  - +scenario+ -> Scenario defines a particular search field in your user interface.

You can set various settings to the [scenario](docs.recombee.com/scenarios.html) in the [Admin UI](admin.recombee.com). 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.

- +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.
- +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 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
}

“`

- +includedProperties+ -> 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
}

“`

- +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 be also assigned to a [scenario](docs.recombee.com/scenarios.html) in the [Admin UI](admin.recombee.com).

- +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql.html) 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](docs.recombee.com/scenarios.html) in the [Admin UI](admin.recombee.com).

- +logic+ -> Logic specifies particular behavior of the recommendation models. You can pick tailored logic for your domain and use case.

See [this section](docs.recombee.com/recommendation_logics.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.

Logic can be also set to a [scenario](docs.recombee.com/scenarios.html) in the [Admin UI](admin.recombee.com).

- +expertSettings+ -> Dictionary of custom options.

- +returnAbGroup+ -> If there is a custom AB-testing running, return name of group to which the request belongs.
# File lib/recombee_api_client/api/search_items.rb, line 122
def initialize(user_id, search_query, count, optional = {})
  @user_id = user_id
  @search_query = search_query
  @count = count
  optional = normalize_optional(optional)
  @scenario = optional['scenario']
  @cascade_create = optional['cascadeCreate']
  @return_properties = optional['returnProperties']
  @included_properties = optional['includedProperties']
  @filter = optional['filter']
  @booster = optional['booster']
  @logic = optional['logic']
  @expert_settings = optional['expertSettings']
  @return_ab_group = optional['returnAbGroup']
  @optional = optional
  @timeout = 3000
  @ensure_https = false
  @optional.each do |par, _|
    fail UnknownOptionalParameter.new(par) unless ["scenario","cascadeCreate","returnProperties","includedProperties","filter","booster","logic","expertSettings","returnAbGroup"].include? par
  end
end

Public Instance Methods

body_parameters() click to toggle source

Values of body parameters as a Hash

# File lib/recombee_api_client/api/search_items.rb, line 150
def body_parameters
  p = Hash.new
  p['searchQuery'] = @search_query
  p['count'] = @count
  p['scenario'] = @optional['scenario'] if @optional.include? 'scenario'
  p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
  p['returnProperties'] = @optional['returnProperties'] if @optional.include? 'returnProperties'
  p['includedProperties'] = @optional['includedProperties'] if @optional.include? 'includedProperties'
  p['filter'] = @optional['filter'] if @optional.include? 'filter'
  p['booster'] = @optional['booster'] if @optional.include? 'booster'
  p['logic'] = @optional['logic'] if @optional.include? 'logic'
  p['expertSettings'] = @optional['expertSettings'] if @optional.include? 'expertSettings'
  p['returnAbGroup'] = @optional['returnAbGroup'] if @optional.include? 'returnAbGroup'
  p
end
method() click to toggle source

HTTP method

# File lib/recombee_api_client/api/search_items.rb, line 145
def method
  :post
end
path() click to toggle source

Relative path to the endpoint

# File lib/recombee_api_client/api/search_items.rb, line 174
def path
  "/{databaseId}/search/users/#{@user_id}/items/"
end
query_parameters() click to toggle source

Values of query parameters as a Hash. name of parameter => value of the parameter

# File lib/recombee_api_client/api/search_items.rb, line 168
def query_parameters
  params = {}
  params
end