Documentation: Search Insights Widget: Search Response String

• Type: Technical Documentation
• Status: Closed
• Priority: Minor
• Resolution: Completed
• Affects Version/s: None
• Fix Version/s: 7.2.X
• Component/s: Web Search > Search Widgets
• Labels: None
• Sprint: Search | S02 Sprint 7, Search | S02 Sprint 8, Search | S02 Sprint 9, Search | S02 Sprint 10, Search | S02 Sprint 11, Search | S02 Sprint 12, Search | S02 Sprint 13, Search | S02 Sprint 14
• Type of Documentation: User

User Documentation:

Document what the feature does, and some expected use cases.
Leverages Elasticsearch's Explain API.
Returns the relevance score details for each document returned by the search engine.
[From Parent Story Ticket]
_When widget is present, contributes an extra input attribute to current search context.

Elasticsearch index searcher will notice the extra input attribute and contribute an extra output attribute: the `SearchResponse` `toString`.

Widget will display the new response string in a second region under the classic query string._
To discover what this response String means, read the Elasticsearch docs: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-explain.html

Like the Other output from the Insights widget (7.1 docs link), this is useful for testing and development scenarios where the administrator wants to understand what information is in the returned documents and how it's relevance score was calculated.

Document any behavior that deviates from expected.

Document how to use the feature.
Drop the Insights widget onto any page containing a Search Results widget.
Make sure the Explain configuration is selected (it is by default)
Enter keywords into the Search Bar and submit the search.
Characteristic Resulting Output: https://gist.github.com/rbohl/f01b7e00294e2545233894f0afc7d95c