Generate synonym suggestions for zero-hit queries
Examines up to `limit` zero-hit queries and stores every candidate that finds documents as a `pending` suggestion. Candidates come from the same rewrites the search proxy uses (`layout`, `translit`, `homoglyph`) and, unless `use_llm` is false, from a language model asked for spelling fixes, brand spellings and synonyms. Each candidate is verified with a real search; the suggestion records the term the engine matched (so `девольт` yields `dewalt`, the catalogue's spelling, not the model's guess), the hit count and a few sample titles. Queries that already find something are skipped. Synchronous; keep `limit` small and call it again for the next batch.
Full-key operation
Examines up to limit zero-hit queries and stores every candidate that finds documents as a pending suggestion. Candidates come from the same rewrites the search proxy uses (layout, translit, homoglyph) and, unless use_llm is false, from a language model asked for spelling fixes, brand spellings and synonyms. Each candidate is verified with a real search; the suggestion records the term the engine matched (so девольт yields dewalt, the catalogue's spelling, not the model's guess), the hit count and a few sample titles. Queries that already find something are skipped. Synchronous; keep limit small and call it again for the next batch.
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/synonym_suggestions/generate" \ -H "Content-Type: application/json" \ -d '{}'{ "suggestions": [ { "id": "string", "collection": "string", "query": "string", "term": "string", "candidate": "string", "kind": "layout", "found": 0, "sample_titles": [ "string" ], "occurrences": 0, "synonym_set": "string", "status": "pending", "synonym_item_id": "string", "created_at": 0, "decided_at": 0 } ], "examined": 0, "skipped": [ { "query": "string", "reason": "has_hits" } ]}