Overview

What is it?

• The 'Thumbs Up/Thumbs Down' icons are available after each response given in the 'Seek' tab of NeuralSeek's UI. These responses indicate a score of 5 for Thumbs Up and 0 for Thumbs Down. These icons are available to be shown and utilized in-line with the conversation.

Why is it important?

• The Thumbs Up/Thumbs Down icons within NeuralSeek are useful for clients to be able to provide feedback to answers generated by NeuralSeek based on queries relevant to their connect corporate content. Being able to implement these icons into a virtual agent is important for clients who want to provide their users with a way to provide relevant, trackable feedback that does not affect answer generation directly.

How does it work?

• After a query is submitted in NeuralSeek's 'Seek' tab, users can simply click either the 'Thumbs Up' icon or the 'Thumbs Down' icon based on their impression of the generated response. The response is then tracked and recorded within the relevant intent on NeuralSeek's 'Curate' tab. Users are able to implement the icons into a virtual agent by using the uniquely generated SVG URL provided after each response. See below for information on using 'iframe' response type to integrate these feedback icons within the IBM virtual agent watsonx Assistant.

Integrating Thumbs with watsonx Assistant

Users are able to easily integrate the 'Thumbs Up/Thumbs Down' feedback icons as an 'iframe' response type within watsonx Assistant. The content, embeddable as an HTML iframe element, allows users to interact with NeuralSeek's rating endpoint seamlessly without leaving the chat by displaying the thumbs icons directly in the conversation.

To include the 'Thumbs Up/Thumbs Down' icons within watsonx:

1. Navigate to the watsonx Assistant instance, and open an Action.
2. In the 'Assistant says' field within the relevant conversation step, click the 'iframe' icon.
3. Set the 'Source URL' to the NeuralSeek step response 'body.thumbs'
   • Optionally, users can include a query parameter for background-color to the thumbs url given: ?style=background-color%3A%23f4f4f4
4. Optionally, add a descriptive title in the 'Title' field.
5. Toggle the 'Display iframe inline' button to 'On' to display the thumbs icons inline with the conversation.
6. Set the 'iframe height' to 45 for proper viewing.
7. Click 'Apply' to save response type.

Viewing Ratings in NeuralSeek

Feedback from utilizing the 'Thumbs Up/Thumbs Down' icons in NeuralSeek's 'Seek' tab can be viewed from the 'Curate' tab.

1. Navigate to the 'Curate' tab within NeuralSeek's interface.
2. Expand desired intents by clicking the down-caret.

1. Optionally, Select desired intents by checking the box.
2. Click the blue 'Download to CSV' button.
3. A CSV file will be downloaded to the user's local machine. There, they can view the rating given from the 'Thumbs Up/Thumbs Down' icons in the 'Response' column.
   • Note: A score of 5 is given for a 'Thumbs Up'. A score of 0 is given for a 'Thumbs Down'. The score shown is an average of all ratings.

Integrating Custom Ratings via API

Users are able to further customize ratings within NeuralSeek using the /rate API.

POSTs to the /seek endpoint return a parameter answerID. You may pass this answer ID to the /rate endpoint with a number 0-5 to manually 'rate' a given answer.

To try it out:

1. Navigate to the 'Integrate' tab within NeuralSeek's interface.
2. Select 'API' from the side menu.
3. Click the 'Authorize' button, and enter the given API key on the screen.
4. Select the 'Seek' drop down option and post a query to /seek.
5. Pull the answerID return parameter from this seek query. E.g. 76574849
6. Select the 'Rate' drop down option to see options of the /rate endpoint. For example POST data:

{ 
    "answerID: "76574849"
    "score": "5"
}