--- title: "Search Items" method: POST path: "/{databaseId}/search/users/{userId}/items/" tags: ["Search"] --- # Search Items `POST /{databaseId}/search/users/{userId}/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 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#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#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. ## Path parameters - `databaseId` string, required - `userId` string, required ## Request body - SearchItemsParameters - `searchQuery` string, required — Search query provided by the user. It is used for the full-text search. - `count` integer, required — Number of items to be returned (N for the top-N results). - `scenario` string — Scenario defines a particular search field in your user interface. You can set various settings to the [scenario](https://docs.recombee.com/scenarios) 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. - `cascadeCreate` boolean — 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` boolean — 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: ```json { "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` string[] — 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`: ```json { "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` string — Boolean-returning [ReQL](https://docs.recombee.com/reql) 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) in the [Admin UI](https://admin.recombee.com). - `booster` string — Number-returning [ReQL](https://docs.recombee.com/reql) 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) in the [Admin UI](https://admin.recombee.com). - `logic` union - string - object - `name` string — Name of the logic that should be used - `settings` object — Parameters passed to the logic - `reqlExpressions` object — A dictionary of [ReQL](https://docs.recombee.com/reql) expressions that will be executed for each recommended item. This can be used to compute additional properties of the recommended items that are not stored in the database. The keys are the names of the expressions, and the values are the actual ReQL expressions. Example request: ```json { "reqlExpressions": { "isInUsersCity": "context_user[\"city\"] in 'cities'", "distanceToUser": "earth_distance('location', context_user[\"location\"])" } } ``` Example response: ```json { "recommId": "ce52ada4-e4d9-4885-943c-407db2dee837", "recomms": [ { "id": "restaurant-178", "reqlEvaluations": { "isInUsersCity": true, "distanceToUser": 5200.2 } }, { "id": "bar-42", "reqlEvaluations": { "isInUsersCity": false, "distanceToUser": 2516.0 } } ], "numberNextRecommsCalls": 0 } ``` - `expertSettings` object — Dictionary of custom options. - `returnAbGroup` boolean — If there is a custom AB-testing running, return the name of the group to which the request belongs. ## Response `200` Successful operation. - SearchResponse - `recommId` string, required — Id of the personalized search request - `recomms` Recommendation[], required — Results of the personalized search - `id` string, required — Id of the recommended item - `values` object — Property values of the recommended item - `reqlEvaluations` object — Dictionary of evaluated ReQL expressions specified in the request and calculated for the recommended item. The keys are the names of the ReQL expressions, and the values are the results of the evaluations. - `numberNextRecommsCalls` integer — How many times *Recommend Next Items* have been called for this `recommId` - `abGroup` string — Name of AB-testing group to which the request belongs if there is a custom AB-testing running. ## Other responses - `400` — userId does not match ^[a-zA-Z0-9_\-:@\.]+$, count is not a positive integer, searchQuery is not provided, filter or booster are not valid [ReQL](https://docs.recombee.com/reql) expressions, filter expression does not return boolean, booster does not return double or integer. - `404` — userId not found in the database and cascadeCreate is false. If there is no additional info in the JSON response, you probably have an error in you URL. --- [API](https://skmtc.dev/recombee/apis/recombee-api.md) · [All operations](https://skmtc.dev/recombee/apis/recombee-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/recombee/recombee-api/revisions/a9c9c33eb2e8/schema)