QAResponseBody

  • answers
    Type: array object[] · Answers
    required

    The Question-Answer results.

    • answer
      Type: object · Answer
      required

      The answer paragraph (i.e. a <p> node) whose text content can answer users' question.

    • product_id
      Type: string · Product Id
      max length:  
      512
      required

      The unique identifier of the product whose content contains the answer.

    • answer_block
      Type: object · Answer Block
          In addition to the answer paragraph, we also return the **answer block**.
          Answer block is the ancestor node of the answer paragraph that cover not only the answer, but also the relevant
          context. This is particularly useful for applications that want to show
          the answer itself but also the relevant context surrounding the answer.
      
          Answer block is the smallest HTML element that contains the relevant context. However, not all the content
          inside this node is relevant. You can use the `relevant_children_slice` to identify a portion inside this
          block that is relevant to the answer.
          
      
  • spellcheck
    Type: object · Spellcheck
    required

    Spellcheck results. You can use the information in this object to prompt users with the correct spelling.

    • auto_spelling_correction
      Type: boolean · Auto Spelling Correction
      required

      Whether Miso has automatically corrected the misspelled search query. When this field is true, the search result is based on the corrected spelling in the corrected_query field instead of users' original search query.

    • corrected_query
      Type: string · Corrected Query
      required

      The corrected spelling suggested by Miso. If no spelling error is detected, this will be the same as original_query

    • corrected_query_with_markups
      Type: string · Corrected Query With Markups
      required

      The corrected spelling suggested by Miso where the revised tokens are surrounded by the tags.

    • original_query
      Type: string · Original Query
      required

      Original query string

    • original_query_with_markups
      Type: string · Original Query With Markups
      required

      Original query with the spelling errors (if any) surrounded by the tags

    • spelling_errors
      Type: boolean · Spelling Errors
      required

      Whether Miso detects any spelling errors.

  • total
    Type: integer · Total
    required

    Total number of Question-Answer hits.

  • 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.