AutocompleteResponseBody

autocomplete api response body: { "completions": [{"text": "", "source": ""}] }

  • completions
    Type: object · Completions
    required

    Autocompletion results.

    • propertyName
      Type: array

      • title completion additionally has the product the title belongs to.

        • product
          Type: object · Product
          required
        • text
          Type: string · Text
          min length:  
          1
          required
        • text_with_inverted_markups
          Type: string · Text With Inverted Markups
          min length:  
          1
          required
        • text_with_markups
          Type: string · Text With Markups
          min length:  
          1
          required
  • miso_id
    Type: string · Miso IdFormat: uuid

    Miso-generated unique Id for each recommendation or search result. Maintaining this Id for subsequent page views is important to Miso's performance as we use miso_id to track and fine-tune the performance of personalization and search results. When a user clicks on a recommendation or search result, you should pass the associated miso_id to the next page view, and associate the miso_id with the interactions that take place on the page (e.g. product_detail_page_view, add_to_cart, add_to_collection, like, etc.). In this way, Miso will learn which recommendations work and which didn't.

    Example:

    {"misoId": "123e4567-e89b-12d3-a456-426614174000"}
  • took
    Type: integer · Took

    Number of milliseconds Miso took to retrieve the results.