Get a collection's search rules
Returns the collection's search rules. A collection without configured rules returns the defaults (no exclusion, no fallback, empty boosts / redirects / suggestions) rather than 404, so `get → edit → put` needs no special case.
Full-key operation
Returns the collection's search rules. A collection without configured rules returns the defaults (no exclusion, no fallback, empty boosts / redirects / suggestions) rather than 404, so get → edit → put needs no special case.
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
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/collections/string/search_rules"{ "exclusion_filter_by": "string", "zero_hits_fallback": "none", "fallback_model_id": "string", "boosts": [ { "filter_by": "in_stock:true", "weight": 1, "name": "string", "priority": 0 } ], "boosts_override_sort": false, "pins": [ { "query": "iphone", "match": "exact", "filter_contains": "string", "doc_id": "string", "position": 0, "priority": 0 } ], "diversity": [ { "field": "brand", "max": 1, "min": 1, "from": 1, "near_duplicate": { "fields": [ "title", "description" ], "threshold": 0.9 }, "mmr": { "lambda": 0.7, "vector_field": "string", "text_fields": [ "string" ], "k": 1 } } ], "redirects": [ { "query": "delivery", "match": "exact", "url": "/help/delivery", "priority": 0 } ], "suggestions": [ { "query": "string", "match": "exact", "suggestions": [ "string" ] } ], "facet_suggestions": { "fields": [ "brand", "category" ], "limit": 5 }, "starts_at": "2019-08-24T14:15:22Z", "ends_at": "2019-08-24T14:15:22Z", "device": "desktop", "language": "string", "country": "string", "banners": [ { "id": "string", "query": "string", "match": "exact", "filter_contains": "string", "content": {}, "priority": 0 } ], "sponsored": [ { "id": "string", "position": 0, "query": "string", "match": "exact", "filter_by": "string", "label": "string", "campaign_id": "string" } ], "rerank": { "enabled": true, "model": "bge-reranker-base", "top_k": 20, "fields": [ "title", "description" ], "timeout_ms": 400, "min_hits": 1, "fallback": "engine_order" }, "collection": "string", "updated_at": 0}