Overview

There are two ways to implement Smart Response. The first is with Rapid UI which also includes features such as Smart Search, Recommendations and Landing Pages. This provides basic features and layouts out of the box. The second is through the Smart Response API which provides more flexibility but requires additional programming to implement.

Rapid UI

The Rapid UI Framework provides a fast way to embed HawkSearch functionality such as:

• Search bar with Autocomplete and Instant Engage
• Search results
• Recommendations
• Landing Pages

The framework is built using custom Web Components (A set of JavaScript APIs that allow you to define custom elements and their behavior) and handlebars.js (a JavaScript templating language to generate HTML or other text formats). More details can be found here: https://developerdocs.hawksearch.com/docs/rapid-ui-overview

API

Overview

If you would prefer not to use Rapid UI and you would like to program the interaction with HawkSearch’s Smart Response API, then you can use these instructions for guidance. In addition to using the response from HawkSearch to render the search results on the page, you will send the relevant fields to the Smart Response endpoint for analysis. The response that comes back will be added to a new component you will place on the search results page (most likely below the search bar).

API Example

URL: https://genai.bridgeline.com/api/smartresponse

Method: POST

Content-Type: application/json

Request Body

All fields are mandatory.

{  
  "clientGuid": "string",  
  "agentId": "string",  
  "query": "string"  
}