User Behavior Insights
Introduced 2.15
References UBI Specification 1.0.0
User Behavior Insights (UBI) is a schema for capturing user search behavior. Search behavior consists of the queries that the user submits, the results that are presented to them, and the actions they take on those results. The UBI schema links all user interactions (events) to the search result they were performed on. That is, it not only captures the chronological sequence of events but also captures the causal links between events. Analysis of this behavior is used for improving the quality of search results.
Client applications such as web pages or apps capture user behavior and send UBI data to a UBI endpoint. For web pages, this is typically handled by JavaScript code.
In principle, queries sent to the server and results returned by the server can be sent to the UBI endpoint from the client. But as an optimization, they can instead be sent directly to the UBI endpoint from the server, without incurring a round-trip to the client. That is the function of the UBI plugin and is not a requirement to adopt UBI.
UBI includes the following elements:
- A machine-readable schema that faciliates interoperablity of the UBI specification.
- A client-side JavaScript example reference implementation that shows how to capture events and send them to the OpenSearch UBI plugin.
- An OpenSearch plugin that captures server-side behavior.
The UBI documentation is organized into two categories: Explanation and reference and Tutorials and how-to guides:
Explanation and reference
| Link | Description |
|---|---|
| UBI Request/Response Specification | The industry-standard schema for UBI requests and responses. The current version references UBI Specification 1.0.0. |
| UBI index schema | Documentation on the individual OpenSearch query and event stores. |
Tutorials and how-to guides
| Link | Description |
|---|---|
| UBI plugin | How to install and use the UBI plugin. |
| UBI client data structures | Sample JavaScript structures for populating the event store. |
| Example UBI query DSL queries | How to write queries for UBI data in OpenSearch query DSL. |
| Example UBI SQL queries | How to write analytic queries for UBI data in SQL. |
| UBI dashboard tutorial | How to build a dashboard containing UBI data. |
| Chorus Opensearch Edition katas | A series of structured tutorials that teach you how to use UBI with OpenSearch through a demo e-commerce store. |
The documentation categories were adapted using concepts based on Diátaxis.