QAResponseBody
- answersType: array object[] · Answersrequired
The Question-Answer results.
- answerType: object · Answerrequired
The answer paragraph (i.e. a
<p>node) whose text content can answer users' question. - productType: string · Product Id
_id max length:512requiredThe unique identifier of the product whose content contains the answer.
- answerType: object · Answer Block
_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.
- spellcheckType: object · Spellcheckrequired
Spellcheck results. You can use the information in this object to prompt users with the correct spelling.
- autoType: boolean · Auto Spelling Correction
_spelling _correction requiredWhether Miso has automatically corrected the misspelled search query. When this field is
true, the search result is based on the corrected spelling in thecorrected_queryfield instead of users' original search query. - correctedType: string · Corrected Query
_query requiredThe corrected spelling suggested by Miso. If no spelling error is detected, this will be the same as
original_query - correctedType: string · Corrected Query With Markups
_query _with _markups requiredThe corrected spelling suggested by Miso where the revised tokens are surrounded by the tags.
- originalType: string · Original Query
_query requiredOriginal query string
- originalType: string · Original Query With Markups
_query _with _markups requiredOriginal query with the spelling errors (if any) surrounded by the tags
- spellingType: boolean · Spelling Errors
_errors requiredWhether Miso detects any spelling errors.
- totalType: integer · Totalrequired
Total number of Question-Answer hits.
- misoType: string · Miso IdFormat: uuid
_id 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_idto 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 associatedmiso_idto the next page view, and associate themiso_idwith 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"} - tookType: integer · Took
Number of milliseconds Miso took to retrieve the results.
