Get recommendations
Returns documents recommended by a model. Pass `object_id` for item-to-item models (`looking_similar`, `related_items`, `bought_together`), `session_id` or `user_id` for `session`, and nothing for `trending`. Hits use the same shape as search results so they can be rendered by the same code.
Операция для поискового ключа
Returns documents recommended by a model. Pass object_id for item-to-item models (looking_similar, related_items, bought_together), session_id or user_id for session, and nothing for trending. Hits use the same shape as search results so they can be rendered by the same code.
Authorization
api_key_header Every request carries an organization API key. A key has one of two scopes. A full key reaches every operation in this document and belongs on your server. A search key is the one to ship in a browser widget or a storefront page: it reaches only the operations marked x-nova-key-scope: search — searching, federated search, recommendations, event ingestion, and the visitor-facing AI operations (semantic and image search, voice transcription and voice search, assistant chat, and the visitor's own conversation). It cannot write documents or read or change configuration; any other operation answers 403. AI operations are paid in credits from the organization's wallet whichever key calls them (402 when the balance runs out), and a search key needs X-NOVA-SESSION-ID on them: the session is what a conversation belongs to, and what the per-session allowance (429) is counted against. A key of either scope may additionally carry restrictions set in the console: an allowlist of collections (403 elsewhere), a forced filter_by per collection that is ANDed into every search (document-level access control), an allowlist of fields (include_fields is limited to it and a request naming any other field in query_by, facet_by, sort_by, filter_by or highlight_fields answers 400), an IP/CIDR allowlist and an Origin/Referer allowlist (403), and a per-key rate limit (429 with Retry-After).
In: header
Path Parameters
The name of the collection
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/collections/string/recommendations" \ -H "Content-Type: application/json" \ -d '{ "model_id": "string" }'{ "model_id": "string", "hits": [ { "highlights": [ { "field": "company_name", "snippet": "<mark>Stark</mark> Industries" } ], "document": { "id": "124", "company_name": "Stark Industries", "num_employees": 5215, "country": "USA" }, "text_match": 1234556 } ], "took_ms": 0, "queries": [ "string" ], "experiment": "string"}Create or update a recommendation model PUT
Creates a recommendation model on the collection, or replaces its configuration if the id already exists. `looking_similar` and `session` models need `vector_field`, a vector field of the collection; `trending`, `related_items` and `bought_together` are computed from ingested events and need none.
Typeahead suggestions GET
Suggestions for a prefix while the visitor types (TYPEAHEAD surface). Candidates come from the collection's popular queries, its documents, linked catalogue entities (brands, categories), the query graph continuing the session's last query, search-rule suggestions and the session's recent searches; they are ranked by expected downstream usefulness (not just count or CTR), de-duplicated semantically and filtered of queries known to return nothing. Every returned suggestion is logged as an impression with its position; report the chosen one as a `suggestion_select` event with `query_id` = `suggest_id`. Never calls a language model.