HybridSearchRequest

  • q
    Type: string
    required

    The search query the user has entered.

  • anonymous_id
    Type: string

    The anonymous visitor who made this query. Used for personalization when there is no user_id.

  • answer

    Controls the AI answer pipeline:

    • true — always generate an answer
    • false — search results only, no answer
    • "AUTO" — let Miso decide per query (recommended; generates an answer only when the query looks like a question)
    • Type: boolean

      Controls the AI answer pipeline:

      • true — always generate an answer
      • false — search results only, no answer
      • "AUTO" — let Miso decide per query (recommended; generates an answer only when the query looks like a question)
  • facets
    Type: array of string

    Fields to compute facet counts for (e.g. categories, tags, custom_attributes.director). Counts are returned in data.facet_counts — use them to build filter UIs.

  • fl
    Type: array of string

    Fields to return for each product in data.products. Any uploaded field is allowed, including custom_attributes.*.

  • fq
    Type: string

    A query in Elasticsearch query-string syntax (Lucene) that restricts the candidate products without affecting ranking — use it to scope results (e.g. by section or subscription tier).

    Examples:

    • "section:\"markets\"" — only the markets section
    • "tier:(\"premium\" OR \"pro\")" — only premium/pro content
    • "rating:[4 TO *]" — numeric range, rating ≥ 4
    • "custom_attributes.designer:\"Calvin Klein\"" — filter on a custom attribute
  • metadata
    Type: object

    Arbitrary metadata to store with the request (e.g. {"site": "markets"}).

  • order_by
    Type: "relevance" or "published_at" or "-published_at"enum

    Sort order of results: relevance (default), published_at (newest first), or -published_at (oldest first). A record with no published_at sorts by updated_at instead. You can also send a list of order-by objects to sort on your own numeric or boolean fields.

  • rows
    Type: integer

    Number of search results to return in data.products.

  • source_fl
    Type: array of string

    Fields to return for each answer source. Same field rules as fl.

  • start
    Type: integer

    Offset of the first result — use with rows for pagination.

  • stemming
    Type: boolean

    When enabled, query words are reduced to their root form (e.g. "running" → "run"), improving recall by matching inflected forms.

  • user_hash
    Type: string

    The hash of user_id (or anonymous_id) encrypted with your Secret API Key. Send this when calling from the browser with a Publishable API Key to prevent spoofing.

  • user_id
    Type: string

    The signed-in user who made the query. For an anonymous visitor, use anonymous_id instead. Used for personalization.

  • user_type
    Type: string

    The type/segment of user who made the query. Used for rate limiting and segment-level personalization.